Usage Notes

Retrieves a list of xrefs, optionally filtered by xref_id, type_id, or convio_value.

This method may also be called without parameters to retrieve all xrefs. When providing xref_id, type_id and convio_value will be ignored.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

convio_value

Optional. COM object key

Type xsd:string.

list_page_offset

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.

list_page_size

Optional. The number of results in each page (used with "list_record_offset" or "list_page_offset").

Type xsd:integer.

Default is 25.

list_record_offset

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.

type_id

Optional. XRef type ID

Type xsd:int.

xref_id

Optional. XRef ID

Type xsd:int.

Response

See topic HTTP Status Codes.

<?xml version="1.0" encoding="UTF-8"?>
<listXrefsResponse 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">
  <xref>
    <id>100</id>
    <xrefTypeId>400</xrefTypeId>
    <convioValue>com_object_key1</convioValue>
    <description>Sample XRef description</description>
    <securityCategoryId>1</securityCategoryId>
    <approvalStatus>submitted</approvalStatus>
    <createdBy>1010</createdBy>
    <createdOn>2016-02-01-06:00</createdOn>
    <lastChangeOn>2016-02-01-06:00</lastChangeOn>
    <foreignValue>
      <number>0</number>
      <value>foreign_key_1</value>
    </foreignValue>
    <foreignValue>
      <number>1</number>
      <value>foreign_key_2</value>
    </foreignValue>
  </xref>
  <xref>
    <id>101</id>
    <xrefTypeId>402</xrefTypeId>
    <convioValue>com_object_key2</convioValue>
    <description>Sample XRef description</description>
    <securityCategoryId>1</securityCategoryId>
    <approvalStatus>approved</approvalStatus>
    <createdBy>1011</createdBy>
    <createdOn>2016-02-01-06:00</createdOn>
    <lastChangeOn>2016-02-01-06:00</lastChangeOn>
    <foreignValue>
      <number>0</number>
      <value>foreign_key_3</value>
    </foreignValue>
    <foreignValue>
      <number>1</number>
      <value>foreign_key_4</value>
    </foreignValue>
  </xref>
</listXrefsResponse>

        

{"listXrefsResponse":{"xref":[{"createdOn":"2016-02-01-06:00","id":"100","convioValue":"com_object_key1","foreignValue":[{"value":"foreign_key_1","number":"0"},{"value":"foreign_key_2","number":"1"}],"createdBy":"1010","xrefTypeId":"400","description":"Sample XRef description","approvalStatus":"submitted","lastChangeOn":"2016-02-01-06:00","securityCategoryId":"1"},{"createdOn":"2016-02-01-06:00","id":"101","convioValue":"com_object_key2","foreignValue":[{"value":"foreign_key_3","number":"0"},{"value":"foreign_key_4","number":"1"}],"createdBy":"1011","xrefTypeId":"402","description":"Sample XRef description","approvalStatus":"approved","lastChangeOn":"2016-02-01-06:00","securityCategoryId":"1"}]}}