| All Verbs | /api/updatecustomergroup |
|---|
"use strict";
export class StringResponse {
/** @param {{Result?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Result;
}
export class ContactBanking {
/** @param {{ContactId?:string,BankName?:string,BankLocation?:string,Bsb?:string,AccountNumber?:string,AccountName?:string,TermOfTradeId?:string,TermOfTradeName?:string,OwnerContactId?:string,RecordStatus?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ContactId;
/** @type {string} */
BankName;
/** @type {string} */
BankLocation;
/** @type {string} */
Bsb;
/** @type {string} */
AccountNumber;
/** @type {string} */
AccountName;
/** @type {?string} */
TermOfTradeId;
/** @type {string} */
TermOfTradeName;
/** @type {string} */
OwnerContactId;
/** @type {string} */
RecordStatus;
}
export class UserRole {
/** @param {{ConnectionId?:string,ContactRoleId?:string,ContactId?:string,RoleId?:string,RoleName?:string,StartDate?:string,EndDate?:string,IsLicenseeRole?:boolean,IsCustomerRole?:boolean,IsPlatformRole?:boolean,IsAdministerContactsRole?:boolean,RolePrimaryImageURL?:string,RolePrimaryImageThumbnailURL?:string,RolePrimaryImageId?:string,ConnectionStatusId?:string,ConnectionStatusName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ConnectionId;
/** @type {string} */
ContactRoleId;
/** @type {string} */
ContactId;
/** @type {string} */
RoleId;
/** @type {string} */
RoleName;
/** @type {string} */
StartDate;
/** @type {?string} */
EndDate;
/** @type {boolean} */
IsLicenseeRole;
/** @type {boolean} */
IsCustomerRole;
/** @type {boolean} */
IsPlatformRole;
/** @type {boolean} */
IsAdministerContactsRole;
/** @type {string} */
RolePrimaryImageURL;
/** @type {string} */
RolePrimaryImageThumbnailURL;
/** @type {string} */
RolePrimaryImageId;
/** @type {string} */
ConnectionStatusId;
/** @type {string} */
ConnectionStatusName;
}
export class GeoEstateStage {
/** @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 GeoEstate {
/** @param {{GeoEstateId?:string,Name?:string,Notes?:string,DeveloperContactId?:string,DeveloperName?:string,DeveloperProfilePhotoUrl?:string,DeveloperProfilePhotoThumbnail?:string,RecordStatus?:string,Stages?:GeoEstateStage[],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 {GeoEstateStage[]} */
Stages;
/** @type {string} */
CurrentEstateStageId;
/** @type {string} */
CurrentEstateStageName;
}
export class GeoLocation {
/** @param {{GeoLocationId?:string,StateId?:string,StateName?:string,StateNameShort?:string,SuburbId?:string,SuburbName?:string,CountryId?:string,CountryName?:string,Timezone?:string,TimezoneName?: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,PostalDeliveryTypeId?:string,Latitude?:number,Longitude?:number,Accuracy?:number,DistanceAway?:number,AutoMapCoordinates?:boolean,IsAddressCleared?:boolean,IsValidated?:boolean,Estate?:GeoEstate,GeoEstateId?:string,GeoEstateStageId?:string,GeoEstateStageName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
GeoLocationId;
/** @type {?string} */
StateId;
/** @type {string} */
StateName;
/** @type {string} */
StateNameShort;
/** @type {?string} */
SuburbId;
/** @type {string} */
SuburbName;
/** @type {?string} */
CountryId;
/** @type {string} */
CountryName;
/** @type {?string} */
Timezone;
/** @type {string} */
TimezoneName;
/** @type {string} */
LotNumber;
/** @type {string} */
SubUnit;
/** @type {string} */
BuildingNumber;
/** @type {string} */
PostalDeliveryNumber;
/** @type {string} */
StreetNumber;
/** @type {string} */
StreetName;
/** @type {string} */
AddressLineOne;
/** @type {string} */
AddressLineTwo;
/** @type {string} */
PostCode;
/** @type {boolean} */
IsPhysical;
/** @type {string} */
Notes;
/** @type {string} */
AddressFull;
/** @type {string} */
AddressFormatId;
/** @type {?string} */
PostalDeliveryTypeId;
/** @type {number} */
Latitude;
/** @type {number} */
Longitude;
/** @type {number} */
Accuracy;
/** @type {number} */
DistanceAway;
/** @type {?boolean} */
AutoMapCoordinates;
/** @type {boolean} */
IsAddressCleared;
/** @type {boolean} */
IsValidated;
/** @type {GeoEstate} */
Estate;
/** @type {string} */
GeoEstateId;
/** @type {string} */
GeoEstateStageId;
/** @type {string} */
GeoEstateStageName;
}
export class ContactAddress {
/** @param {{Location?:GeoLocation,IsPostal?:boolean,IsPrimaryLocation?:boolean,IsRegisteredLocation?:boolean,ContactAddressId?:string,SuburbName?:string,StateName?:string,CountryName?:string,AddressFull?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {GeoLocation} */
Location;
/** @type {boolean} */
IsPostal;
/** @type {boolean} */
IsPrimaryLocation;
/** @type {boolean} */
IsRegisteredLocation;
/** @type {string} */
ContactAddressId;
/** @type {string} */
SuburbName;
/** @type {string} */
StateName;
/** @type {string} */
CountryName;
/** @type {string} */
AddressFull;
}
export class ContactPhone {
/** @param {{CountryCode?:string,AreaCode?:string,LocalNumber?:string,PhoneNumber?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
CountryCode;
/** @type {string} */
AreaCode;
/** @type {string} */
LocalNumber;
/** @type {string} */
PhoneNumber;
}
export class ContactDetail {
/** @param {{ContactContactDetailId?:string,ContactId?:string,ContactDetailId?:string,ContactMethodId?:string,ContactMethodName?:string,Address?:ContactAddress,Phone?:ContactPhone,CountryId?:string,ContactDetails?:string,Notes?:string,ContactDetailsCode?:string,OrderContactMethod?:number,IsPrimaryContactMethod?:boolean,IsPrimaryLocation?:boolean,IsRegisteredLocation?:boolean,IsPostal?:boolean,IsAddress?:boolean,IsPhone?:boolean,EmailSignatureId?:string,EmailSignatureHTML?:string,EmailSignatureText?:string,ApiKey?:string,FrameworkAlternateKey?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ContactContactDetailId;
/** @type {string} */
ContactId;
/** @type {string} */
ContactDetailId;
/** @type {string} */
ContactMethodId;
/** @type {string} */
ContactMethodName;
/** @type {ContactAddress} */
Address;
/** @type {ContactPhone} */
Phone;
/** @type {?string} */
CountryId;
/** @type {string} */
ContactDetails;
/** @type {string} */
Notes;
/** @type {string} */
ContactDetailsCode;
/** @type {number} */
OrderContactMethod;
/** @type {boolean} */
IsPrimaryContactMethod;
/** @type {boolean} */
IsPrimaryLocation;
/** @type {boolean} */
IsRegisteredLocation;
/** @type {boolean} */
IsPostal;
/** @type {boolean} */
IsAddress;
/** @type {boolean} */
IsPhone;
/** @type {string} */
EmailSignatureId;
/** @type {string} */
EmailSignatureHTML;
/** @type {string} */
EmailSignatureText;
/** @type {string} */
ApiKey;
/** @type {string} */
FrameworkAlternateKey;
}
export class CustomContentFieldValue {
/** @param {{FieldName?:string,FieldDataTypeId?:string,FieldValue?:string,AlternateKey?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
FieldName;
/** @type {string} */
FieldDataTypeId;
/** @type {string} */
FieldValue;
/** @type {string} */
AlternateKey;
}
export class Contact {
/** @param {{ContactId?:string,PrimaryStreetAddressId?:string,PrimaryPostalAddressId?:string,PrimaryTaxRegisteredAddressId?:string,PrimaryNonMobileId?:string,PrimaryMobileId?:string,PrimaryEmailId?:string,Mobile?:string,Phone?:string,PrimaryEmail?:string,PrimaryAddress?:string,PrimaryFaxId?:string,PrimaryWebId?:string,PrimarySocialMediaId?:string,FirstName?:string,MiddleName?:string,Surname?:string,FullName?:string,ShortName?:string,BirthDate?:string,Title?:string,Salutation?:string,MaritalStatus?:string,MaritalStatusName?:string,Gender?:string,GenderName?:string,Abn?:string,Acn?:string,Arbn?:string,ContactBankingDetails?:ContactBanking,LegalName?:string,TradingName?:string,ContactType?:string,ContactTypeName?:string,ContactTypePhotoUrl?:string,ContactTypePhotoThumbnailUrl?:string,Timezone?:string,TimezoneName?:string,Description?:string,EmploymentIndustry?:string,EmploymentRole?:string,EmploymentGeographicArea?:string,GstRegistered?:boolean,DriversLicence?:string,ContactGroupIdStaff?:string,StaffGroupName?:string,ContactGroupIdVendor?:string,VendorGroupName?:string,ContactGroupIdCustomer?:string,CustomerGroupName?:string,PrimaryMediaFileId?:string,ProfilePhotoUrl?:string,ProfilePhotoThumbnailUrl?:string,ProfileImageId?:string,RecordStatus?:string,ConnectionStatusId?:string,SubscriptionAlternateKey?:string,ContactRoles?:UserRole[],ContactDetails?:ContactDetail[],CustomContent?:CustomContentFieldValue[],ConnectedContacts?:Contact[],CustomContentXML?:string,ContactDetailsXML?:string,ConnectionContactId?:string,ConnectionContactName?:string,UserProfileIdDefault?:string,UserId?:string,Username?:string,IsRegistered?:boolean,ESL?:boolean,Language?:string,InterpreterRequired?:boolean,LicenseeNotes?:string,Notes?:string,ObjectSubscriptionId?:string,ObjectHash?:string,OwnerContactId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ContactId;
/** @type {?string} */
PrimaryStreetAddressId;
/** @type {?string} */
PrimaryPostalAddressId;
/** @type {?string} */
PrimaryTaxRegisteredAddressId;
/** @type {?string} */
PrimaryNonMobileId;
/** @type {?string} */
PrimaryMobileId;
/** @type {?string} */
PrimaryEmailId;
/** @type {string} */
Mobile;
/** @type {string} */
Phone;
/** @type {string} */
PrimaryEmail;
/** @type {string} */
PrimaryAddress;
/** @type {?string} */
PrimaryFaxId;
/** @type {?string} */
PrimaryWebId;
/** @type {?string} */
PrimarySocialMediaId;
/** @type {string} */
FirstName;
/** @type {string} */
MiddleName;
/** @type {string} */
Surname;
/** @type {string} */
FullName;
/** @type {string} */
ShortName;
/** @type {?string} */
BirthDate;
/** @type {string} */
Title;
/** @type {string} */
Salutation;
/** @type {?string} */
MaritalStatus;
/** @type {string} */
MaritalStatusName;
/** @type {?string} */
Gender;
/** @type {string} */
GenderName;
/** @type {string} */
Abn;
/** @type {string} */
Acn;
/** @type {string} */
Arbn;
/** @type {ContactBanking} */
ContactBankingDetails;
/** @type {string} */
LegalName;
/** @type {string} */
TradingName;
/** @type {?string} */
ContactType;
/** @type {string} */
ContactTypeName;
/** @type {string} */
ContactTypePhotoUrl;
/** @type {string} */
ContactTypePhotoThumbnailUrl;
/** @type {?string} */
Timezone;
/** @type {string} */
TimezoneName;
/** @type {string} */
Description;
/** @type {string} */
EmploymentIndustry;
/** @type {string} */
EmploymentRole;
/** @type {string} */
EmploymentGeographicArea;
/** @type {boolean} */
GstRegistered;
/** @type {string} */
DriversLicence;
/** @type {?string} */
ContactGroupIdStaff;
/** @type {string} */
StaffGroupName;
/** @type {?string} */
ContactGroupIdVendor;
/** @type {string} */
VendorGroupName;
/** @type {?string} */
ContactGroupIdCustomer;
/** @type {string} */
CustomerGroupName;
/** @type {?string} */
PrimaryMediaFileId;
/** @type {string} */
ProfilePhotoUrl;
/** @type {string} */
ProfilePhotoThumbnailUrl;
/** @type {string} */
ProfileImageId;
/** @type {string} */
RecordStatus;
/** @type {string} */
ConnectionStatusId;
/** @type {string} */
SubscriptionAlternateKey;
/** @type {UserRole[]} */
ContactRoles;
/** @type {ContactDetail[]} */
ContactDetails;
/** @type {CustomContentFieldValue[]} */
CustomContent;
/** @type {Contact[]} */
ConnectedContacts;
/** @type {string} */
CustomContentXML;
/** @type {string} */
ContactDetailsXML;
/** @type {string} */
ConnectionContactId;
/** @type {string} */
ConnectionContactName;
/** @type {?string} */
UserProfileIdDefault;
/** @type {string} */
UserId;
/** @type {string} */
Username;
/** @type {boolean} */
IsRegistered;
/** @type {boolean} */
ESL;
/** @type {string} */
Language;
/** @type {boolean} */
InterpreterRequired;
/** @type {string} */
LicenseeNotes;
/** @type {string} */
Notes;
/** @type {string} */
ObjectSubscriptionId;
/** @type {string} */
ObjectHash;
/** @type {string} */
OwnerContactId;
}
export class UpdateCustomerGroup {
/** @param {{CustomerGroupId?:string,AutoGenerateName?:boolean,CustomerName?:string,Contacts?:Contact[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
CustomerGroupId;
/** @type {boolean} */
AutoGenerateName;
/** @type {string} */
CustomerName;
/** @type {Contact[]} */
Contacts;
}
JavaScript UpdateCustomerGroup 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/updatecustomergroup HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
AutoGenerateName: False,
CustomerName: String,
Contacts:
[
{
PrimaryStreetAddressId: 00000000000000000000000000000000,
PrimaryPostalAddressId: 00000000000000000000000000000000,
PrimaryTaxRegisteredAddressId: 00000000000000000000000000000000,
PrimaryNonMobileId: 00000000000000000000000000000000,
PrimaryMobileId: 00000000000000000000000000000000,
PrimaryEmailId: 00000000000000000000000000000000,
Mobile: String,
Phone: String,
PrimaryEmail: String,
PrimaryAddress: String,
PrimaryFaxId: 00000000000000000000000000000000,
PrimaryWebId: 00000000000000000000000000000000,
PrimarySocialMediaId: 00000000000000000000000000000000,
FirstName: String,
MiddleName: String,
Surname: String,
FullName: String,
ShortName: String,
BirthDate: 0001-01-01,
Title: String,
Salutation: String,
MaritalStatus: 00000000000000000000000000000000,
MaritalStatusName: String,
Gender: 00000000000000000000000000000000,
GenderName: String,
Abn: String,
Acn: String,
Arbn: String,
ContactBankingDetails:
{
BankName: String,
BankLocation: String,
Bsb: String,
AccountNumber: String,
AccountName: String,
TermOfTradeId: 00000000000000000000000000000000,
TermOfTradeName: String,
RecordStatus: String
},
LegalName: String,
TradingName: String,
ContactType: 00000000000000000000000000000000,
ContactTypeName: String,
ContactTypePhotoUrl: String,
ContactTypePhotoThumbnailUrl: String,
Timezone: 00000000000000000000000000000000,
TimezoneName: String,
Description: String,
EmploymentIndustry: String,
EmploymentRole: String,
EmploymentGeographicArea: String,
GstRegistered: False,
DriversLicence: String,
ContactGroupIdStaff: 00000000000000000000000000000000,
StaffGroupName: String,
ContactGroupIdVendor: 00000000000000000000000000000000,
VendorGroupName: String,
ContactGroupIdCustomer: 00000000000000000000000000000000,
CustomerGroupName: String,
PrimaryMediaFileId: 00000000000000000000000000000000,
ProfilePhotoUrl: String,
ProfilePhotoThumbnailUrl: String,
RecordStatus: String,
SubscriptionAlternateKey: String,
ContactRoles:
[
{
RoleName: String,
StartDate: 0001-01-01,
EndDate: 0001-01-01,
IsLicenseeRole: False,
IsCustomerRole: False,
IsPlatformRole: False,
IsAdministerContactsRole: False,
RolePrimaryImageURL: String,
RolePrimaryImageThumbnailURL: String,
ConnectionStatusName: String
}
],
ContactDetails:
[
{
ContactMethodName: String,
Address:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
StateNameShort: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
Timezone: 00000000000000000000000000000000,
TimezoneName: 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,
PostalDeliveryTypeId: 00000000000000000000000000000000,
Latitude: 0,
Longitude: 0,
Accuracy: 0,
DistanceAway: 0,
AutoMapCoordinates: False,
IsAddressCleared: False,
IsValidated: False,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String,
AddressFull: "String
String
String
String String
String"
},
Phone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String,
PhoneNumber: String String String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsAddress: True,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiKey: String,
FrameworkAlternateKey: String
}
],
CustomContent:
[
{
FieldName: String,
FieldValue: String,
AlternateKey: String
}
],
ConnectedContacts:
[
{
PrimaryStreetAddressId: 00000000000000000000000000000000,
PrimaryPostalAddressId: 00000000000000000000000000000000,
PrimaryTaxRegisteredAddressId: 00000000000000000000000000000000,
PrimaryNonMobileId: 00000000000000000000000000000000,
PrimaryMobileId: 00000000000000000000000000000000,
PrimaryEmailId: 00000000000000000000000000000000,
Mobile: String,
Phone: String,
PrimaryEmail: String,
PrimaryAddress: String,
PrimaryFaxId: 00000000000000000000000000000000,
PrimaryWebId: 00000000000000000000000000000000,
PrimarySocialMediaId: 00000000000000000000000000000000,
FirstName: String,
MiddleName: String,
Surname: String,
FullName: String,
ShortName: String,
BirthDate: 0001-01-01,
Title: String,
Salutation: String,
MaritalStatus: 00000000000000000000000000000000,
MaritalStatusName: String,
Gender: 00000000000000000000000000000000,
GenderName: String,
Abn: String,
Acn: String,
Arbn: String,
ContactBankingDetails:
{
BankName: String,
BankLocation: String,
Bsb: String,
AccountNumber: String,
AccountName: String,
TermOfTradeId: 00000000000000000000000000000000,
TermOfTradeName: String,
RecordStatus: String
},
LegalName: String,
TradingName: String,
ContactType: 00000000000000000000000000000000,
ContactTypeName: String,
ContactTypePhotoUrl: String,
ContactTypePhotoThumbnailUrl: String,
Timezone: 00000000000000000000000000000000,
TimezoneName: String,
Description: String,
EmploymentIndustry: String,
EmploymentRole: String,
EmploymentGeographicArea: String,
GstRegistered: False,
DriversLicence: String,
ContactGroupIdStaff: 00000000000000000000000000000000,
StaffGroupName: String,
ContactGroupIdVendor: 00000000000000000000000000000000,
VendorGroupName: String,
ContactGroupIdCustomer: 00000000000000000000000000000000,
CustomerGroupName: String,
PrimaryMediaFileId: 00000000000000000000000000000000,
ProfilePhotoUrl: String,
ProfilePhotoThumbnailUrl: String,
RecordStatus: String,
SubscriptionAlternateKey: String,
ContactRoles:
[
{
RoleName: String,
StartDate: 0001-01-01,
EndDate: 0001-01-01,
IsLicenseeRole: False,
IsCustomerRole: False,
IsPlatformRole: False,
IsAdministerContactsRole: False,
RolePrimaryImageURL: String,
RolePrimaryImageThumbnailURL: String,
ConnectionStatusName: String
}
],
ContactDetails:
[
{
ContactMethodName: String,
Address:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
StateNameShort: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
Timezone: 00000000000000000000000000000000,
TimezoneName: 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,
PostalDeliveryTypeId: 00000000000000000000000000000000,
Latitude: 0,
Longitude: 0,
Accuracy: 0,
DistanceAway: 0,
AutoMapCoordinates: False,
IsAddressCleared: False,
IsValidated: False,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String,
AddressFull: "String
String
String
String String
String"
},
Phone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String,
PhoneNumber: String String String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsAddress: True,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiKey: String,
FrameworkAlternateKey: String
}
],
CustomContent:
[
{
FieldName: String,
FieldValue: String,
AlternateKey: String
}
],
ConnectedContacts:
[
{
PrimaryStreetAddressId: 00000000000000000000000000000000,
PrimaryPostalAddressId: 00000000000000000000000000000000,
PrimaryTaxRegisteredAddressId: 00000000000000000000000000000000,
PrimaryNonMobileId: 00000000000000000000000000000000,
PrimaryMobileId: 00000000000000000000000000000000,
PrimaryEmailId: 00000000000000000000000000000000,
Mobile: String,
Phone: String,
PrimaryEmail: String,
PrimaryAddress: String,
PrimaryFaxId: 00000000000000000000000000000000,
PrimaryWebId: 00000000000000000000000000000000,
PrimarySocialMediaId: 00000000000000000000000000000000,
FirstName: String,
MiddleName: String,
Surname: String,
FullName: String,
ShortName: String,
BirthDate: 0001-01-01,
Title: String,
Salutation: String,
MaritalStatus: 00000000000000000000000000000000,
MaritalStatusName: String,
Gender: 00000000000000000000000000000000,
GenderName: String,
Abn: String,
Acn: String,
Arbn: String,
ContactBankingDetails:
{
BankName: String,
BankLocation: String,
Bsb: String,
AccountNumber: String,
AccountName: String,
TermOfTradeId: 00000000000000000000000000000000,
TermOfTradeName: String,
RecordStatus: String
},
LegalName: String,
TradingName: String,
ContactType: 00000000000000000000000000000000,
ContactTypeName: String,
ContactTypePhotoUrl: String,
ContactTypePhotoThumbnailUrl: String,
Timezone: 00000000000000000000000000000000,
TimezoneName: String,
Description: String,
EmploymentIndustry: String,
EmploymentRole: String,
EmploymentGeographicArea: String,
GstRegistered: False,
DriversLicence: String,
ContactGroupIdStaff: 00000000000000000000000000000000,
StaffGroupName: String,
ContactGroupIdVendor: 00000000000000000000000000000000,
VendorGroupName: String,
ContactGroupIdCustomer: 00000000000000000000000000000000,
CustomerGroupName: String,
PrimaryMediaFileId: 00000000000000000000000000000000,
ProfilePhotoUrl: String,
ProfilePhotoThumbnailUrl: String,
RecordStatus: String,
SubscriptionAlternateKey: String,
ContactRoles:
[
{
RoleName: String,
StartDate: 0001-01-01,
EndDate: 0001-01-01,
IsLicenseeRole: False,
IsCustomerRole: False,
IsPlatformRole: False,
IsAdministerContactsRole: False,
RolePrimaryImageURL: String,
RolePrimaryImageThumbnailURL: String,
ConnectionStatusName: String
}
],
ContactDetails:
[
{
ContactMethodName: String,
Address:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
StateNameShort: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
Timezone: 00000000000000000000000000000000,
TimezoneName: 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,
PostalDeliveryTypeId: 00000000000000000000000000000000,
Latitude: 0,
Longitude: 0,
Accuracy: 0,
DistanceAway: 0,
AutoMapCoordinates: False,
IsAddressCleared: False,
IsValidated: False,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String,
AddressFull: "String
String
String
String String
String"
},
Phone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String,
PhoneNumber: String String String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsAddress: True,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiKey: String,
FrameworkAlternateKey: String
}
],
CustomContent:
[
{
FieldName: String,
FieldValue: String,
AlternateKey: String
}
],
CustomContentXML: String,
ContactDetailsXML: String,
ConnectionContactName: String,
UserProfileIdDefault: 00000000000000000000000000000000,
Username: String,
IsRegistered: False,
ESL: False,
Language: String,
InterpreterRequired: False,
LicenseeNotes: String,
Notes: String,
ObjectHash: String
}
],
CustomContentXML: String,
ContactDetailsXML: String,
ConnectionContactName: String,
UserProfileIdDefault: 00000000000000000000000000000000,
Username: String,
IsRegistered: False,
ESL: False,
Language: String,
InterpreterRequired: False,
LicenseeNotes: String,
Notes: String,
ObjectHash: String
}
],
CustomContentXML: String,
ContactDetailsXML: String,
ConnectionContactName: String,
UserProfileIdDefault: 00000000000000000000000000000000,
Username: String,
IsRegistered: False,
ESL: False,
Language: String,
InterpreterRequired: False,
LicenseeNotes: String,
Notes: String,
ObjectHash: String
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Result: String
}