Get name/value pairs of foreign objects valid for a field in an XRef type.
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| CRDataSyncAPI | SRDataSyncAPI | GET, POST | Yes. |
Given a type_id and field_number, returns a list of foreign objects which apply to that xref type and field. Objects are formatted with display names and internal values, which should be used when creating an xref with the addXref method.
See topic Common Parameters.
Required. Field Number
Type xsd:int.
Required. XRef type ID
Type xsd:int.
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. Field Number
Type xsd:int.
Required. XRef type ID
Type xsd:int.
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"?>
<listForeignObjectsForXrefFieldResponse 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">
<totalNumberResults>2</totalNumberResults>
<foreignObject>
<name>Foreign Object 1</name>
<value>foreign_value_1</value>
</foreignObject>
<foreignObject>
<name>Foreign Object 2</name>
<value>foreign_value_2</value>
</foreignObject>
</listForeignObjectsForXrefFieldResponse>
JSON response
{"listForeignObjectsForXrefFieldResponse":{"foreignObject":[{"name":"Foreign Object 1","value":"foreign_value_1"},{"name":"Foreign Object 2","value":"foreign_value_2"}],"totalNumberResults":"2"}}