Registrations
A registration record holds the following information:
- region_id
- booking_contact_id
- number
- currency
- created_on
- created_by
- non_discounted_price
- total
- id
- last_activity_by
- instructions_sent
- custom_discount_rate
- comments
- invoice_paid
- credit_note
- deleted
- invoice_issued
- last_activity_on
- order_date
- account
- notes
- credit
- website_order_id
Getting Registrations
GET (/api/v2/event/registrations/:id()
statuscode 200
no error
statuscode 404
does not exist
Using Curl:
curl https://YOUR-SUBDOMAIN.administrateapp.com/api/v2/event/registrations/4 -k -u (login):(password)Using PHP:
<?php
$credentials = '(username):(password)';
$url = 'https://YOUR-SUBDOMAIN.administrateapp.com/api/v2/event/registrations/4';
$options = array(
'http' => array(
'method' => 'GET',
'header'=> "Accept: application/json\r\n" .
"Authorization: Basic " . base64_encode($credentials)
)
);
$context = stream_context_create($options);
$result = file_get_contents($url, false, $context);
echo $result;Using Python:
import json
import requests
response = requests.get('http://YOUR-SUBDOMAIN.administrateapp.com/api/v2/event/registrations/4',
auth=('<username>', '<password>'))
print response.jsonExample response:
{
"region_id": null,
"booking_contact_id": null,
"number": "6",
"currency": null,
"created_on": null,
"created_by": null,
"non_discounted_price": null,
"total": null,
"id": 4,
"last_activity_by": null,
"instructions_sent": false,
"custom_discount_rate": 0.0,
"comments": "This is a neat registration",
"invoice_paid": false,
"credit_note": false,
"deleted": false,
"invoice_issued": false,
"last_activity_on": null,
"order_date": "2016-12-02",
"account": {
"shipping_address_locality": null,
"import_id": null,
"primary_contact_id": null,
"tel": null,
"address_unit": null,
"default_approver": 0,
"company_number": null,
"no_publicity": null,
"url": null,
"shipping_address_street": null,
"vat_number": null,
"address_postcode": null,
"billing_address_country_id": null,
"address_country": null,
"id": 1,
"shipping_address_postcode": null,
"industries": [],
"address_street": null,
"source": null,
"address_region": null,
"is_employee": false,
"default_price_level_id": null,
"is_individual": false,
"is_supplier": false,
"parent_id": null,
"source_details": null,
"notes": null,
"billing_contact_person": null,
"billing_address_locality": null,
"is_partner": false,
"email": null,
"billing_address_region": null,
"fax": null,
"account_type": null,
"description": null,
"tags": null,
"company": {
"registration_numbers": null,
"code": "ACM",
"name": "Acme Corporation",
"settings": {
"time_format": "H:i",
"date_format": "Y-m-d",
"locale": "en_GB",
"week_starts": null,
"non_working_days": null
},
"bank_details": null,
"currency": {
"html_code": null,
"symbol": "\u00a3",
"code": "GBP",
"name": "British Pound Sterling",
"is_base": true
},
"id": 1,
"currency_code": "GBP",
"account_id": null
},
"billing_address_unit": null,
"partner_type": null,
"default_price_level": null,
"address_town": null,
"billing_address_postcode": null,
"shipping_address_town": null,
"billing_address_street": null,
"shipping_address_region": null,
"shipping_address_country_id": null,
"is_deleted": false,
"name": "Acme Corporation",
"customer_since": null,
"mobile": null,
"shipping_contact_person": null,
"created": "2016-12-02T14:24:46",
"shipping_address_unit": null,
"is_customer": false,
"address_locality": null,
"initial_contact_id": null,
"external_id": null,
"bank_details": null,
"billing_address_town": null
},
"notes": null,
"credit": null,
"website_order_id": null
}Getting more than one Registration
GET (/api/v2/event/registrations()
statuscode 200
no error
statuscode 404
does not exist
Using Curl:
curl https://YOUR-SUBDOMAIN.administrateapp.com/api/v2/event/registrations -k -u (login):(password)Using PHP:
<?php
$credentials = '(username):(password)';
$url = 'https://YOUR-SUBDOMAIN.administrateapp.com/api/v2/event/registrations';
$options = array(
'http' => array(
'method' => 'GET',
'header'=> "Accept: application/json\r\n" .
"Authorization: Basic " . base64_encode($credentials)
)
);
$context = stream_context_create($options);
$result = file_get_contents($url, false, $context);
echo $result;Using Python:
import json
import requests
response = requests.get('http://YOUR-SUBDOMAIN.administrateapp.com/api/v2/event/registrations',
auth=('<username>', '<password>'))
print response.jsonExample response:
[
{
"region_id": null,
"booking_contact_id": null,
"number": "4",
"currency": null,
"created_on": null,
"created_by": null,
"non_discounted_price": null,
"total": null,
"id": 2,
"last_activity_by": null,
"instructions_sent": false,
"custom_discount_rate": 0.0,
"comments": "This is a neat registration",
"invoice_paid": false,
"credit_note": false,
"deleted": false,
"invoice_issued": false,
"last_activity_on": null,
"order_date": "2016-12-02",
"account": {
"shipping_address_locality": null,
"import_id": null,
"primary_contact_id": null,
"tel": null,
"address_unit": null,
"default_approver": 0,
"company_number": null,
"no_publicity": null,
"url": null,
"shipping_address_street": null,
"vat_number": null,
"address_postcode": null,
"billing_address_country_id": null,
"address_country": null,
"id": 1,
"shipping_address_postcode": null,
"industries": [],
"address_street": null,
"source": null,
"address_region": null,
"is_employee": false,
"default_price_level_id": null,
"is_individual": false,
"is_supplier": false,
"parent_id": null,
"source_details": null,
"notes": null,
"billing_contact_person": null,
"billing_address_locality": null,
"is_partner": false,
"email": null,
"billing_address_region": null,
"fax": null,
"account_type": null,
"description": null,
"tags": null,
"company": {
"registration_numbers": null,
"code": "ACM",
"name": "Acme Corporation",
"settings": {
"time_format": "H:i",
"date_format": "Y-m-d",
"locale": "en_GB",
"week_starts": null,
"non_working_days": null
},
"bank_details": null,
"currency": {
"html_code": null,
"symbol": "\u00a3",
"code": "GBP",
"name": "British Pound Sterling",
"is_base": true
},
"id": 1,
"currency_code": "GBP",
"account_id": null
},
"billing_address_unit": null,
"partner_type": null,
"default_price_level": null,
"address_town": null,
"billing_address_postcode": null,
"shipping_address_town": null,
"billing_address_street": null,
"shipping_address_region": null,
"shipping_address_country_id": null,
"is_deleted": false,
"name": "Acme Corporation",
"customer_since": null,
"mobile": null,
"shipping_contact_person": null,
"created": "2016-12-02T14:24:46",
"shipping_address_unit": null,
"is_customer": false,
"address_locality": null,
"initial_contact_id": null,
"external_id": null,
"bank_details": null,
"billing_address_town": null
},
"notes": null,
"credit": null,
"website_order_id": null
},
{
"region_id": null,
"booking_contact_id": null,
"number": "5",
"currency": {
"html_code": null,
"symbol": "\u00a3",
"code": "GBP",
"name": "British Pound Sterling",
"is_base": true
},
"created_on": null,
"created_by": null,
"non_discounted_price": null,
"total": null,
"id": 3,
"last_activity_by": null,
"instructions_sent": false,
"custom_discount_rate": 0.0,
"comments": null,
"invoice_paid": false,
"credit_note": false,
"deleted": false,
"invoice_issued": false,
"last_activity_on": null,
"order_date": "2016-12-02",
"account": {
"shipping_address_locality": null,
"import_id": null,
"primary_contact_id": null,
"tel": null,
"address_unit": null,
"default_approver": 0,
"company_number": null,
"no_publicity": null,
"url": null,
"shipping_address_street": null,
"vat_number": null,
"address_postcode": null,
"billing_address_country_id": null,
"address_country": null,
"id": 1,
"shipping_address_postcode": null,
"industries": [],
"address_street": null,
"source": null,
"address_region": null,
"is_employee": false,
"default_price_level_id": null,
"is_individual": false,
"is_supplier": false,
"parent_id": null,
"source_details": null,
"notes": null,
"billing_contact_person": null,
"billing_address_locality": null,
"is_partner": false,
"email": null,
"billing_address_region": null,
"fax": null,
"account_type": null,
"description": null,
"tags": null,
"company": {
"registration_numbers": null,
"code": "ACM",
"name": "Acme Corporation",
"settings": {
"time_format": "H:i",
"date_format": "Y-m-d",
"locale": "en_GB",
"week_starts": null,
"non_working_days": null
},
"bank_details": null,
"currency": {
"html_code": null,
"symbol": "\u00a3",
"code": "GBP",
"name": "British Pound Sterling",
"is_base": true
},
"id": 1,
"currency_code": "GBP",
"account_id": null
},
"billing_address_unit": null,
"partner_type": null,
"default_price_level": null,
"address_town": null,
"billing_address_postcode": null,
"shipping_address_town": null,
"billing_address_street": null,
"shipping_address_region": null,
"shipping_address_country_id": null,
"is_deleted": false,
"name": "Acme Corporation",
"customer_since": null,
"mobile": null,
"shipping_contact_person": null,
"created": "2016-12-02T14:24:46",
"shipping_address_unit": null,
"is_customer": false,
"address_locality": null,
"initial_contact_id": null,
"external_id": null,
"bank_details": null,
"billing_address_town": null
},
"notes": null,
"credit": null,
"website_order_id": null
}
]Filtering
The results for a list of registrations can be filtered. See Filtering