Usage Notes

Removes an xref given xref_id. The removed xref is returned to the caller.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

xref_id

Required. XRef ID

Type xsd:int.

Response

See topic HTTP Status Codes.

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

        

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