| GET | /api/licensee/contacts |
|---|
namespace Eros.Subtle.Canvara.WebAPIModel.Models
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ConnectedContactDetailModel() =
///<summary>
///The type of contact detail this is (email/mobile/fax/website etc)
///</summary>
[<ApiMember(DataType="string", Description="The type of contact detail this is (email/mobile/fax/website etc)", Name="Type")>]
member val Type:String = null with get,set
///<summary>
///The contact detail. e.g (phone number or email address)
///</summary>
[<ApiMember(DataType="string", Description="The contact detail. e.g (phone number or email address)", Name="ContactDetails")>]
member val ContactDetails:String = null with get,set
[<AllowNullLiteral>]
type ConnectedContactAddressModel() =
///<summary>
///A full address string of the address.
///</summary>
[<ApiMember(DataType="string", Description="A full address string of the address.", Name="FullAddress")>]
member val FullAddress:String = null with get,set
///<summary>
///If true, this is the contacts primary address.
///</summary>
[<ApiMember(DataType="bool", Description="If true, this is the contacts primary address.", Name="IsPrimary")>]
member val IsPrimary:Boolean = new Boolean() with get,set
///<summary>
///If true, this is the contacts postal address.
///</summary>
[<ApiMember(DataType="bool", Description="If true, this is the contacts postal address.", Name="IsPostal")>]
member val IsPostal:Boolean = new Boolean() with get,set
///<summary>
///If true, this is the contacts registered address.
///</summary>
[<ApiMember(DataType="bool", Description="If true, this is the contacts registered address.", Name="IsRegistered")>]
member val IsRegistered:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type ConnectedContactConnectionsModel() =
///<summary>
///Guid of the role within Eros
///</summary>
[<ApiMember(DataType="Guid", Description="Guid of the role within Eros", Name="RoleId")>]
member val RoleId:Guid = new Guid() with get,set
///<summary>
///Name of the role this contact is connected to the licensee with.
///</summary>
[<ApiMember(DataType="string", Description="Name of the role this contact is connected to the licensee with.", Name="Role")>]
member val Role:String = null with get,set
///<summary>
///Guid of the role connections status within Eros.
///</summary>
[<ApiMember(DataType="Guid", Description="Guid of the role connections status within Eros.", Name="StatusId")>]
member val StatusId:Guid = new Guid() with get,set
///<summary>
///Connection status of the role. It maybe active or pending.
///</summary>
[<ApiMember(DataType="string", Description="Connection status of the role. It maybe active or pending.", Name="Status")>]
member val Status:String = null with get,set
[<AllowNullLiteral>]
type ContactLinkedCustomerProjectsModel() =
///<summary>
///Guid of the project within Eros.
///</summary>
[<ApiMember(DataType="Guid", Description="Guid of the project within Eros.", Name="ProjectId")>]
member val ProjectId:Guid = new Guid() with get,set
///<summary>
///Name of the project.
///</summary>
[<ApiMember(DataType="string", Description="Name of the project.", Name="Name")>]
member val Name:String = null with get,set
[<AllowNullLiteral>]
type ConnectedContactSubscriptionsModel() =
///<summary>
///Guid of the datasource within Eros.
///</summary>
[<ApiMember(DataType="Guid", Description="Guid of the datasource within Eros.", Name="DatasourceId")>]
member val DatasourceId:Guid = new Guid() with get,set
///<summary>
///Name of the datasource that is the external system with a record of this contact.
///</summary>
[<ApiMember(DataType="string", Description="Name of the datasource that is the external system with a record of this contact.", Name="Datasource")>]
member val Datasource:String = null with get,set
///<summary>
///Foreign Key lookup of this contact in the external system the datasource represents.
///</summary>
[<ApiMember(DataType="string", Description="Foreign Key lookup of this contact in the external system the datasource represents.", Name="AlternateKey")>]
member val AlternateKey:String = null with get,set
[<AllowNullLiteral>]
type ConnectedContactModel() =
///<summary>
///Guid of the contact object within Eros.
///</summary>
[<ApiMember(DataType="Guid", Description="Guid of the contact object within Eros.", Name="ContactId")>]
member val ContactId:Guid = new Guid() with get,set
///<summary>
///The salutation(preferred name) for the contact. Applies to a person contact type.
///</summary>
[<ApiMember(DataType="string", Description="The salutation(preferred name) for the contact. Applies to a person contact type.", Name="Salutation")>]
member val Salutation:String = null with get,set
///<summary>
///The title for the contact. Applies to a person contact type.
///</summary>
[<ApiMember(DataType="string", Description="The title for the contact. Applies to a person contact type.", Name="Title")>]
member val Title:String = null with get,set
///<summary>
///The first given name for the contact. Applies to a person contact type.
///</summary>
[<ApiMember(DataType="string", Description="The first given name for the contact. Applies to a person contact type.", Name="FirstName")>]
member val FirstName:String = null with get,set
///<summary>
///Any middle names for the contact. Applies to a person contact type.
///</summary>
[<ApiMember(DataType="string", Description="Any middle names for the contact. Applies to a person contact type.", Name="MiddleName")>]
member val MiddleName:String = null with get,set
///<summary>
///The surname for the contact. Applies to a person contact type.
///</summary>
[<ApiMember(DataType="string", Description="The surname for the contact. Applies to a person contact type.", Name="Surname")>]
member val Surname:String = null with get,set
///<summary>
///The full name for the contact.
///</summary>
[<ApiMember(DataType="string", Description="The full name for the contact.", Name="FullName")>]
member val FullName:String = null with get,set
///<summary>
///A legal name for the contact. Applies to an organisation contact type.
///</summary>
[<ApiMember(DataType="string", Description="A legal name for the contact. Applies to an organisation contact type.", Name="LegalName")>]
member val LegalName:String = null with get,set
///<summary>
///A trading name for the contact. Applies to an organisation contact type.
///</summary>
[<ApiMember(DataType="string", Description="A trading name for the contact. Applies to an organisation contact type.", Name="TradingName")>]
member val TradingName:String = null with get,set
///<summary>
///The birth date for the contact. Applies to a person contact type.
///</summary>
[<ApiMember(DataType="DateTime?", Description="The birth date for the contact. Applies to a person contact type.", Name="BirthDate")>]
member val BirthDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///Guid of the marital status within Eros.
///</summary>
[<ApiMember(DataType="Guid?", Description="Guid of the marital status within Eros.", Name="MaritalStatusId")>]
member val MaritalStatusId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///The contacts marital status if set.
///</summary>
[<ApiMember(DataType="string", Description="The contacts marital status if set.", Name="MaritalStatusName")>]
member val MaritalStatusName:String = null with get,set
///<summary>
///Guid of the gender within Eros.
///</summary>
[<ApiMember(DataType="Guid?", Description="Guid of the gender within Eros.", Name="GenderId")>]
member val GenderId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///The contacts gender if set.
///</summary>
[<ApiMember(DataType="string", Description="The contacts gender if set.", Name="GenderName")>]
member val GenderName:String = null with get,set
///<summary>
///Preferred language of the contact.
///</summary>
[<ApiMember(DataType="string", Description="Preferred language of the contact.", Name="Language")>]
member val Language:String = null with get,set
///<summary>
///If true, the contact requires an interpreter.
///</summary>
[<ApiMember(DataType="bool", Description="If true, the contact requires an interpreter.", Name="InterpreterRequired")>]
member val InterpreterRequired:Boolean = new Boolean() with get,set
///<summary>
///Contact Type name of the contact.
///</summary>
[<ApiMember(DataType="string", Description="Contact Type name of the contact.", Name="ContactTypeName")>]
member val ContactTypeName:String = null with get,set
///<summary>
///Guid of the Contact Type List Item object within Eros.
///</summary>
[<ApiMember(DataType="Guid", Description="Guid of the Contact Type List Item object within Eros.", Name="ContactTypeId")>]
member val ContactTypeId:Guid = new Guid() with get,set
///<summary>
///Description of the contact for their external profile.
///</summary>
[<ApiMember(DataType="string", Description="Description of the contact for their external profile.", Name="Description")>]
member val Description:String = null with get,set
///<summary>
///Contact 'Profession/Trade/Industry' details for their external profile.
///</summary>
[<ApiMember(DataType="string", Description="Contact 'Profession/Trade/Industry' details for their external profile.", Name="EmploymentIndustry")>]
member val EmploymentIndustry:String = null with get,set
///<summary>
///Contact 'Working/Subcontracting for' details for their external profile.
///</summary>
[<ApiMember(DataType="string", Description="Contact 'Working/Subcontracting for' details for their external profile.", Name="EmploymentRole")>]
member val EmploymentRole:String = null with get,set
///<summary>
///Contact 'Work Area/Suburbs' detail for their external profile.
///</summary>
[<ApiMember(DataType="string", Description="Contact 'Work Area/Suburbs' detail for their external profile.", Name="EmploymentGeographicArea")>]
member val EmploymentGeographicArea:String = null with get,set
///<summary>
///The A.B.N for the contact.
///</summary>
[<ApiMember(DataType="string", Description="The A.B.N for the contact.", Name="Abn")>]
member val Abn:String = null with get,set
///<summary>
///The A.C.N for the contact.
///</summary>
[<ApiMember(DataType="string", Description="The A.C.N for the contact.", Name="Acn")>]
member val Acn:String = null with get,set
///<summary>
///The A.R.B.N for the contact.
///</summary>
[<ApiMember(DataType="string", Description="The A.R.B.N for the contact.", Name="Arbn")>]
member val Arbn:String = null with get,set
///<summary>
///Timezone name that applies to the contact.
///</summary>
[<ApiMember(DataType="string", Description="Timezone name that applies to the contact.", Name="TimezoneName")>]
member val TimezoneName:String = null with get,set
///<summary>
///A list of the contact details for the contact.
///</summary>
[<ApiMember(DataType="List<ConnectedContactDetailModel>", Description="A list of the contact details for the contact.", Name="ContactDetails")>]
member val ContactDetails:ResizeArray<ConnectedContactDetailModel> = null with get,set
///<summary>
///A list of the contact addresses for the contact
///</summary>
[<ApiMember(DataType="List<ConnectedContactAddressModel>", Description="A list of the contact addresses for the contact", Name="ContactAddresses")>]
member val ContactAddresses:ResizeArray<ConnectedContactAddressModel> = null with get,set
///<summary>
///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.
///</summary>
[<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")>]
member val IsContactConnected:Boolean = new Boolean() with get,set
///<summary>
///A list of connections this contact has with the licensee. May be active or a pending request to connect.
///</summary>
[<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")>]
member val Connections:ResizeArray<ConnectedContactConnectionsModel> = null with get,set
///<summary>
///A list of projects this contact is linked to as a customer.
///</summary>
[<ApiMember(DataType="List<ContactLinkedCustomerProjectsModel>", Description="A list of projects this contact is linked to as a customer.", Name="Projects")>]
member val Projects:ResizeArray<ContactLinkedCustomerProjectsModel> = null with get,set
///<summary>
///A list of integration subscriptions used to link this contact to external records in other licensee owned systems.
///</summary>
[<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")>]
member val Subscriptions:ResizeArray<ConnectedContactSubscriptionsModel> = null with get,set
[<ApiResponse(Description="List of Contacts")>]
[<AllowNullLiteral>]
type GetLicenseeContactListResponse() =
///<summary>
///List of contacts.
///</summary>
[<ApiMember(DataType="List<ConnectedContactModel>", Description="List of contacts.", Name="Contacts")>]
member val Contacts:ResizeArray<ConnectedContactModel> = null with get,set
///<summary>
///Details of the api response. Success/Fail.
///</summary>
[<ApiMember(DataType="ResponseStatus", Description="Details of the api response. Success/Fail.", Name="ResponseStatus")>]
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Returns a list of contacts a licensee is linked to. Contacts are returned in batches.
///</summary>
[<Api(Description="Returns a list of contacts a licensee is linked to. Contacts are returned in batches.")>]
[<AllowNullLiteral>]
type GetLicenseeContactList() =
///<summary>
///Number of contacts to retrieve per call.
///</summary>
[<ApiMember(DataType="int", Description="Number of contacts to retrieve per call.", IsRequired=true, Name="BatchSize")>]
member val BatchSize:Int32 = new Int32() with get,set
///<summary>
///Call number (1=1st, 2=2nd) this should progress upwards until all contacts have been retrieved.
///</summary>
[<ApiMember(DataType="int", Description="Call number (1=1st, 2=2nd) this should progress upwards until all contacts have been retrieved.", IsRequired=true, Name="BatchNumber")>]
member val BatchNumber:Int32 = new Int32() with get,set
F# GetLicenseeContactList DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}