Active Calendar

Event Publisher API V2 - Registrant

RSS

Registrant

The Registrant entity allows for the return of a list of persons who have registered for a single event, add a registrant to an event, and update a previously added registrant.

Please note: API V2 will only return or post data for a single calendar site, meaning the token used in the API request must be associated with the same calendar site of the data you are requesting.



Filtering

To generate a request for registrants for an event, you must include one of the following parameters in the the request.


  • Registrant ID
  • Email
  • Event ID
  • Event Route

formatting your request

The registrant API uses the following URL format.


	http://api.activecalendar.com/v2/registrant/search?token=&secret=

Any filters applied to the request must be included in your request body




Your request method

The registrant API uses the following request methods:


	To retrieve a registrant: POST

	To add a registrant: POST

	To update a registrant: PUT

Registrant ID

Allows to filter the list of returned registrants by their registration ID. The registrant ID is automatically assigned to the registrant by Event Publisher at the time of the registration.

  • Parameter Type: Optional
  • Type: String
  • Format: ""

Sample JSON Filter
{"registrant_id":"b157d365-4e1f-4439-b4c6-839117f21a02"}

Sample XML Filter
<RegistrantFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveData.Calendar.API.Models.v2">
  <registrant_id>b157d365-4e1f-4439-b4c6-839117f21a02</registrant_id>
</RegistrantFilter>

Email

Allows to filter the list of returned registrants by their email address provided at the time of registration.

  • Parameter Type: Optional
  • Type: String
  • Format: ""

Sample JSON Filter
{"email":"b157d365-4e1f-4439-b4c6-839117f21a02"}
Sample XML Filter
<RegistrantFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveData.Calendar.API.Models.v2">
  <email>info@activedatax.com</email>
</RegistrantFilter>

Event ID

Allows to filter the list of returned registrants by the ID of the event.

  • Parameter Type: Optional
  • Type: String
  • Format: ""

Sample JSON Filter
{"event_id":"b157d365-4e1f-4439-b4c6-839117f21a02"}
Sample XML Filter
<RegistrantFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveData.Calendar.API.Models.v2">
  <event_id>b157d365-4e1f-4439-b4c6-839117f21a02</event_id>
</RegistrantFilter>

Event Route

Allows to filter the list of returned registrants by the route (name-occurence number) of the event.

  • Parameter Type: Optional
  • Type: String
  • Format: ""

Sample JSON Filter
{"event_route":"b157d365-4e1f-4439-b4c6-839117f21a02"}
Sample XML Filter
<RegistrantFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveData.Calendar.API.Models.v2">
  <event_route>fun-with-layouts</event_route>
</RegistrantFilter>

Sample JSON filter

When using multiple filters format your filters as follows


{"registrant_id":"","email":"","event_id":"","event_route":""}

Sample XML filter

When using multiple filters format your filters as follows


<RegistrantFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveData.Calendar.API.Models.v2">
  <email></email>
  <event_id></event_id>
  <event_route></event_route>
  <registrant_id></registrant_id>
</RegistrantFilter>

Output Samples

If a successful response is recieved from the api request the information will be returned using the following structure.

JSON

  "response": "Success",
  "message": "",
  "data": [
    {
      "id": "46621cf2-26d2-4ad6-9c35-9c5607f2595a",
      "registration_id": "ea1f1f87-df17-4d4c-a02a-d8389240352c",
      "event_id": "aa9e702e-c4aa-4cee-ac85-d805b8854ab7",
      "cost": 0.0,
      "quantity": 1,
      "timestamp": "2016-08-05T13:54:59",
      "answers": [
        [
          {
            "id": "28ee6b02-e09f-4356-b386-fa28cc1f34e1",
            "identity": "firstname",
            "key": "First Name",
            "value": [
              "Greg"
            ],
            "type": "Text",
            "custom": false
          },
          {
            "id": "7975d215-2ed3-4d66-bdbf-a72fe61c634a",
            "identity": "lastname",
            "key": "Last Name",
            "value": [
              "Oppenheimer"
            ],
            "type": "Text",
            "custom": false
          },
          {
            "id": "05d5c733-ffaa-429f-86ba-1f1b1af3a527",
            "identity": "emailaddress",
            "key": "Email Address",
            "value": [
              "info@activedatax.com"
            ],
            "type": "Text",
            "custom": false
          },
          {
            "id": "76fa9536-0e77-44b2-abf7-09fcd3d546a7",
            "identity": "address",
            "key": "Address",
            "value": [
              "190 Brodhead Rd."
            ],
            "type": "Text",
            "custom": false
          },
          {
            "id": "c75f5e61-1a28-441b-b8fb-e8404b8594ea",
            "identity": "city",
            "key": "City",
            "value": [
              "Bethlehem"
            ],
            "type": "Text",
            "custom": false
          },
          {
            "id": "b7d1fc1a-f5a5-4f03-9fcc-21cdc53038e8",
            "identity": "state",
            "key": "State",
            "value": [
              "Pennsylvania"
            ],
            "type": "Text",
            "custom": false
          },
          {
            "id": "0dd530cb-7249-40dd-b79f-bfd1dfca3b0e",
            "identity": "zipcode",
            "key": "Zipcode",
            "value": [
              "18017"
            ],
            "type": "Text",
            "custom": false
          },
          {
            "id": "be94a9bd-31ec-450f-b217-11ece1237f2f",
            "identity": "phone",
            "key": "Phone",
            "value": [
              "6109978100"
            ],
            "type": "Text",
            "custom": false
          },
          {
            "id": "fdd02d6b-6005-4b74-8eca-9e61bb31e75e",
            "identity": "fdd02d6b60054b748eca9e61bb31e75e",
            "key": "Years of Service",
            "value": [
              "5-10 Years"
            ],
            "type": "MultipleChoice",
            "custom": true
          }
        ]
      ]
    },
]

XML

<RegistrantResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveData.Calendar.API.Models.v2">
  <data>
    <Registrant>
      <answers>
        <ArrayOfAnswer>
          <Answer>
            <custom>false</custom>
            <id>28ee6b02-e09f-4356-b386-fa28cc1f34e1</id>
            <identity>firstname</identity>
            <key>First Name</key>
            <type>Text</type>
            <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>Greg</d7p1:string>
            </value>
          </Answer>
          <Answer>
            <custom>false</custom>
            <id>7975d215-2ed3-4d66-bdbf-a72fe61c634a</id>
            <identity>lastname</identity>
            <key>Last Name</key>
            <type>Text</type>
            <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>Oppenheimer</d7p1:string>
            </value>
          </Answer>
          <Answer>
            <custom>false</custom>
            <id>05d5c733-ffaa-429f-86ba-1f1b1af3a527</id>
            <identity>emailaddress</identity>
            <key>Email Address</key>
            <type>Text</type>
            <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>Gopppenheimer@activedatax.com</d7p1:string>
            </value>
          </Answer>
          <Answer>
            <custom>false</custom>
            <id>76fa9536-0e77-44b2-abf7-09fcd3d546a7</id>
            <identity>address</identity>
            <key>Address</key>
            <type>Text</type>
            <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>190 Brodhead Rd.</d7p1:string>
            </value>
          </Answer>
          <Answer>
            <custom>false</custom>
            <id>c75f5e61-1a28-441b-b8fb-e8404b8594ea</id>
            <identity>city</identity>
            <key>City</key>
            <type>Text</type>
            <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>Bethlehem</d7p1:string>
            </value>
          </Answer>
          <Answer>
            <custom>false</custom>
            <id>b7d1fc1a-f5a5-4f03-9fcc-21cdc53038e8</id>
            <identity>state</identity>
            <key>State</key>
            <type>Text</type>
            <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>Pennsylvania</d7p1:string>
            </value>
          </Answer>
          <Answer>
            <custom>false</custom>
            <id>0dd530cb-7249-40dd-b79f-bfd1dfca3b0e</id>
            <identity>zipcode</identity>
            <key>Zipcode</key>
            <type>Text</type>
            <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>18018</d7p1:string>
            </value>
          </Answer>
          <Answer>
            <custom>false</custom>
            <id>be94a9bd-31ec-450f-b217-11ece1237f2f</id>
            <identity>phone</identity>
            <key>Phone</key>
            <type>Text</type>
            <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>6109978100</d7p1:string>
            </value>
          </Answer>
          <Answer>
            <custom>true</custom>
            <id>fdd02d6b-6005-4b74-8eca-9e61bb31e75e</id>
            <identity>fdd02d6b60054b748eca9e61bb31e75e</identity>
            <key>Years of Service</key>
            <type>MultipleChoice</type>
            <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>5-10 Years</d7p1:string>
            </value>
          </Answer>
        </ArrayOfAnswer>
      </answers>
      <cost>0.00</cost>
      <event_id>aa9e702e-c4aa-4cee-ac85-d805b8854ab7</event_id>
      <id>46621cf2-26d2-4ad6-9c35-9c5607f2595a</id>
      <quantity>1</quantity>
      <registration_id>ea1f1f87-df17-4d4c-a02a-d8389240352c</registration_id>
      <timestamp>2016-08-05T13:54:59</timestamp>
    </Registrant>
  </data>
  <message>1 results returned.</message>
  <response>Success</response>
</RegistrantResponse>

Add a Registrant

The Registrant API can be used to add registrations to events from an external system using the registrant API.



You can post a registrant using JSON or XML



formatting the request

A filter is not required for posting a registrant. All of the information related to the event, registration item, and registrant must be includes in the request body.


http://api.activecalendar.com/v2/registrant/?token=&secret=

Post Data Fields

When posting a registrant the following Sample post data example's below contain a number of field. The contenxt of the fields have been outlined below:

  • ID: Leave this field blank, as it represents the registrant ID that will be programatically assigned to the registrant.
  • Registration ID: The numeric ID that represents the Registration or Product to be used for this registration. Pleae note this is the product or registration ID being used, not the ID of the registrant.
  • Event ID: The GUID for the event that the registrant is being added to.
  • Cost: The cost of the registration item, please note only a value of 0 is supported.
  • Quantity: The number of the registration item that will be associated with the registrant.
  • Timestamp: The time of the registration, leave this value blank as it is automatically populated by the application when the registrant is sucessfully posted.
  • Answers: The set of questions and responses required to be collected and associated to the registrant. For example, first name, last name, and email address.
    • ID: The numeric ID of the question that needs an answer (response) provided for the registrant.
    • Identity: The text friendly ID of the question that needs an answer (response) provided for the registrant.
    • Key: The text displayed to the administrator when viewing the registrant from within Event Publisher.
    • Value: The answer or response for this question.
    • Type:Represents the type of question, text, single choice, multiple choice.
    • Custom: True of False, indicates if the question is a custom (user supplied question) represents true. System supplied equals false.

Sample JSON post data

 [
	{
		"id":"",
		"registration_id":"ea1f1f87-df17-4d4c-a02a-d8389240352c",
		"event_id":"aa9e702e-c4aa-4cee-ac85-d805b8854ab7",
		"cost":0,
		"quantity":1,
		"timestamp":"",
		"answers":
			[
				[
					{
						"id":"28ee6b02-e09f-4356-b386-fa28cc1f34e1",
						"identity":"firstname",
						"key":"First Name",
						"value":["Jim"],
						"type":"Text",
						"custom":false
					},
					{
						"id":"7975d215-2ed3-4d66-bdbf-a72fe61c634a",
						"identity":"lastname",
						"key":"Last Name",
						"value":["Hess"],
						"type":"Text",
						"custom":false
					},
					{
						"id":"05d5c733-ffaa-429f-86ba-1f1b1af3a527",
						"identity":"emailaddress",
						"key":"Email Address",
						"value":["info@activedatax.com"],
						"type":"Text","custom":false
					},
					{
						"id":"76fa9536-0e77-44b2-abf7-09fcd3d546a7",
						"identity":"address",
						"key":"Address",
						"value":["190 Brodhead Rd."],
						"type":"Text",
						"custom":false
					},
					{
						"id":"c75f5e61-1a28-441b-b8fb-e8404b8594ea",
						"identity":"city",
						"key":"City",
						"value":["Bethlehem"],
						"type":"Text",
						"custom":false
					},
					{
						"id":"b7d1fc1a-f5a5-4f03-9fcc-21cdc53038e8",
						"identity":"state",
						"key":"State",
						"value":["Pennsylvania"],
						"type":"Text",
						"custom":false
					},
					{
						"id":"0dd530cb-7249-40dd-b79f-bfd1dfca3b0e",
						"identity":"zipcode",
						"key":"Zipcode",
						"value":["18018"],
						"type":"Text",
						"custom":false
					},
					{
						"id":"be94a9bd-31ec-450f-b217-11ece1237f2f",
						"identity":"phone",
						"key":"Phone",
						"value":["6109978100"],
						"type":"Text",
						"custom":false
					},
					{
						"id":"fdd02d6b-6005-4b74-8eca-9e61bb31e75e",
						"identity":"fdd02d6b60054b748eca9e61bb31e75e",
						"key":"Years of Service",
						"value":["5-10 Years"],
						"type":"MultipleChoice",
						"custom":true
					}
				]
			]
		}
	]

Sample XML Post Data

<ArrayOfRegistrant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveData.Calendar.API.Models.v2">
  <Registrant>
    <answers>
      <ArrayOfAnswer>
        <Answer>
          <custom>false</custom>
          <id>28ee6b02-e09f-4356-b386-fa28cc1f34e1</id>
          <identity>firstname</identity>
          <key>First Name</key>
          <type>Text</type>
          <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d7p1:string>Jim</d7p1:string>
          </value>
        </Answer>
        <Answer>
          <custom>false</custom>
          <id>7975d215-2ed3-4d66-bdbf-a72fe61c634a</id>
          <identity>lastname</identity>
          <key>Last Name</key>
          <type>Text</type>
          <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d7p1:string>Hess</d7p1:string>
          </value>
        </Answer>
        <Answer>
          <custom>false</custom>
          <id>05d5c733-ffaa-429f-86ba-1f1b1af3a527</id>
          <identity>emailaddress</identity>
          <key>Email Address</key>
          <type>Text</type>
          <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d7p1:string>info@activedatax.com</d7p1:string>
          </value>
        </Answer>
        <Answer>
          <custom>false</custom>
          <id>76fa9536-0e77-44b2-abf7-09fcd3d546a7</id>
          <identity>address</identity>
          <key>Address</key>
          <type>Text</type>
          <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d7p1:string>190 Brodhead Rd.</d7p1:string>
          </value>
        </Answer>
        <Answer>
          <custom>false</custom>
          <id>c75f5e61-1a28-441b-b8fb-e8404b8594ea</id>
          <identity>city</identity>
          <key>City</key>
          <type>Text</type>
          <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d7p1:string>Bethlehem</d7p1:string>
          </value>
        </Answer>
        <Answer>
          <custom>false</custom>
          <id>b7d1fc1a-f5a5-4f03-9fcc-21cdc53038e8</id>
          <identity>state</identity>
          <key>State</key>
          <type>Text</type>
          <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d7p1:string>Pennsylvania</d7p1:string>
          </value>
        </Answer>
        <Answer>
          <custom>false</custom>
          <id>0dd530cb-7249-40dd-b79f-bfd1dfca3b0e</id>
          <identity>zipcode</identity>
          <key>Zipcode</key>
          <type>Text</type>
          <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d7p1:string>18018</d7p1:string>
          </value>
        </Answer>
        <Answer>
          <custom>false</custom>
          <id>be94a9bd-31ec-450f-b217-11ece1237f2f</id>
          <identity>phone</identity>
          <key>Phone</key>
          <type>Text</type>
          <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d7p1:string>6109978100</d7p1:string>
          </value>
        </Answer>
        <Answer>
          <custom>true</custom>
          <id>fdd02d6b-6005-4b74-8eca-9e61bb31e75e</id>
          <identity>fdd02d6b60054b748eca9e61bb31e75e</identity>
          <key>Years of Service</key>
          <type>MultipleChoice</type>
          <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d7p1:string>5-10 Years</d7p1:string>
          </value>
        </Answer>
      </ArrayOfAnswer>
    </answers>
    <cost>0.00</cost>
    <event_id>aa9e702e-c4aa-4cee-ac85-d805b8854ab7</event_id>
    <quantity>1</quantity>
    <registration_id>ea1f1f87-df17-4d4c-a02a-d8389240352c</registration_id>
    <timestamp></timestamp>
    <id></id>
  </Registrant>
</ArrayOfRegistrant>

Update a Registrant

The Registrant API can be used to update registrations to events from an external system using the registrant API. You can update both registrations that were added via the API and registrations that were added via the Event Publisher Application directly.



Please note, this will update only the registrant data, not the purchaser data associated to the order. The purchaser information, which is distinct from the registrant can not be updated via the API.

You can update a registrant using JSON or XML



Formatting the request

A filter is not required for updating a registrant. However, the registratnt ID will be used to update the record. You must ensure that the registrant ID is correct, or the wrong registration record will be updated. All of the information related to the event, registration item, and registrant must be included in the request body.


http://api.activecalendar.com/v2/registrant/?token=&secret=
  • Request Method: PUT
  • Request Data: Registrant Object

Post Data Fields

When posting a registrant the following Sample post data example's below contain a number of fields. The contenxt of the fields have been outlined below:

  • ID: The ID for the registrant that you wish to update. It represents the registrant ID that has been programatically assigned to the registrant.
  • Registration ID: The numeric ID that represents the Registration or Product to be used for this registration. Pleae note this is the product or registration ID being used, not the ID of the registrant.
  • Event ID: The GUID for the event that the registrant is being added to.
  • Cost: The cost of the registration item, please note only a value of 0 is supported.
  • Quantity: The number of the registration item that will be associated with the registrant.
  • Timestamp: The time of the registration, leave this value blank as it is automatically populated by the application when the registrant is sucessfully posted.
  • Answers: The set of questions and responses required to be collected and associated to the registrant. For example, first name, last name, and email address.
    • ID: The numeric ID of the question that needs an answer (response) provided for the registrant.
    • Identity: The text friendly ID of the question that needs an answer (response) provided for the registrant.
    • Key: The text displayed to the administrator when viewing the registrant from within Event Publisher.
    • Value: The answer or response for this question.
    • Type:Represents the type of question, text, single choice, multiple choice.
    • Custom: True of False, indicates if the question is a custom (user supplied question) represents true. System supplied equals false.

Sample JSON request

[
	{
		"id":"",
		"registration_id":"ea1f1f87-df17-4d4c-a02a-d8389240352c",
		"event_id":"aa9e702e-c4aa-4cee-ac85-d805b8854ab7",
		"cost":0,
		"quantity":1,
		"timestamp":"",
		"answers":
			[
				[
					{
						"id":"28ee6b02-e09f-4356-b386-fa28cc1f34e1",
						"identity":"firstname",
						"key":"First Name",
						"value":"Jim",
						"type":"Text",
						"custom":false
					},
					{
						"id":"7975d215-2ed3-4d66-bdbf-a72fe61c634a",
						"identity":"lastname",
						"key":"Last Name",
						"value":"Hess",
						"type":"Text",
						"custom":false
					},
					{
						"id":"05d5c733-ffaa-429f-86ba-1f1b1af3a527",
						"identity":"emailaddress",
						"key":"Email Address",
						"value":,
						"type":"Text","custom":false
					},
					{
						"id":"76fa9536-0e77-44b2-abf7-09fcd3d546a7",
						"identity":"address",
						"key":"Address",
						"value":"190 Brodhead Rd.",
						"type":"Text",
						"custom":false
					},
					{
						"id":"c75f5e61-1a28-441b-b8fb-e8404b8594ea",
						"identity":"city",
						"key":"City",
						"value":"Bethlehem",
						"type":"Text",
						"custom":false
					},
					{
						"id":"b7d1fc1a-f5a5-4f03-9fcc-21cdc53038e8",
						"identity":"state",
						"key":"State",
						"value":"Pennsylvania",
						"type":"Text",
						"custom":false
					},
					{
						"id":"0dd530cb-7249-40dd-b79f-bfd1dfca3b0e",
						"identity":"zipcode",
						"key":"Zipcode",
						"value":"18018",
						"type":"Text",
						"custom":false
					},
					{
						"id":"be94a9bd-31ec-450f-b217-11ece1237f2f",
						"identity":"phone",
						"key":"Phone",
						"value":"6109978100",
						"type":"Text",
						"custom":false
					},
					{
						"id":"fdd02d6b-6005-4b74-8eca-9e61bb31e75e",
						"identity":"fdd02d6b60054b748eca9e61bb31e75e",
						"key":"Years of Service",
						"value":"5-10 Years",
						"type":"MultipleChoice",
						"custom":true
					}
				]
			]

Sample XML request

<ArrayOfRegistrant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveData.Calendar.API.Models.v2">
  <Registrant>
    <answers>
      <ArrayOfAnswer>
        <Answer>
          <custom>false</custom>
          <id>28ee6b02-e09f-4356-b386-fa28cc1f34e1</id>
          <identity>firstname</identity>
          <key>First Name</key>
          <type>Text</type>
          <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d7p1:string>Jim</d7p1:string>
          </value>
        </Answer>
        <Answer>
          <custom>false</custom>
          <id>7975d215-2ed3-4d66-bdbf-a72fe61c634a</id>
          <identity>lastname</identity>
          <key>Last Name</key>
          <type>Text</type>
          <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d7p1:string>Hess</d7p1:string>
          </value>
        </Answer>
        <Answer>
          <custom>false</custom>
          <id>05d5c733-ffaa-429f-86ba-1f1b1af3a527</id>
          <identity>emailaddress</identity>
          <key>Email Address</key>
          <type>Text</type>
          <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d7p1:string>info@activedatax.com</d7p1:string>
          </value>
        </Answer>
        <Answer>
          <custom>false</custom>
          <id>76fa9536-0e77-44b2-abf7-09fcd3d546a7</id>
          <identity>address</identity>
          <key>Address</key>
          <type>Text</type>
          <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d7p1:string>190 Brodhead Rd.</d7p1:string>
          </value>
        </Answer>
        <Answer>
          <custom>false</custom>
          <id>c75f5e61-1a28-441b-b8fb-e8404b8594ea</id>
          <identity>city</identity>
          <key>City</key>
          <type>Text</type>
          <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d7p1:string>Bethlehem</d7p1:string>
          </value>
        </Answer>
        <Answer>
          <custom>false</custom>
          <id>b7d1fc1a-f5a5-4f03-9fcc-21cdc53038e8</id>
          <identity>state</identity>
          <key>State</key>
          <type>Text</type>
          <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d7p1:string>Pennsylvania</d7p1:string>
          </value>
        </Answer>
        <Answer>
          <custom>false</custom>
          <id>0dd530cb-7249-40dd-b79f-bfd1dfca3b0e</id>
          <identity>zipcode</identity>
          <key>Zipcode</key>
          <type>Text</type>
          <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d7p1:string>18018</d7p1:string>
          </value>
        </Answer>
        <Answer>
          <custom>false</custom>
          <id>be94a9bd-31ec-450f-b217-11ece1237f2f</id>
          <identity>phone</identity>
          <key>Phone</key>
          <type>Text</type>
          <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d7p1:string>6109978100</d7p1:string>
          </value>
        </Answer>
        <Answer>
          <custom>true</custom>
          <id>fdd02d6b-6005-4b74-8eca-9e61bb31e75e</id>
          <identity>fdd02d6b60054b748eca9e61bb31e75e</identity>
          <key>Years of Service</key>
          <type>MultipleChoice</type>
          <value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d7p1:string>5-10 Years</d7p1:string>
          </value>
        </Answer>
      </ArrayOfAnswer>
    </answers>
    <cost>0.00</cost>
    <event_id>aa9e702e-c4aa-4cee-ac85-d805b8854ab7</event_id>
    <quantity>1</quantity>
    <registration_id>ea1f1f87-df17-4d4c-a02a-d8389240352c</registration_id>
    <timestamp></timestamp>
    <id></id>
  </Registrant>
</ArrayOfRegistrant>

Cancel a Registrant

The Registrant API can be used to cancel registrations to events from an external system. You can cancel both registrations that were added via the API and registrations that were added via the Active Calendar Application directly.

Please Note: The cancelation functionality only supports canceling a single registrant ID per request. Meaning, to cancel 4 registrations for a single order, you must create 4 requests.

You can update a registrant using JSON or XML



Formatting the request

A filter is required for cancelling a registrant. The filter to be used should be the registratnt ID as it will be used to cancel the record. You must ensure that the registrant ID is correct, or the wrong registration record will be canceled. All of the information related to the event, registration item, and registrant must be included in the request body.


http://api.activecalendar.com/v2/registrant/cancel?token=&secret=
  • Request Method: PUT
  • Request Data: RegistrantFilter

Sample JSON RegistrantFilter

{"registrant_id":"070188A7-C29C-4C19-AD6F-9B839BA97D2B"}

Sample JSON response

{
  "response": "Success",
  "message": "Registrant Canceled!",
  "data": [
    {
      "id": "46b45c89-01d6-4a37-8cf1-a44741199f9d",
      "registration_id": "00000000-0000-0000-0000-000000000000",
      "event_id": "00000000-0000-0000-0000-000000000000",
      "cost": 0.0,
      "quantity": 0,
      "timestamp": "1/31/2017 10:06:47 PM",
      "answers": []
    }
  ]
}

Sample XML Registrant Filter

<RegistrantFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveData.Calendar.API.Models.v2">
  <registrant_id>b157d365-4e1f-4439-b4c6-839117f21a02</registrant_id>
</RegistrantFilter>

Sample XML response

<registrantresponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveData.Calendar.API.Models.v2">
  <data>
    <registrant>
      <answers>
      <cost>0.0</cost>
      <event_id>00000000-0000-0000-0000-000000000000</event_id>
      <id>4d3bb7e7-8bb6-48ae-b93d-7d2657d1d811</id>
      <quantity>0</quantity>
      <registration_id>00000000-0000-0000-0000-000000000000</registration_id>
      <timestamp>1/31/2017 10:08:58 PM</timestamp>
    </answers></registrant>
  </data>
  <message>Registrant Canceled!</message>
  <response>Success</response>
</registrantresponse>