Luminate Online

Client Servlet	Server Servlet	HTTP Methods Supported	Requires Authentication
CRContentAPI	SRContentAPI	GET, POST	Server.

Client API Syntax

https://secure2.convio.net/organization/site/CRContentAPI?method=listLinkProviders &api_key=value &v=value [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value ] [ &for_email=value ]

Server API Syntax

https://secure2.convio.net/organization/site/SRContentAPI?method=listLinkProviders & api_key =value & login_name =value & login_password =value & v =value [ & center_id =value ] [ & response_format =xml |json ] [ & source =value ] [ & sub_source =value ] [ & suppress_response_codes =value ] [ & for_email =value ]

Usage Notes

This method lists Link Providers that aggregate links to different types of content within Luminate Online system. Use this API to select a link provider ID required by the listLinks method.

The for_email parameter limits the list of providers returned to those that are suitable for embedding in the body of outgoing email messages.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

for_email

Optional. Specifies whether the text being edited is intended for display in an email message: "true" or "false". Some types of links are only applicable, or are not applicable, within email messages.

Type xsd:boolean.

Default is true.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

for_email

Optional. Specifies whether the text being edited is intended for display in an email message: "true" or "false". Some types of links are only applicable, or are not applicable, within email messages.

Type xsd:boolean.

Default is true.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<listLinkProvidersResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <provider>
    <label>Link Type A</label>
    <typeId>42</typeId>
  </provider>
  <provider>
    <label>Link Type B</label>
    <typeId>43</typeId>
  </provider>
</listLinkProvidersResponse>

JSON response

{"listLinkProvidersResponse":{"provider":[{"label":"Link Type A","typeId":"42"},{"label":"Link Type B","typeId":"43"}]}}

listLinkProviders