| All Verbs | /api/contacts/{ContactId}/create/person | ||
|---|---|---|---|
| All Verbs | /api/contacts/{ContactId}/create/organisation |
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<ApiResponse(Description="Contact Id of the newly invited/ created contact")>]
[<AllowNullLiteral>]
type AddContactResponse() =
member val ContactId:Guid = new Guid() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type UserProfileSummaryModel() =
///<summary>
///User Profile Id
///</summary>
[<ApiMember(DataType="Guid", Description="User Profile Id", Name="UserProfileId")>]
member val UserProfileId:Guid = new Guid() with get,set
///<summary>
///User linked to the profile
///</summary>
[<ApiMember(DataType="Guid", Description="User linked to the profile", Name="UserId")>]
member val UserId:Guid = new Guid() with get,set
///<summary>
///Contact linked to the profile
///</summary>
[<ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")>]
member val ContactId:Guid = new Guid() with get,set
///<summary>
///User linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="User linked to the profile", Name="UserName")>]
member val UserName:String = null with get,set
///<summary>
///User Profile Name
///</summary>
[<ApiMember(DataType="string", Description="User Profile Name", Name="ProfileName")>]
member val ProfileName:String = null with get,set
///<summary>
///Full name of the contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")>]
member val ContactFullName:String = null with get,set
///<summary>
///Email Address of the contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")>]
member val EmailAddress:String = null with get,set
///<summary>
///Email signature of the contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Email signature of the contact linked to the profile", Name="EmailSignature")>]
member val EmailSignature:String = null with get,set
///<summary>
///Mobile number of the contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Mobile number of the contact linked to the profile", Name="MobileNumber")>]
member val MobileNumber:String = null with get,set
///<summary>
///Phone number of the contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Phone number of the contact linked to the profile", Name="PhoneNumber")>]
member val PhoneNumber:String = null with get,set
///<summary>
///Type of contact (person, organisation etc.) linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeId")>]
member val ContactTypeId:Guid = new Guid() with get,set
///<summary>
///Type of contact (person, organisation etc.) linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeName")>]
member val ContactTypeName:String = null with get,set
///<summary>
///First name of the contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="First name of the contact linked to the profile", Name="FirstName")>]
member val FirstName:String = null with get,set
///<summary>
///Surname of the contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Surname of the contact linked to the profile", Name="Surname")>]
member val Surname:String = null with get,set
///<summary>
///Title of contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Title of contact linked to the profile", Name="Title")>]
member val Title:String = null with get,set
///<summary>
///Legal name of contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Legal name of contact linked to the profile", Name="LegalName")>]
member val LegalName:String = null with get,set
///<summary>
///Trading name of contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Trading name of contact linked to the profile", Name="TradingName")>]
member val TradingName:String = null with get,set
///<summary>
///Australian Business Number
///</summary>
[<ApiMember(DataType="string", Description="Australian Business Number", Name="Abn", ParameterType="query")>]
member val Abn:String = null with get,set
///<summary>
///Australian Company Number
///</summary>
[<ApiMember(DataType="string", Description="Australian Company Number", Name="Acn", ParameterType="query")>]
member val Acn:String = null with get,set
///<summary>
///Australian Registered Body Number
///</summary>
[<ApiMember(DataType="string", Description="Australian Registered Body Number", Name="Arbn", ParameterType="query")>]
member val Arbn:String = null with get,set
///<summary>
///Indicates if the Contact is registered for GST.
///</summary>
[<ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST.", Name="GstRegistered", ParameterType="query")>]
member val GstRegistered:Boolean = new Boolean() with get,set
///<summary>
///True if english is a secondary language for the contact.
///</summary>
[<ApiMember(DataType="bool", Description="True if english is a secondary language for the contact.", Name="ESL", ParameterType="query")>]
member val ESL:Boolean = new Boolean() with get,set
///<summary>
///Language that is the primary language for the contact.
///</summary>
[<ApiMember(DataType="string", Description="Language that is the primary language for the contact.", Name="Language", ParameterType="query")>]
member val Language:String = null with get,set
///<summary>
///True if an interpreter is required.
///</summary>
[<ApiMember(DataType="bool", Description="True if an interpreter is required.", Name="InterpreterRequired", ParameterType="query")>]
member val InterpreterRequired:Boolean = new Boolean() with get,set
///<summary>
///Licensee specific notes about the contact.
///</summary>
[<ApiMember(DataType="string", Description="Licensee specific notes about the contact.", Name="LicenseeNotes", ParameterType="query")>]
member val LicenseeNotes:String = null with get,set
///<summary>
///Profile photo of contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")>]
member val ProfilePhotoUrl:String = null with get,set
///<summary>
///Thumbnail photo of contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")>]
member val ProfilePhotoThumbnailUrl:String = null with get,set
///<summary>
///Profile photo id of contact linked to the profile
///</summary>
[<ApiMember(DataType="Guid", Description="Profile photo id of contact linked to the profile", Name="ProfileImageId")>]
member val ProfileImageId:Guid = new Guid() with get,set
///<summary>
///Profile description
///</summary>
[<ApiMember(DataType="string", Description="Profile description", Name="Description")>]
member val Description:String = null with get,set
///<summary>
///Employment Industry
///</summary>
[<ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")>]
member val EmploymentIndustry:String = null with get,set
///<summary>
///Employment Role
///</summary>
[<ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")>]
member val EmploymentRole:String = null with get,set
///<summary>
///Areas of Work
///</summary>
[<ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")>]
member val EmploymentGeographicArea:String = null with get,set
///<summary>
///The contacts timezone.
///</summary>
[<ApiMember(DataType="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")>]
member val Timezone:Guid = new Guid() with get,set
///<summary>
///Timezone Name
///</summary>
[<ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")>]
member val TimezoneName:String = null with get,set
///<summary>
///The primary address of the contact
///</summary>
[<ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")>]
member val PrimaryAddress:String = null with get,set
///<summary>
///Is this an active contact? Or an inactive contact (deleted account)?
///</summary>
[<ApiMember(DataType="bool", Description="Is this an active contact? Or an inactive contact (deleted account)?", Name="IsActiveContact")>]
member val IsActiveContact:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type CreateContact() =
///<summary>
///Contact Id creating the contact
///</summary>
[<ApiMember(DataType="Guid", Description="Contact Id creating the contact", IsRequired=true, Name="ContactId")>]
member val ContactId:Guid = new Guid() with get,set
///<summary>
///Details of the virtual contact being created
///</summary>
[<ApiMember(DataType="UserProfileSummaryCoreModel", Description="Details of the virtual contact being created", IsRequired=true, Name="Contact")>]
member val Contact:UserProfileSummaryModel = null with get,set
///<summary>
///List of roles to invite the contact
///</summary>
[<ApiMember(DataType="List<Guid>", Description="List of roles to invite the contact", IsRequired=true, Name="Roles")>]
member val Roles:ResizeArray<Guid> = null with get,set
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.
POST /api/contacts/{ContactId}/create/person HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Contact:
{
UserName: String,
ProfileName: String,
ContactFullName: String,
EmailAddress: String,
EmailSignature: String,
MobileNumber: String,
PhoneNumber: String,
ContactTypeName: String,
FirstName: String,
Surname: String,
Title: String,
LegalName: String,
TradingName: String,
Abn: String,
Acn: String,
Arbn: String,
GstRegistered: False,
ESL: False,
Language: String,
InterpreterRequired: False,
LicenseeNotes: String,
ProfilePhotoUrl: String,
ProfilePhotoThumbnailUrl: String,
Description: String,
EmploymentIndustry: String,
EmploymentRole: String,
EmploymentGeographicArea: String,
TimezoneName: String,
PrimaryAddress: String,
IsActiveContact: False
},
Roles:
[
00000000-0000-0000-0000-000000000000
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}