Usage Notes

Adding an xref requires type_id, convio_value, and foreign values as required by the xref type. A description of the xref may optionally be provided. If successful the new xref is returned to the caller.

While the various foreign_value parameters are marked optional, they should be provided as required by the xref type definition. For example if an xref type has 3 fields, foreign_value_1, foreign_value_2, and foreign_value_3 should be defined. If a field is not required by the xref type definition, it may be omitted.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

convio_value

Required. COM object key

Type xsd:string.

type_id

Required. XRef type ID

Type xsd:int.

description

Optional. XRef description

Type xsd:string.

foreign_value_0

Optional. Foreign value

Type xsd:string.

foreign_value_1

Optional. Foreign value

Type xsd:string.

foreign_value_2

Optional. Foreign value

Type xsd:string.

foreign_value_3

Optional. Foreign value

Type xsd:string.

foreign_value_4

Optional. Foreign value

Type xsd:string.

foreign_value_5

Optional. Foreign value

Type xsd:string.

foreign_value_6

Optional. Foreign value

Type xsd:string.

foreign_value_7

Optional. Foreign value

Type xsd:string.

foreign_value_8

Optional. Foreign value

Type xsd:string.

foreign_value_9

Optional. Foreign value

Type xsd:string.

Response

See topic HTTP Status Codes.

<?xml version="1.0" encoding="UTF-8"?>
<addXrefResponse 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>
</addXrefResponse>

        

{"addXrefResponse":{"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"}}}