Due to PCI compliant reasons we're going to turn off support for TLS v1.0 on all of our servers.
Please check/update you API implementations to support TLS v1.2 until 29.06.2018

REST API Addresses

From XING Events Developer Documentation
Jump to: navigation, search

Object type: address

This page contains information about all properties and methods regarding address objects.

NOTE: Address objects occur as nested objects: that's why there is more than one GET-Request (Addresses of Users or Payments for example).

Properties

Attributes: R - accessible in read requests W - accessible in write (update) requests C - accessible in create requests

Property
Type
Attributes
Required
Description
salutation
Integer
RW-
No
The salutation of this person (The values are: 0 = Mr. 1 = Ms. 2 = Mrs.).
title
String
RW-
No
The title of the participant (e.g. Dr., Prof., etc.).
firstName
String
RW-
Yes
The first name.
lastName
String
RW-
Yes
The last name.
email
String
RW-
Yes (payment only)
The email adress.
telephone
String
RW-
No
The telephone number.
company
String
RW-
Yes (onyl if commercial user)
The company.
street
String
RW-
Yes
The street.
street2
String
RW-
No
An additional street field.
zipCode
String
RW-
Yes
The zip code.
city
String
RW-
Yes
The city.
state
State
RW-
No
The state if country is "US".
country
Country
RW-
Yes
The country.
vatId
String
RW-
No
The VAT ID.
noVatReason
String
RWC
No
In case you have no VAT ID (yet) but are a "commercial" event organizer, this field is mandatory. You need to provide why you do not have a VAT number.
referenceNo
String
RW-
No
The reference number that can be provided by the ticket buyer. Will be printed on the invoice.
commercial
Boolean
RW-
No
If set to true the address represents a commercial address and not a private one. This attribute is only used in organizer accounts, not for addresses for ticket buyers.

Methods

Read

Call GET /api/user/<id>/address/billing
Description This request will return the billing address object of the user with the specified internal id. The response contains all properties marked with R. If there hasn't been at least one update request to the billing address object, the error com.amiando.api.rest.ObjectNotFound will be returned.
Call GET /api/payment/<id>/address/buyer
Description This request will return the buyer address object of the payment with the specified internal id. The response contains all properties marked with R. The buyer address is the main payment address associated with the ticket payment. It is required and will be entered by the ticket buyer during the ticket purchase process. It can later be updated by the event administrator.
Call GET /api/payment/<id>/address/shipment
Description This request will return the shipment address object of the payment with the specified internal id. The response contains all properties marked with R. If the ticket buyer wishes that his paper tickets get shipped to a different address than the buyer address, he can enter the shipment address during the ticket purchase process. It is optional and only available if the ticket buyer chooses paper tickets instead of e-tickets. It can later be updated by the event administrator. If the payment has no shipment address, the error com.amiando.api.rest.ObjectNotFound will be returned.
Response {"address":{...}, "success":true}.
Errors See General Errorcodes.

Update

Important information: To use these calls you need to sign a "data processing agreement". Please contact our support or your account manager if you didn't sign this agreement yet. As long as no "data processing agreement" is signed these calls will return the error: com.amiando.api.rest.DataProcessingAgreementMissing

Call POST /api/user/<id>/address/billing
Parameters All properties for a user marked with W.
Description This request will update the properties of the billing address of the user with the internal id <id>. Only properties which are provided as parameters will be updated.
Call POST /api/payment/<id>/address/buyer
Parameters All properties for a payment marked with W.
Description This request will update the properties of the buyer address of the payment with the internal id <id>. Only properties which are provided as parameters will be updated.
Call POST /api/payment/<id>/address/shipment
Parameters All properties for a payment marked with W.
Description This request will update the properties of the shipment address of the payment with the internal id <id>. Only properties which are provided as parameters will be updated.
Response {"success":true}.
Errors See General Errorcodes.
REST API Contents
Getting Started Get your API key Overview Formats Errors
Data Types Event Participant Payment Ticket
Ticket Categories ProductDefinition Products CodeDefinition
TicketShop Addresses Ticket Types Payment Types
BankAccount UserDataDefinition UserData User
Partner ApiKey
Data Synchronization Sync Interface