| GET | /api/licensee/contacts |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Returns a list of contacts a licensee is linked to. Contacts are returned in batches.
*/
@Api(Description="Returns a list of contacts a licensee is linked to. Contacts are returned in batches.")
open class GetLicenseeContactList
{
/**
* Number of contacts to retrieve per call.
*/
@ApiMember(DataType="int", Description="Number of contacts to retrieve per call.", IsRequired=true, Name="BatchSize")
open var BatchSize:Int? = null
/**
* Call number (1=1st, 2=2nd) this should progress upwards until all contacts have been retrieved.
*/
@ApiMember(DataType="int", Description="Call number (1=1st, 2=2nd) this should progress upwards until all contacts have been retrieved.", IsRequired=true, Name="BatchNumber")
open var BatchNumber:Int? = null
}
@ApiResponse(Description="List of Contacts")
open class GetLicenseeContactListResponse
{
/**
* List of contacts.
*/
@ApiMember(DataType="List<ConnectedContactModel>", Description="List of contacts.", Name="Contacts")
open var Contacts:ArrayList<ConnectedContactModel>? = null
/**
* Details of the api response. Success/Fail.
*/
@ApiMember(DataType="ResponseStatus", Description="Details of the api response. Success/Fail.", Name="ResponseStatus")
open var ResponseStatus:ResponseStatus? = null
}
open class ConnectedContactModel
{
/**
* Guid of the contact object within Eros.
*/
@ApiMember(DataType="Guid", Description="Guid of the contact object within Eros.", Name="ContactId")
open var ContactId:UUID? = null
/**
* The salutation(preferred name) for the contact. Applies to a person contact type.
*/
@ApiMember(DataType="string", Description="The salutation(preferred name) for the contact. Applies to a person contact type.", Name="Salutation")
open var Salutation:String? = null
/**
* The title for the contact. Applies to a person contact type.
*/
@ApiMember(DataType="string", Description="The title for the contact. Applies to a person contact type.", Name="Title")
open var Title:String? = null
/**
* The first given name for the contact. Applies to a person contact type.
*/
@ApiMember(DataType="string", Description="The first given name for the contact. Applies to a person contact type.", Name="FirstName")
open var FirstName:String? = null
/**
* Any middle names for the contact. Applies to a person contact type.
*/
@ApiMember(DataType="string", Description="Any middle names for the contact. Applies to a person contact type.", Name="MiddleName")
open var MiddleName:String? = null
/**
* The surname for the contact. Applies to a person contact type.
*/
@ApiMember(DataType="string", Description="The surname for the contact. Applies to a person contact type.", Name="Surname")
open var Surname:String? = null
/**
* The full name for the contact.
*/
@ApiMember(DataType="string", Description="The full name for the contact.", Name="FullName")
open var FullName:String? = null
/**
* A legal name for the contact. Applies to an organisation contact type.
*/
@ApiMember(DataType="string", Description="A legal name for the contact. Applies to an organisation contact type.", Name="LegalName")
open var LegalName:String? = null
/**
* A trading name for the contact. Applies to an organisation contact type.
*/
@ApiMember(DataType="string", Description="A trading name for the contact. Applies to an organisation contact type.", Name="TradingName")
open var TradingName:String? = null
/**
* The birth date for the contact. Applies to a person contact type.
*/
@ApiMember(DataType="DateTime?", Description="The birth date for the contact. Applies to a person contact type.", Name="BirthDate")
open var BirthDate:Date? = null
/**
* Guid of the marital status within Eros.
*/
@ApiMember(DataType="Guid?", Description="Guid of the marital status within Eros.", Name="MaritalStatusId")
open var MaritalStatusId:UUID? = null
/**
* The contacts marital status if set.
*/
@ApiMember(DataType="string", Description="The contacts marital status if set.", Name="MaritalStatusName")
open var MaritalStatusName:String? = null
/**
* Guid of the gender within Eros.
*/
@ApiMember(DataType="Guid?", Description="Guid of the gender within Eros.", Name="GenderId")
open var GenderId:UUID? = null
/**
* The contacts gender if set.
*/
@ApiMember(DataType="string", Description="The contacts gender if set.", Name="GenderName")
open var GenderName:String? = null
/**
* Preferred language of the contact.
*/
@ApiMember(DataType="string", Description="Preferred language of the contact.", Name="Language")
open var Language:String? = null
/**
* If true, the contact requires an interpreter.
*/
@ApiMember(DataType="bool", Description="If true, the contact requires an interpreter.", Name="InterpreterRequired")
open var InterpreterRequired:Boolean? = null
/**
* Contact Type name of the contact.
*/
@ApiMember(DataType="string", Description="Contact Type name of the contact.", Name="ContactTypeName")
open var ContactTypeName:String? = null
/**
* Guid of the Contact Type List Item object within Eros.
*/
@ApiMember(DataType="Guid", Description="Guid of the Contact Type List Item object within Eros.", Name="ContactTypeId")
open var ContactTypeId:UUID? = null
/**
* Description of the contact for their external profile.
*/
@ApiMember(DataType="string", Description="Description of the contact for their external profile.", Name="Description")
open var Description:String? = null
/**
* Contact 'Profession/Trade/Industry' details for their external profile.
*/
@ApiMember(DataType="string", Description="Contact 'Profession/Trade/Industry' details for their external profile.", Name="EmploymentIndustry")
open var EmploymentIndustry:String? = null
/**
* Contact 'Working/Subcontracting for' details for their external profile.
*/
@ApiMember(DataType="string", Description="Contact 'Working/Subcontracting for' details for their external profile.", Name="EmploymentRole")
open var EmploymentRole:String? = null
/**
* Contact 'Work Area/Suburbs' detail for their external profile.
*/
@ApiMember(DataType="string", Description="Contact 'Work Area/Suburbs' detail for their external profile.", Name="EmploymentGeographicArea")
open var EmploymentGeographicArea:String? = null
/**
* The A.B.N for the contact.
*/
@ApiMember(DataType="string", Description="The A.B.N for the contact.", Name="Abn")
open var Abn:String? = null
/**
* The A.C.N for the contact.
*/
@ApiMember(DataType="string", Description="The A.C.N for the contact.", Name="Acn")
open var Acn:String? = null
/**
* The A.R.B.N for the contact.
*/
@ApiMember(DataType="string", Description="The A.R.B.N for the contact.", Name="Arbn")
open var Arbn:String? = null
/**
* Timezone name that applies to the contact.
*/
@ApiMember(DataType="string", Description="Timezone name that applies to the contact.", Name="TimezoneName")
open var TimezoneName:String? = null
/**
* A list of the contact details for the contact.
*/
@ApiMember(DataType="List<ConnectedContactDetailModel>", Description="A list of the contact details for the contact.", Name="ContactDetails")
open var ContactDetails:ArrayList<ConnectedContactDetailModel>? = null
/**
* A list of the contact addresses for the contact
*/
@ApiMember(DataType="List<ConnectedContactAddressModel>", Description="A list of the contact addresses for the contact", Name="ContactAddresses")
open var ContactAddresses:ArrayList<ConnectedContactAddressModel>? = null
/**
* 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.
*/
@ApiMember(DataType="bool", Description="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.", Name="IsContactConnected")
open var IsContactConnected:Boolean? = null
/**
* A list of connections this contact has with the licensee. May be active or a pending request to connect.
*/
@ApiMember(DataType="List<ConnectedContactConnectionsModel>", Description="A list of connections this contact has with the licensee. May be active or a pending request to connect.", Name="Connections")
open var Connections:ArrayList<ConnectedContactConnectionsModel>? = null
/**
* A list of projects this contact is linked to as a customer.
*/
@ApiMember(DataType="List<ContactLinkedCustomerProjectsModel>", Description="A list of projects this contact is linked to as a customer.", Name="Projects")
open var Projects:ArrayList<ContactLinkedCustomerProjectsModel>? = null
/**
* A list of integration subscriptions used to link this contact to external records in other licensee owned systems.
*/
@ApiMember(DataType="List<ConnectedContactSubscriptionsModel>", Description="A list of integration subscriptions used to link this contact to external records in other licensee owned systems.", Name="Subscriptions")
open var Subscriptions:ArrayList<ConnectedContactSubscriptionsModel>? = null
}
open class ConnectedContactDetailModel
{
/**
* The type of contact detail this is (email/mobile/fax/website etc)
*/
@ApiMember(DataType="string", Description="The type of contact detail this is (email/mobile/fax/website etc)", Name="Type")
open var Type:String? = null
/**
* The contact detail. e.g (phone number or email address)
*/
@ApiMember(DataType="string", Description="The contact detail. e.g (phone number or email address)", Name="ContactDetails")
open var ContactDetails:String? = null
}
open class ConnectedContactAddressModel
{
/**
* A full address string of the address.
*/
@ApiMember(DataType="string", Description="A full address string of the address.", Name="FullAddress")
open var FullAddress:String? = null
/**
* If true, this is the contacts primary address.
*/
@ApiMember(DataType="bool", Description="If true, this is the contacts primary address.", Name="IsPrimary")
open var IsPrimary:Boolean? = null
/**
* If true, this is the contacts postal address.
*/
@ApiMember(DataType="bool", Description="If true, this is the contacts postal address.", Name="IsPostal")
open var IsPostal:Boolean? = null
/**
* If true, this is the contacts registered address.
*/
@ApiMember(DataType="bool", Description="If true, this is the contacts registered address.", Name="IsRegistered")
open var IsRegistered:Boolean? = null
}
open class ConnectedContactConnectionsModel
{
/**
* Guid of the role within Eros
*/
@ApiMember(DataType="Guid", Description="Guid of the role within Eros", Name="RoleId")
open var RoleId:UUID? = null
/**
* Name of the role this contact is connected to the licensee with.
*/
@ApiMember(DataType="string", Description="Name of the role this contact is connected to the licensee with.", Name="Role")
open var Role:String? = null
/**
* Guid of the role connections status within Eros.
*/
@ApiMember(DataType="Guid", Description="Guid of the role connections status within Eros.", Name="StatusId")
open var StatusId:UUID? = null
/**
* Connection status of the role. It maybe active or pending.
*/
@ApiMember(DataType="string", Description="Connection status of the role. It maybe active or pending.", Name="Status")
open var Status:String? = null
}
open class ContactLinkedCustomerProjectsModel
{
/**
* Guid of the project within Eros.
*/
@ApiMember(DataType="Guid", Description="Guid of the project within Eros.", Name="ProjectId")
open var ProjectId:UUID? = null
/**
* Name of the project.
*/
@ApiMember(DataType="string", Description="Name of the project.", Name="Name")
open var Name:String? = null
}
open class ConnectedContactSubscriptionsModel
{
/**
* Guid of the datasource within Eros.
*/
@ApiMember(DataType="Guid", Description="Guid of the datasource within Eros.", Name="DatasourceId")
open var DatasourceId:UUID? = null
/**
* Name of the datasource that is the external system with a record of this contact.
*/
@ApiMember(DataType="string", Description="Name of the datasource that is the external system with a record of this contact.", Name="Datasource")
open var Datasource:String? = null
/**
* Foreign Key lookup of this contact in the external system the datasource represents.
*/
@ApiMember(DataType="string", Description="Foreign Key lookup of this contact in the external system the datasource represents.", Name="AlternateKey")
open var AlternateKey:String? = null
}
Kotlin GetLicenseeContactList DTOs
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
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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Contacts":[{"Salutation":"String","Title":"String","FirstName":"String","MiddleName":"String","Surname":"String","FullName":"String","LegalName":"String","TradingName":"String","BirthDate":"0001-01-01T00:00:00.0000000","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"}}}