| All Verbs | /api/contacts/{ContactId}/profile |
|---|
"use strict";
export class UserProfileSummaryModel {
/** @param {{UserProfileId?:string,UserId?:string,ContactId?:string,UserName?:string,ProfileName?:string,ContactFullName?:string,EmailAddress?:string,EmailSignature?:string,MobileNumber?:string,PhoneNumber?:string,ContactTypeId?:string,ContactTypeName?:string,FirstName?:string,Surname?:string,Title?:string,LegalName?:string,TradingName?:string,Abn?:string,Acn?:string,Arbn?:string,GstRegistered?:boolean,ESL?:boolean,Language?:string,InterpreterRequired?:boolean,LicenseeNotes?:string,ProfilePhotoUrl?:string,ProfilePhotoThumbnailUrl?:string,ProfileImageId?:string,Description?:string,EmploymentIndustry?:string,EmploymentRole?:string,EmploymentGeographicArea?:string,Timezone?:string,TimezoneName?:string,PrimaryAddress?:string,IsActiveContact?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description User Profile Id */
UserProfileId;
/**
* @type {string}
* @description User linked to the profile */
UserId;
/**
* @type {string}
* @description Contact linked to the profile */
ContactId;
/**
* @type {string}
* @description User linked to the profile */
UserName;
/**
* @type {string}
* @description User Profile Name */
ProfileName;
/**
* @type {string}
* @description Full name of the contact linked to the profile */
ContactFullName;
/**
* @type {string}
* @description Email Address of the contact linked to the profile */
EmailAddress;
/**
* @type {string}
* @description Email signature of the contact linked to the profile */
EmailSignature;
/**
* @type {string}
* @description Mobile number of the contact linked to the profile */
MobileNumber;
/**
* @type {string}
* @description Phone number of the contact linked to the profile */
PhoneNumber;
/**
* @type {string}
* @description Type of contact (person, organisation etc.) linked to the profile */
ContactTypeId;
/**
* @type {string}
* @description Type of contact (person, organisation etc.) linked to the profile */
ContactTypeName;
/**
* @type {string}
* @description First name of the contact linked to the profile */
FirstName;
/**
* @type {string}
* @description Surname of the contact linked to the profile */
Surname;
/**
* @type {string}
* @description Title of contact linked to the profile */
Title;
/**
* @type {string}
* @description Legal name of contact linked to the profile */
LegalName;
/**
* @type {string}
* @description Trading name of contact linked to the profile */
TradingName;
/**
* @type {string}
* @description Australian Business Number */
Abn;
/**
* @type {string}
* @description Australian Company Number */
Acn;
/**
* @type {string}
* @description Australian Registered Body Number */
Arbn;
/**
* @type {boolean}
* @description Indicates if the Contact is registered for GST. */
GstRegistered;
/**
* @type {boolean}
* @description True if english is a secondary language for the contact. */
ESL;
/**
* @type {string}
* @description Language that is the primary language for the contact. */
Language;
/**
* @type {boolean}
* @description True if an interpreter is required. */
InterpreterRequired;
/**
* @type {string}
* @description Licensee specific notes about the contact. */
LicenseeNotes;
/**
* @type {string}
* @description Profile photo of contact linked to the profile */
ProfilePhotoUrl;
/**
* @type {string}
* @description Thumbnail photo of contact linked to the profile */
ProfilePhotoThumbnailUrl;
/**
* @type {string}
* @description Profile photo id of contact linked to the profile */
ProfileImageId;
/**
* @type {string}
* @description Profile description */
Description;
/**
* @type {string}
* @description Employment Industry */
EmploymentIndustry;
/**
* @type {string}
* @description Employment Role */
EmploymentRole;
/**
* @type {string}
* @description Areas of Work */
EmploymentGeographicArea;
/**
* @type {string}
* @description The contacts timezone. */
Timezone;
/**
* @type {string}
* @description Timezone Name */
TimezoneName;
/**
* @type {string}
* @description The primary address of the contact */
PrimaryAddress;
/**
* @type {boolean}
* @description Is this an active contact? Or an inactive contact (deleted account)? */
IsActiveContact;
}
export class LocationCoordinatesModel {
/** @param {{Latitude?:number,Longitude?:number,Altitude?:number,Accuracy?:number,AltitudeAccuracy?:number,Heading?:number,Speed?:number,VerticalSpeed?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface. */
Latitude;
/**
* @type {number}
* @description The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface. */
Longitude;
/**
* @type {?number}
* @description The altitude of an address - the altitude above sea level." */
Altitude;
/**
* @type {?number}
* @description Accuracy of the latitude and longitude. */
Accuracy;
/**
* @type {?number}
* @description Accurancy of the Altitude. */
AltitudeAccuracy;
/**
* @type {?number}
* @description Direction you are heading. */
Heading;
/**
* @type {?number}
* @description Speed you are going. */
Speed;
/**
* @type {?number}
* @description Speed your altitude is ascending/descending at. */
VerticalSpeed;
}
export class AddressModel {
/** @param {{DistanceAway?:number,Latitude?:number,Longitude?:number,AddressFormatId?:string,SuburbId?:string,SuburbName?:string,StateShortName?:string,PostCode?:string,CountryId?:string,CountryName?:string,ISOCountryCode?:string,LotNumber?:string,SubUnit?:string,BuildingNumber?:string,StreetNumber?:string,StreetName?:string,AddressLineOne?:string,AddressLineTwo?:string,AddressFull?:string,IsPhysical?:boolean,Notes?:string,AutoMapCoordinates?:boolean,LocationCoordinates?:LocationCoordinatesModel}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The distance between this project and another specified set of gps coordinates. */
DistanceAway;
/**
* @type {number}
* @description The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface. */
Latitude;
/**
* @type {number}
* @description The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface. */
Longitude;
/**
* @type {string}
* @description Address Format Id Guid - this will be determined by the service. */
AddressFormatId;
/**
* @type {string}
* @description Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered. */
SuburbId;
/**
* @type {string}
* @description The suburb name. */
SuburbName;
/**
* @type {string}
* @description The shortened State Name e.g Vic for Victoria. */
StateShortName;
/**
* @type {string}
* @description The suburb postcode. */
PostCode;
/**
* @type {string}
* @description Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered. */
CountryId;
/**
* @type {string}
* @description the name of the country the address is within. */
CountryName;
/**
* @type {string}
* @description ISO Country Code. */
ISOCountryCode;
/**
* @type {string}
* @description The address Lot number. */
LotNumber;
/**
* @type {string}
* @description The address Sub Unit number. */
SubUnit;
/**
* @type {string}
* @description The address building number. */
BuildingNumber;
/**
* @type {string}
* @description The address street number. */
StreetNumber;
/**
* @type {string}
* @description The address street name including street type. */
StreetName;
/**
* @type {string}
* @description A formatted address Line 1. */
AddressLineOne;
/**
* @type {string}
* @description A formatted address Line 2. */
AddressLineTwo;
/**
* @type {string}
* @description The full address string. */
AddressFull;
/**
* @type {?boolean}
* @description True if the address is a physical location. */
IsPhysical;
/**
* @type {string}
* @description Notes about the address. */
Notes;
/**
* @type {?boolean}
* @description If true, the address is eligible for having its coordinates calculated/updated. */
AutoMapCoordinates;
/**
* @type {LocationCoordinatesModel}
* @description Location Coordinates for the address. */
LocationCoordinates;
}
export class GeoEstateStageModel {
/** @param {{GeoEstateStageId?:string,GeoEstateId?:string,Name?:string,Notes?:string,RecordStatus?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
GeoEstateStageId;
/** @type {string} */
GeoEstateId;
/** @type {string} */
Name;
/** @type {string} */
Notes;
/** @type {string} */
RecordStatus;
}
export class GeoEstateModel {
/** @param {{GeoEstateId?:string,Name?:string,Notes?:string,DeveloperContactId?:string,DeveloperName?:string,DeveloperProfilePhotoUrl?:string,DeveloperProfilePhotoThumbnail?:string,RecordStatus?:string,Stages?:GeoEstateStageModel[],CurrentEstateStageId?:string,CurrentEstateStageName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
GeoEstateId;
/** @type {string} */
Name;
/** @type {string} */
Notes;
/** @type {string} */
DeveloperContactId;
/** @type {string} */
DeveloperName;
/** @type {string} */
DeveloperProfilePhotoUrl;
/** @type {string} */
DeveloperProfilePhotoThumbnail;
/** @type {string} */
RecordStatus;
/** @type {GeoEstateStageModel[]} */
Stages;
/** @type {string} */
CurrentEstateStageId;
/** @type {string} */
CurrentEstateStageName;
}
export class GeoLocationModel {
/** @param {{GeoLocationId?:string,StateId?:string,StateName?:string,SuburbId?:string,SuburbName?:string,CountryId?:string,CountryName?:string,LotNumber?:string,SubUnit?:string,BuildingNumber?:string,PostalDeliveryNumber?:string,StreetNumber?:string,StreetName?:string,AddressLineOne?:string,AddressLineTwo?:string,PostCode?:string,IsPhysical?:boolean,Notes?:string,AddressFull?:string,AddressFormatId?:string,Latitude?:number,Longitude?:number,Timezone?:string,Estate?:GeoEstateModel,GeoEstateId?:string,GeoEstateStageId?:string,GeoEstateStageName?:string,IgnoreValidation?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The location id */
GeoLocationId;
/**
* @type {?string}
* @description The state id */
StateId;
/**
* @type {string}
* @description The state name */
StateName;
/**
* @type {?string}
* @description The suburb id */
SuburbId;
/**
* @type {string}
* @description The suburb name */
SuburbName;
/**
* @type {?string}
* @description The country id */
CountryId;
/**
* @type {string}
* @description The country name */
CountryName;
/**
* @type {string}
* @description The lot number */
LotNumber;
/**
* @type {string}
* @description The unit number */
SubUnit;
/**
* @type {string}
* @description The building number */
BuildingNumber;
/**
* @type {string}
* @description PO Box Number */
PostalDeliveryNumber;
/**
* @type {string}
* @description The Street Number */
StreetNumber;
/**
* @type {string}
* @description The Street name */
StreetName;
/**
* @type {string}
* @description Address Line ONe */
AddressLineOne;
/**
* @type {string}
* @description Address Line Two */
AddressLineTwo;
/**
* @type {string}
* @description Post code */
PostCode;
/**
* @type {boolean}
* @description Is location physical */
IsPhysical;
/**
* @type {string}
* @description Notes about the location */
Notes;
/**
* @type {string}
* @description The address in full */
AddressFull;
/**
* @type {string}
* @description Address format id. */
AddressFormatId;
/**
* @type {number}
* @description Latitude */
Latitude;
/**
* @type {number}
* @description Longitude */
Longitude;
/**
* @type {?string}
* @description Timezone Id */
Timezone;
/** @type {GeoEstateModel} */
Estate;
/** @type {string} */
GeoEstateId;
/** @type {string} */
GeoEstateStageId;
/** @type {string} */
GeoEstateStageName;
/** @type {boolean} */
IgnoreValidation;
}
export class ContactAddressModel {
/** @param {{Location?:GeoLocationModel,IsPostal?:boolean,IsPrimaryLocation?:boolean,IsRegisteredLocation?:boolean,ContactAddressId?:string,SuburbName?:string,StateName?:string,CountryName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {GeoLocationModel}
* @description Location Details. */
Location;
/**
* @type {boolean}
* @description Is address postal. */
IsPostal;
/**
* @type {boolean}
* @description Is address primary. */
IsPrimaryLocation;
/**
* @type {boolean}
* @description Is address registered. */
IsRegisteredLocation;
/**
* @type {string}
* @description Contact Address Id. */
ContactAddressId;
/**
* @type {string}
* @description Contact Address Suburb Name. */
SuburbName;
/**
* @type {string}
* @description Contact Address Street Name. */
StateName;
/**
* @type {string}
* @description Contact Country Name. */
CountryName;
}
export class PhoneModel {
/** @param {{CountryCode?:string,AreaCode?:string,LocalNumber?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Phone Country Code. */
CountryCode;
/**
* @type {string}
* @description Phone Area Code. */
AreaCode;
/**
* @type {string}
* @description Phone Local Number. */
LocalNumber;
}
export class ContactDetailModel {
/** @param {{ContactMethodId?:string,ContactMethodName?:string,ContactAddress?:ContactAddressModel,ContactPhone?:PhoneModel,CountryId?:string,ContactDetails?:string,Notes?:string,ContactDetailsCode?:string,OrderContactMethod?:number,IsPrimaryContactMethod?:boolean,IsAddress?:boolean,ContactContactDetailId?:string,ContactId?:string,ContactDetailId?:string,IsPrimaryLocation?:boolean,IsRegisteredLocation?:boolean,IsPostal?:boolean,IsPhone?:boolean,EmailSignatureId?:string,EmailSignatureHTML?:string,EmailSignatureText?:string,ApiFrameworkAlternateKey?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Contact Method Id */
ContactMethodId;
/**
* @type {string}
* @description Contact Method Name */
ContactMethodName;
/**
* @type {ContactAddressModel}
* @description Contact Address Details */
ContactAddress;
/**
* @type {PhoneModel}
* @description Contact Phone Details */
ContactPhone;
/**
* @type {?string}
* @description Country id */
CountryId;
/**
* @type {string}
* @description Contact Details */
ContactDetails;
/**
* @type {string}
* @description Notes */
Notes;
/**
* @type {string}
* @description Contact Details Code */
ContactDetailsCode;
/**
* @type {number}
* @description Order of Contact Method Id */
OrderContactMethod;
/**
* @type {boolean}
* @description Contact Method Id */
IsPrimaryContactMethod;
/**
* @type {boolean}
* @description Is contact details an address */
IsAddress;
/**
* @type {string}
* @description Contact Contact Detail Id */
ContactContactDetailId;
/**
* @type {string}
* @description Contact Id */
ContactId;
/**
* @type {string}
* @description Contact Details Id */
ContactDetailId;
/**
* @type {boolean}
* @description Is contact details a primary location */
IsPrimaryLocation;
/**
* @type {boolean}
* @description Is contact details a registered location */
IsRegisteredLocation;
/**
* @type {boolean}
* @description Is contact details a postal address */
IsPostal;
/**
* @type {boolean}
* @description Is contact details a phone number */
IsPhone;
/**
* @type {string}
* @description Email Signature Id */
EmailSignatureId;
/**
* @type {string}
* @description Email Signature HTML */
EmailSignatureHTML;
/**
* @type {string}
* @description Email Signature Text */
EmailSignatureText;
/**
* @type {string}
* @description API Key from Framework */
ApiFrameworkAlternateKey;
}
export class UserProfileModel extends UserProfileSummaryModel {
/** @param {{BirthDate?:string,MaritalStatusName?:string,GenderName?:string,GenderId?:string,ContactDetails?:ContactDetailModel[],PrimaryStreetAddress?:ContactDetailModel,PrimaryPostalAddress?:ContactDetailModel,PrimaryRegisteredAddress?:ContactDetailModel,PrimaryEmail?:ContactDetailModel,PrimaryMobile?:ContactDetailModel,PrimaryPhone?:ContactDetailModel,PrimaryFax?:ContactDetailModel,PrimaryWeb?:ContactDetailModel,SocialMediaTwitter?:ContactDetailModel,SocialMediaFacebook?:ContactDetailModel,SocialMediaInstagram?:ContactDetailModel,IsRemovedContact?:boolean,IsDefault?:boolean,IsEmailEditable?:boolean,PrimaryImageContent?:string,PrimaryImageContentType?:string,PrimaryImageFileName?:string,UserProfileId?:string,UserId?:string,ContactId?:string,UserName?:string,ProfileName?:string,ContactFullName?:string,EmailAddress?:string,EmailSignature?:string,MobileNumber?:string,PhoneNumber?:string,ContactTypeId?:string,ContactTypeName?:string,FirstName?:string,Surname?:string,Title?:string,LegalName?:string,TradingName?:string,Abn?:string,Acn?:string,Arbn?:string,GstRegistered?:boolean,ESL?:boolean,Language?:string,InterpreterRequired?:boolean,LicenseeNotes?:string,ProfilePhotoUrl?:string,ProfilePhotoThumbnailUrl?:string,ProfileImageId?:string,Description?:string,EmploymentIndustry?:string,EmploymentRole?:string,EmploymentGeographicArea?:string,Timezone?:string,TimezoneName?:string,PrimaryAddress?:string,IsActiveContact?:boolean}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {?string}
* @description Contact Date of Birth (when person type) */
BirthDate;
/**
* @type {string}
* @description Contact marital status (when person type) */
MaritalStatusName;
/**
* @type {string}
* @description Contact gender (when person type) */
GenderName;
/**
* @type {?string}
* @description The Gender Guid of the contact. */
GenderId;
/**
* @type {ContactDetailModel[]}
* @description All contact details of the contact */
ContactDetails;
/**
* @type {ContactDetailModel}
* @description Primary Street Address */
PrimaryStreetAddress;
/**
* @type {ContactDetailModel}
* @description Primary Postal Address */
PrimaryPostalAddress;
/**
* @type {ContactDetailModel}
* @description Primary Registered Address */
PrimaryRegisteredAddress;
/**
* @type {ContactDetailModel}
* @description Primary Email Address */
PrimaryEmail;
/**
* @type {ContactDetailModel}
* @description Primary Mobile Number */
PrimaryMobile;
/**
* @type {ContactDetailModel}
* @description Primary Non-Mobile Number */
PrimaryPhone;
/**
* @type {ContactDetailModel}
* @description Primary Fax Number */
PrimaryFax;
/**
* @type {ContactDetailModel}
* @description Primary Web Address */
PrimaryWeb;
/**
* @type {ContactDetailModel}
* @description Social Media Twitter */
SocialMediaTwitter;
/**
* @type {ContactDetailModel}
* @description Social Media Facebook */
SocialMediaFacebook;
/**
* @type {ContactDetailModel}
* @description Social Media Instagram */
SocialMediaInstagram;
/**
* @type {boolean}
* @description Have all connections to the contact been removed? */
IsRemovedContact;
/**
* @type {boolean}
* @description True if this is the users default profile. */
IsDefault;
/**
* @type {boolean}
* @description True if the users email on this profile can be edited. */
IsEmailEditable;
/**
* @type {string}
* @description Primary image Content sent as a file stream contents (if not attached to the request) */
PrimaryImageContent;
/**
* @type {string}
* @description Primary image Content type sent as a file stream contents (if not attached to the request) */
PrimaryImageContentType;
/**
* @type {string}
* @description Primary image file name */
PrimaryImageFileName;
}
export class GetContactProfileResponse {
/** @param {{Contact?:UserProfileModel,RequestorAllowedContactDetails?:boolean,RequestorAllowedOrganisationProfile?:boolean,RequestorAllowedStaffDetails?:boolean,RequestorAllowedAttachments?:boolean,RequestorAllowedActivityFeed?:boolean,RequestorAllowedRelatedItems?:boolean,DisplaySendConnectionEmailsOption?:boolean,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {UserProfileModel} */
Contact;
/**
* @type {boolean}
* @description Is Requestor contact allowed to view contact details? */
RequestorAllowedContactDetails;
/**
* @type {boolean}
* @description Is Requestor contact allowed to view organisation profile? */
RequestorAllowedOrganisationProfile;
/**
* @type {boolean}
* @description Is Requestor contact allowed to view staff details? */
RequestorAllowedStaffDetails;
/**
* @type {boolean}
* @description Is Requestor contact allowed to view attachments? */
RequestorAllowedAttachments;
/**
* @type {boolean}
* @description Is Requestor contact allowed to view activity feed? */
RequestorAllowedActivityFeed;
/**
* @type {boolean}
* @description Is Requestor contact allowed to view related items? */
RequestorAllowedRelatedItems;
/**
* @type {boolean}
* @description Optional connection emails option allowed for for real contacts who are registered and connected */
DisplaySendConnectionEmailsOption;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetContactProfile {
/** @param {{ContactId?:string,RequestorContactId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Contact Id to get contact profile and details for */
ContactId;
/**
* @type {string}
* @description Contact Id requesting the details - Current user or licensee */
RequestorContactId;
}
export class ContactDetailModel {
/** @param {{ContactMethodId?:string,ContactMethodName?:string,ContactAddress?:ContactAddressModel,ContactPhone?:PhoneModel,CountryId?:string,ContactDetails?:string,Notes?:string,ContactDetailsCode?:string,OrderContactMethod?:number,IsPrimaryContactMethod?:boolean,IsAddress?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Id of the Contact Method */
ContactMethodId;
/**
* @type {string}
* @description Contact Method Name */
ContactMethodName;
/**
* @type {ContactAddressModel}
* @description If the contact method is an address, this will contain the address details. */
ContactAddress;
/**
* @type {PhoneModel}
* @description If the contact method is a phone, this will contain the phone details */
ContactPhone;
/**
* @type {?string}
* @description Id of the country */
CountryId;
/**
* @type {string}
* @description A summary string representing the contact details */
ContactDetails;
/**
* @type {string}
* @description Notes about the contact details */
Notes;
/**
* @type {string}
* @description Area Code if contact details are a phone number */
ContactDetailsCode;
/**
* @type {number}
* @description Order number of the contact method */
OrderContactMethod;
/**
* @type {boolean}
* @description True if this is the primary contact method */
IsPrimaryContactMethod;
/**
* @type {boolean}
* @description True if this contact method is an address */
IsAddress;
}
export class ContactAddressModel {
/** @param {{Address?:AddressModel,IsPostal?:boolean,IsPrimaryLocation?:boolean,IsRegisteredLocation?:boolean,SuburbName?:string,StateName?:string,CountryName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {AddressModel}
* @description Address Details */
Address;
/**
* @type {boolean}
* @description True if this is a postal address. */
IsPostal;
/**
* @type {boolean}
* @description True if this is the primary address. */
IsPrimaryLocation;
/**
* @type {boolean}
* @description True if this address is the registered tax address. */
IsRegisteredLocation;
/**
* @type {string}
* @description Suburb Name */
SuburbName;
/**
* @type {string}
* @description State Name */
StateName;
/**
* @type {string}
* @description Country Name */
CountryName;
}
export class PhoneModel {
/** @param {{CountryCode?:string,AreaCode?:string,LocalNumber?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Country Code */
CountryCode;
/**
* @type {string}
* @description Area Code */
AreaCode;
/**
* @type {string}
* @description Local Number */
LocalNumber;
}
JavaScript GetContactProfile 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.
POST /api/contacts/{ContactId}/profile HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Contact:
{
BirthDate: 0001-01-01,
MaritalStatusName: String,
GenderName: String,
GenderId: 00000000000000000000000000000000,
ContactDetails:
[
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
}
],
PrimaryStreetAddress:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryPostalAddress:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryRegisteredAddress:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryEmail:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryMobile:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryPhone:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryFax:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryWeb:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
SocialMediaTwitter:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
SocialMediaFacebook:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
SocialMediaInstagram:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
IsRemovedContact: False,
IsDefault: False,
IsEmailEditable: False,
PrimaryImageContent: String,
PrimaryImageContentType: String,
PrimaryImageFileName: String,
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
},
RequestorAllowedContactDetails: False,
RequestorAllowedOrganisationProfile: False,
RequestorAllowedStaffDetails: False,
RequestorAllowedAttachments: False,
RequestorAllowedActivityFeed: False,
RequestorAllowedRelatedItems: False,
DisplaySendConnectionEmailsOption: False,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}