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
}
]
}