Platform Subscription API

GetLicenseeContactList

Returns a list of contacts a licensee is linked to. Contacts are returned in batches.

The following routes are available for this service:
GET	/api/licensee/contacts

**GetLicenseeContactList** Parameters:
Name	Parameter	Data Type	Required	Description
BatchSize	body	int	Yes	Number of contacts to retrieve per call.
BatchNumber	body	int	Yes	Call number (1=1st, 2=2nd) this should progress upwards until all contacts have been retrieved.
ContactRole	body	Guid	No	An optional role that a contact must have in order to be returned.

**GetLicenseeContactListResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Contacts	body	List<ConnectedContactModel>	No	List of contacts.
ResponseStatus	body	ResponseStatus	No	Details of the api response. Success/Fail.

**ConnectedContactModel** Parameters:
Name	Parameter	Data Type	Required	Description
ContactId	body	Guid	No	Guid of the contact object within Eros.
Salutation	body	string	No	The salutation(preferred name) for the contact. Applies to a person contact type.
Title	body	string	No	The title for the contact. Applies to a person contact type.
FirstName	body	string	No	The first given name for the contact. Applies to a person contact type.
MiddleName	body	string	No	Any middle names 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.
LegalName	body	string	No	A legal name for the contact. Applies to an organisation contact type.
TradingName	body	string	No	A trading name for the contact. Applies to an organisation contact type.
BirthDate	body	DateTime?	No	The birth date for the contact. Applies to a person contact type.
MaritalStatusId	body	Guid?	No	Guid of the marital status within Eros.
MaritalStatusName	body	string	No	The contacts marital status if set.
GenderId	body	Guid?	No	Guid of the gender within Eros.
GenderName	body	string	No	The contacts gender if set.
Language	body	string	No	Preferred language of the contact.
InterpreterRequired	body	bool	No	If true, the contact requires an interpreter.
ContactTypeName	body	string	No	Contact Type name of the contact.
ContactTypeId	body	Guid	No	Guid of the Contact Type List Item object within Eros.
Description	body	string	No	Description of the contact for their external profile.
EmploymentIndustry	body	string	No	Contact 'Profession/Trade/Industry' details for their external profile.
EmploymentRole	body	string	No	Contact 'Working/Subcontracting for' details for their external profile.
EmploymentGeographicArea	body	string	No	Contact 'Work Area/Suburbs' detail for their external profile.
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.
TimezoneName	body	string	No	Timezone name that applies to the contact.
ContactDetails	body	List<ConnectedContactDetailModel>	No	A list of the contact details for the contact.
ContactAddresses	body	List<ConnectedContactAddressModel>	No	A list of the contact addresses for the contact
IsContactConnected	body	bool	No	True if this contact has at least 1 active connection to the licensee. Without an active connection only public profile information for the contact is returned.
Connections	body	List<ConnectedContactConnectionsModel>	No	A list of connections this contact has with the licensee. May be active or a pending request to connect.
Projects	body	List<ContactLinkedCustomerProjectsModel>	No	A list of projects this contact is linked to as a customer.
Subscriptions	body	List<ConnectedContactSubscriptionsModel>	No	A list of integration subscriptions used to link this contact to external records in other licensee owned systems.

**ConnectedContactDetailModel** Parameters:
Name	Parameter	Data Type	Required	Description
Type	body	string	No	The type of contact detail this is (email/mobile/fax/website etc)
ContactDetails	body	string	No	The contact detail. e.g (phone number or email address)

**ConnectedContactAddressModel** Parameters:
Name	Parameter	Data Type	Required	Description
FullAddress	body	string	No	A full address string of the address.
IsPrimary	body	bool	No	If true, this is the contacts primary address.
IsPostal	body	bool	No	If true, this is the contacts postal address.
IsRegistered	body	bool	No	If true, this is the contacts registered address.

**ConnectedContactConnectionsModel** Parameters:
Name	Parameter	Data Type	Required	Description
RoleId	body	Guid	No	Guid of the role within Eros
Role	body	string	No	Name of the role this contact is connected to the licensee with.
StatusId	body	Guid	No	Guid of the role connections status within Eros.
Status	body	string	No	Connection status of the role. It maybe active or pending.

**ContactLinkedCustomerProjectsModel** Parameters:
Name	Parameter	Data Type	Required	Description
ProjectId	body	Guid	No	Guid of the project within Eros.
Name	body	string	No	Name of the project.

**ConnectedContactSubscriptionsModel** Parameters:
Name	Parameter	Data Type	Required	Description
DatasourceId	body	Guid	No	Guid of the datasource within Eros.
Datasource	body	string	No	Name of the datasource that is the external system with a record of this contact.
AlternateKey	body	string	No	Foreign Key lookup of this contact in the external system the datasource represents.

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

HTTP + JSV

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

GET /api/licensee/contacts HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Contacts: 
	[
		{
			Salutation: String,
			Title: String,
			FirstName: String,
			MiddleName: String,
			Surname: String,
			FullName: String,
			LegalName: String,
			TradingName: String,
			BirthDate: 0001-01-01,
			MaritalStatusId: 00000000-0000-0000-0000-000000000000,
			MaritalStatusName: String,
			GenderId: 00000000-0000-0000-0000-000000000000,
			GenderName: String,
			Language: String,
			InterpreterRequired: False,
			ContactTypeName: String,
			Description: String,
			EmploymentIndustry: String,
			EmploymentRole: String,
			EmploymentGeographicArea: String,
			Abn: String,
			Acn: String,
			Arbn: String,
			TimezoneName: String,
			ContactDetails: 
			[
				{
					Type: String,
					ContactDetails: String
				}
			],
			ContactAddresses: 
			[
				{
					FullAddress: String,
					IsPrimary: False,
					IsPostal: False,
					IsRegistered: False
				}
			],
			IsContactConnected: False,
			Connections: 
			[
				{
					Role: String,
					Status: String
				}
			],
			Projects: 
			[
				{
					Name: String
				}
			],
			Subscriptions: 
			[
				{
					Datasource: String,
					AlternateKey: String
				}
			]
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}