Platform Subscription API

GetContacts

Returns a list of contacts with specified roles. There are options to include custom and also to include each contacts connected contacts

**GetContacts** Parameters:
Name	Parameter	Data Type	Required	Description
SuiteDataSourceInstanceId	body	Guid	Yes	Guid representing the external system datasource requesting the contact information. This is required to return any existing object subscription details for each contact.
ContactRoles	body	List<Guid>	Yes	A list of 1 or more roles that a contact must have in order to be returned. (Roles are treated as OR not AND, ie a contact may have one or the other to be returned, but not necessarily both)
ContactTypes	body	List<Guid>	No	A list of contact types that we want returned. If no contact types are specified all 4 major contact types are eligible to be returned. (organisation/person - real/virtual)
IncludeStaff	body	bool	Yes	Set to true if you want to include the any linked staff for each contact.
CustomContentViewId	body	Guid	No	To include custom content then you need to specify the view Id of the content to include.
ModifiedSince	body	DateTime	No	Set the date to return only contacts that have been modified since a particular date.

**GetContactsModel** Parameters:
Name	Parameter	Data Type	Required	Description
Contacts	body	string	No	List of Contacts with details.
ContactStaff	body	string	No	List of contact-staff details.

**SubscriptionContactModel** Parameters:
Name	Parameter	Data Type	Required	Description
ContactId	body	Guid	No	Guid of the contact object within PSTPF.
ContactType	body	Guid	No	Guid of the Contact Type List Item object within PSTPF.
MaritalStatus	body	Guid?	No	Guid of the Marital Status List Item object within PSTPF.
Gender	body	Guid?	No	Guid of the Gender List Item object within PSTPF.
FirstName	body	string	No	The first given name for the contact. Applies to a person contact type.
MiddleName	body	string	No	The middle name(s) for the contact. Applies to a person contact type.
Surname	body	string	No	The surname for the contact. Applies to a person contact type.
FullName	body	string	No	The full name for the contact.
ShortName	body	string	No	A short name for the contact.
BirthDate	body	DateTime?	No	The birth date for the contact. Applies to a person contact type.
Title	body	string	No	The title for the contact. Applies to a person contact type.
Salutation	body	string	No	A salutation for the contact.
Abn	body	string	No	The A.B.N for the contact.
Acn	body	string	No	The A.C.N for the contact.
Arbn	body	string	No	The A.R.B.N for the contact.
TradingName	body	string	No	A trading name for the contact.
LegalName	body	string	No	A legal name for the contact.
Notes	body	string	No	Any notes/description for the contact.
EmploymentIndustry	body	string	No	Contact Employment Industry.
EmploymentRole	body	string	No	Contact Employment Role.
EmploymentGeographicArea	body	string	No	Contact Employment Geographic Area.
DriversLicence	body	string	No	The Contacts Drivers Licence Number
GstRegistered	body	bool	No	Indicates if the Contact is registered for GST
RecordStatus	body	string	No	The status of the contact in PSTPF
ContactRoles	body	List<ContactRole>	No	A list of roles this contact has.
ContactDetails	body	List<ContactDetailModel>	No	A list of the contact details for the contact.
CustomContentXML	body	string	No	Custom Content XML for the contact.
BlobImageURLPrimary	body	string	No	URL to the Primary Image.
BlobImageURLPrimaryThumbnail	body	string	No	URL to the Primary Image thumbnail.
PrimaryMobile	body	string	No	The primary mobile for the contact.
PrimaryEmail	body	string	No	The primary email for the contact.

**ContactRole** Parameters:
Name	Parameter	Data Type	Required	Description
RoleId	body	Guid	No	Guid of the Role List Item object within PSTPF.
AlternateKey	body	string	No	The unique key that represents the role type on the external system.

**ContactDetailModel** Parameters:
Name	Parameter	Data Type	Required	Description
ContactMethodId	body	Guid	No	Id of the Contact Method
ContactMethodName	body	string	No	Contact Method Name
ContactAddress	body	ContactAddressModel	No	If the contact method is an address, this will contain the address details.
ContactPhone	body	PhoneModel	No	If the contact method is a phone, this will contain the phone details
CountryId	body	Guid?	No	Id of the country
ContactDetails	body	string	No	A summary string representing the contact details
Notes	body	string	No	Notes about the contact details
ContactDetailsCode	body	string	No	Area Code if contact details are a phone number
OrderContactMethod	body	int	No	Order number of the contact method
IsPrimaryContactMethod	body	bool	No	True if this is the primary contact method
IsAddress	body	bool	No	True if this contact method is an address

**ContactAddressModel** Parameters:
Name	Parameter	Data Type	Required	Description
Address	body	AddressModel	No	Address Details
IsPostal	body	bool	No	True if this is a postal address.
IsPrimaryLocation	body	bool	No	True if this is the primary address.
IsRegisteredLocation	body	bool	No	True if this address is the registered tax address.
SuburbName	body	string	No	Suburb Name
StateName	body	string	No	State Name
CountryName	body	string	No	Country Name

**AddressModel** Parameters:
Name	Parameter	Data Type	Required	Description
DistanceAway	body	double	No	The distance between this project and another specified set of gps coordinates.
Latitude	body	Double?	No	The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
Longitude	body	Double?	No	The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
AddressFormatId	body	Guid	No	Address Format Id Guid - this will be determined by the service.
SuburbId	body	Guid	No	Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered.
SuburbName	body	string	No	The suburb name.
StateShortName	body	string	No	The shortened State Name e.g Vic for Victoria.
PostCode	body	string	No	The suburb postcode.
CountryId	body	Guid	No	Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.
CountryName	body	string	No	the name of the country the address is within.
ISOCountryCode	query	string	No	ISO Country Code.
LotNumber	body	string	No	The address Lot number.
SubUnit	body	string	No	The address Sub Unit number.
BuildingNumber	body	string	No	The address building number.
StreetNumber	body	string	No	The address street number.
StreetName	body	string	No	The address street name including street type.
AddressLineOne	body	string	No	A formatted address Line 1.
AddressLineTwo	body	string	No	A formatted address Line 2.
AddressFull	body	string	No	The full address string.
IsPhysical	body	bool?	No	True if the address is a physical location.
Notes	form	string	No	Notes about the address.
AutoMapCoordinates	body	bool?	No	If true, the address is eligible for having its coordinates calculated/updated.
LocationCoordinates	body	LocationCoordinates	No	Location Coordinates for the address.

**LocationCoordinatesModel** Parameters:
Name	Parameter	Data Type	Required	Description
Latitude	query	double	No	The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
Longitude	query	double	No	The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
Altitude	query	double?	No	The altitude of an address - the altitude above sea level."
Accuracy	query	double?	No	Accuracy of the latitude and longitude.
AltitudeAccuracy	query	double?	No	Accurancy of the Altitude.
Heading	query	double?	No	Direction you are heading.
Speed	query	double?	No	Speed you are going.
VerticalSpeed	query	double?	No	Speed your altitude is ascending/descending at.

**PhoneModel** Parameters:
Name	Parameter	Data Type	Required	Description
CountryCode	body	string	No	Country Code
AreaCode	body	string	No	Area Code
LocalNumber	body	string	No	Local Number

**ContactsStaff** Parameters:
Name	Parameter	Data Type	Required	Description
ContactId	form	Guid	No
ContactStaffId	form	Guid	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/GetContacts HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ContactRoles":["00000000-0000-0000-0000-000000000000"],"ContactTypes":["00000000-0000-0000-0000-000000000000"],"IncludeStaff":false,"ModifiedSince":"0001-01-01T00:00:00.0000000"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{}