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	query	int	Yes	Number of contacts to retrieve per call.
BatchNumber	query	int	Yes	Call number (1=1st, 2=2nd) this should progress upwards until all contacts have been retrieved.

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

**ConnectedContactModel** Parameters:
Name	Parameter	Data Type	Required	Description
ContactId	form	Guid	No	Guid of the contact object within Eros.
Salutation	form	string	No	The salutation(preferred name) for the contact. Applies to a person contact type.
Title	form	string	No	The title for the contact. Applies to a person contact type.
FirstName	form	string	No	The first given name for the contact. Applies to a person contact type.
MiddleName	form	string	No	Any middle names for the contact. Applies to a person contact type.
Surname	form	string	No	The surname for the contact. Applies to a person contact type.
FullName	form	string	No	The full name for the contact.
LegalName	form	string	No	A legal name for the contact. Applies to an organisation contact type.
TradingName	form	string	No	A trading name for the contact. Applies to an organisation contact type.
BirthDate	form	DateTime?	No	The birth date for the contact. Applies to a person contact type.
MaritalStatusId	form	Guid?	No	Guid of the marital status within Eros.
MaritalStatusName	form	string	No	The contacts marital status if set.
GenderId	form	Guid?	No	Guid of the gender within Eros.
GenderName	form	string	No	The contacts gender if set.
Language	form	string	No	Preferred language of the contact.
InterpreterRequired	form	bool	No	If true, the contact requires an interpreter.
ContactTypeName	form	string	No	Contact Type name of the contact.
ContactTypeId	form	Guid	No	Guid of the Contact Type List Item object within Eros.
Description	form	string	No	Description of the contact for their external profile.
EmploymentIndustry	form	string	No	Contact 'Profession/Trade/Industry' details for their external profile.
EmploymentRole	form	string	No	Contact 'Working/Subcontracting for' details for their external profile.
EmploymentGeographicArea	form	string	No	Contact 'Work Area/Suburbs' detail for their external profile.
Abn	form	string	No	The A.B.N for the contact.
Acn	form	string	No	The A.C.N for the contact.
Arbn	form	string	No	The A.R.B.N for the contact.
TimezoneName	form	string	No	Timezone name that applies to the contact.
ContactDetails	form	List<ConnectedContactDetailModel>	No	A list of the contact details for the contact.
ContactAddresses	form	List<ConnectedContactAddressModel>	No	A list of the contact addresses for the contact
IsContactConnected	form	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	form	List<ConnectedContactConnectionsModel>	No	A list of connections this contact has with the licensee. May be active or a pending request to connect.
Projects	form	List<ContactLinkedCustomerProjectsModel>	No	A list of projects this contact is linked to as a customer.
Subscriptions	form	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	form	string	No	The type of contact detail this is (email/mobile/fax/website etc)
ContactDetails	form	string	No	The contact detail. e.g (phone number or email address)

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

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

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

**ConnectedContactSubscriptionsModel** Parameters:
Name	Parameter	Data Type	Required	Description
DatasourceId	form	Guid	No	Guid of the datasource within Eros.
Datasource	form	string	No	Name of the datasource that is the external system with a record of this contact.
AlternateKey	form	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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

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

<GetLicenseeContactListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription">
  <Contacts xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.Models">
    <d2p1:ConnectedContactModel>
      <d2p1:Abn>String</d2p1:Abn>
      <d2p1:Acn>String</d2p1:Acn>
      <d2p1:Arbn>String</d2p1:Arbn>
      <d2p1:BirthDate>0001-01-01T00:00:00</d2p1:BirthDate>
      <d2p1:Connections>
        <d2p1:ConnectedContactConnectionsModel>
          <d2p1:Role>String</d2p1:Role>
          <d2p1:RoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleId>
          <d2p1:Status>String</d2p1:Status>
          <d2p1:StatusId>00000000-0000-0000-0000-000000000000</d2p1:StatusId>
        </d2p1:ConnectedContactConnectionsModel>
      </d2p1:Connections>
      <d2p1:ContactAddresses>
        <d2p1:ConnectedContactAddressModel>
          <d2p1:FullAddress>String</d2p1:FullAddress>
          <d2p1:IsPostal>false</d2p1:IsPostal>
          <d2p1:IsPrimary>false</d2p1:IsPrimary>
          <d2p1:IsRegistered>false</d2p1:IsRegistered>
        </d2p1:ConnectedContactAddressModel>
      </d2p1:ContactAddresses>
      <d2p1:ContactDetails>
        <d2p1:ConnectedContactDetailModel>
          <d2p1:ContactDetails>String</d2p1:ContactDetails>
          <d2p1:Type>String</d2p1:Type>
        </d2p1:ConnectedContactDetailModel>
      </d2p1:ContactDetails>
      <d2p1:ContactId>00000000-0000-0000-0000-000000000000</d2p1:ContactId>
      <d2p1:ContactTypeId>00000000-0000-0000-0000-000000000000</d2p1:ContactTypeId>
      <d2p1:ContactTypeName>String</d2p1:ContactTypeName>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:EmploymentGeographicArea>String</d2p1:EmploymentGeographicArea>
      <d2p1:EmploymentIndustry>String</d2p1:EmploymentIndustry>
      <d2p1:EmploymentRole>String</d2p1:EmploymentRole>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:FullName>String</d2p1:FullName>
      <d2p1:GenderId>00000000-0000-0000-0000-000000000000</d2p1:GenderId>
      <d2p1:GenderName>String</d2p1:GenderName>
      <d2p1:InterpreterRequired>false</d2p1:InterpreterRequired>
      <d2p1:IsContactConnected>false</d2p1:IsContactConnected>
      <d2p1:Language>String</d2p1:Language>
      <d2p1:LegalName>String</d2p1:LegalName>
      <d2p1:MaritalStatusId>00000000-0000-0000-0000-000000000000</d2p1:MaritalStatusId>
      <d2p1:MaritalStatusName>String</d2p1:MaritalStatusName>
      <d2p1:MiddleName>String</d2p1:MiddleName>
      <d2p1:Projects>
        <d2p1:ContactLinkedCustomerProjectsModel>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:ProjectId>00000000-0000-0000-0000-000000000000</d2p1:ProjectId>
        </d2p1:ContactLinkedCustomerProjectsModel>
      </d2p1:Projects>
      <d2p1:Salutation>String</d2p1:Salutation>
      <d2p1:Subscriptions>
        <d2p1:ConnectedContactSubscriptionsModel>
          <d2p1:AlternateKey>String</d2p1:AlternateKey>
          <d2p1:Datasource>String</d2p1:Datasource>
          <d2p1:DatasourceId>00000000-0000-0000-0000-000000000000</d2p1:DatasourceId>
        </d2p1:ConnectedContactSubscriptionsModel>
      </d2p1:Subscriptions>
      <d2p1:Surname>String</d2p1:Surname>
      <d2p1:TimezoneName>String</d2p1:TimezoneName>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:TradingName>String</d2p1:TradingName>
    </d2p1:ConnectedContactModel>
  </Contacts>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetLicenseeContactListResponse>