Returns a list of links available for a given link provider.
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| CRContentAPI | SRContentAPI | GET, POST | Server. |
Given a provider_id, this method returns a list of links supplied by that provider to content within the Luminate Online system. Use listLinkProviders to return the list of valid provider_id values.
The for_email parameter limits the list of links returned to those that are suitable for embedding in the body of outgoing email messages.
Client API callers must be logged in and must be administrator users with appropriate Content Authoring rights. Server API callers must have "Content - All Authoring/Use Luminate Online Content API" permission.
See topic Common Parameters.
Required. The ID of the provider of links.
Type xsd:integer.
Optional. Indicates whether to clear cached results from prior invocations. For better performance when paging through large result sets, results are kept in memory while paging. Use this parameter if you need the cache to be reset.
Type xsd:boolean.
Default is false.
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.
Optional. Whether the list should be sorted in ascending order.
Type xsd:boolean.
Default is true.
Optional. The text that will be used to filter results.
Type xsd:string.
Optional. The requested page number (used with "list_page_size"). The first page (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
Type xsd:integer.
Optional. The number of results in each page (used with "list_record_offset" or "list_page_offset").
Type xsd:integer.
Default is 25.
Optional. The requested initial record number (used with "list_page_size"). The first record (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
Type xsd:integer.
Optional. The column to sort with (used with "list_ascending").
Type xsd:string.
See topic Common Parameters.
Required. The ID of the provider of links.
Type xsd:integer.
Optional. Indicates whether to clear cached results from prior invocations. For better performance when paging through large result sets, results are kept in memory while paging. Use this parameter if you need the cache to be reset.
Type xsd:boolean.
Default is false.
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.
Optional. Whether the list should be sorted in ascending order.
Type xsd:boolean.
Default is true.
Optional. The text that will be used to filter results.
Type xsd:string.
Optional. The requested page number (used with "list_page_size"). The first page (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
Type xsd:integer.
Optional. The number of results in each page (used with "list_record_offset" or "list_page_offset").
Type xsd:integer.
Default is 25.
Optional. The requested initial record number (used with "list_page_size"). The first record (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
Type xsd:integer.
Optional. The column to sort with (used with "list_ascending").
Type xsd:string.
See topic HTTP Status Codes.
XML response
<?xml version="1.0" encoding="UTF-8"?>
<listLinksResponse 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">
<pagingMetadata>
<currentSize>2</currentSize>
<isFinalSize>true</isFinalSize>
</pagingMetadata>
<linkableObject>
<id>12</id>
<displayName>Link Alpha</displayName>
<editName>Edit Link Alpha</editName>
<description>Link Alpha Description</description>
<url>http://example.com/InsertExample?opt1=alpah&opt2=2</url>
<optionsAllowed>true</optionsAllowed>
<autoLoginAllowed>true</autoLoginAllowed>
<pageList>
<page>
<label>Page 1</label>
<url>http://example.com/InsertExample?opt1=alpah&opt2=2&page=p1</url>
<linkParameter>
<label>Optional parameter for page 1 for this target.</label>
<name>page_option1</name>
<choice>
<value>thing1</value>
<label>First value</label>
</choice>
<choice>
<value>thing2</value>
<label>Second value</label>
</choice>
</linkParameter>
<linkParameter>
<label>Another parameter for page 1 for this target.</label>
<name>page_option2</name>
<choice>
<value>item1</value>
<label>Some value</label>
</choice>
<choice>
<value>item2</value>
<label>Another value</label>
</choice>
</linkParameter>
</page>
</pageList>
<linkParameter>
<label>Optional parameter for all pages for this target.</label>
<name>option1</name>
<choice>
<value>value1</value>
<label>Value 1</label>
</choice>
<choice>
<value>value2</value>
<label>Value 2</label>
</choice>
</linkParameter>
</linkableObject>
<linkableObject>
<id>14</id>
<displayName>Link Bravo</displayName>
<editName>Edit Link Bravo</editName>
<description>Link Bravo Description. Bravo has no options.</description>
<url>http://example.com/InsertExample?opt1=bravo&opt2=2</url>
<optionsAllowed>false</optionsAllowed>
<autoLoginAllowed>true</autoLoginAllowed>
</linkableObject>
</listLinksResponse>
JSON response
{"listLinksResponse":{"linkableObject":[{"optionsAllowed":"true","id":"12","pageList":{"page":{"linkParameter":[{"choice":[{"value":"thing1","label":"First value"},{"value":"thing2","label":"Second value"}],"name":"page_option1","label":"Optional parameter for page 1 for this target."},{"choice":[{"value":"item1","label":"Some value"},{"value":"item2","label":"Another value"}],"name":"page_option2","label":"Another parameter for page 1 for this target."}],"label":"Page 1","url":"http://example.com/InsertExample?opt1=alpah&opt2=2&page=p1"}},"autoLoginAllowed":"true","editName":"Edit Link Alpha","linkParameter":{"choice":[{"value":"value1","label":"Value 1"},{"value":"value2","label":"Value 2"}],"name":"option1","label":"Optional parameter for all pages for this target."},"description":"Link Alpha Description","displayName":"Link Alpha","url":"http://example.com/InsertExample?opt1=alpah&opt2=2"},{"optionsAllowed":"false","id":"14","autoLoginAllowed":"true","editName":"Edit Link Bravo","description":"Link Bravo Description. Bravo has no options.","displayName":"Link Bravo","url":"http://example.com/InsertExample?opt1=bravo&opt2=2"}],"pagingMetadata":{"isFinalSize":"true","currentSize":"2"}}}