Platform API

AddOrUpdateUserProfile

Updates a Users Profile information'

The following routes are available for this service:
PUT	/api/profiles/{UserProfileId}
POST	/api/profiles

**AddOrUpdateUserProfile** Parameters:
Name	Parameter	Data Type	Required	Description
UserProfileId	path	Guid	No
UserProfile	body	UserProfileModel	No

**UserProfileModel** Parameters:
Name	Parameter	Data Type	Required	Description
BirthDate	query	DateTime?	No	Contact Date of Birth (when person type)
MaritalStatusName	query	string	No	Contact marital status (when person type)
GenderName	query	string	No	Contact gender (when person type)
GenderId	query	Guid	No	The Gender Guid of the contact.
ContactDetails	query	List<ContactDetailModel>	No	All contact details of the contact
PrimaryStreetAddress	form	ContactDetail	No	Primary Street Address
PrimaryPostalAddress	form	ContactDetail	No	Primary Postal Address
PrimaryRegisteredAddress	form	ContactDetail	No	Primary Registered Address
PrimaryEmail	form	ContactDetail	No	Primary Email Address
PrimaryMobile	form	ContactDetail	No	Primary Mobile Number
PrimaryPhone	form	ContactDetail	No	Primary Non-Mobile Number
PrimaryFax	form	ContactDetail	No	Primary Fax Number
PrimaryWeb	form	ContactDetail	No	Primary Web Address
SocialMediaTwitter	form	ContactDetail	No	Social Media Twitter
SocialMediaFacebook	form	ContactDetail	No	Social Media Facebook
SocialMediaInstagram	form	ContactDetail	No	Social Media Instagram
IsRemovedContact	form	bool	No	Have all connections to the contact been removed?
IsDefault	query	bool	No	True if this is the users default profile.
IsEmailEditable	query	bool	No	True if the users email on this profile can be edited.
PrimaryImageContent	form	string	No	Primary image Content sent as a file stream contents (if not attached to the request)
PrimaryImageContentType	form	string	No	Primary image Content type sent as a file stream contents (if not attached to the request)
PrimaryImageFileName	form	string	No	Primary image file name

**UserProfileSummaryModel** Parameters:
Name	Parameter	Data Type	Required	Description
UserProfileId	form	Guid	No	User Profile Id
UserId	form	Guid	No	User linked to the profile
ContactId	form	Guid	No	Contact linked to the profile
UserName	form	string	No	User linked to the profile
ProfileName	form	string	No	User Profile Name
ContactFullName	form	string	No	Full name of the contact linked to the profile
EmailAddress	form	string	No	Email Address of the contact linked to the profile
EmailSignature	form	string	No	Email signature of the contact linked to the profile
MobileNumber	form	string	No	Mobile number of the contact linked to the profile
PhoneNumber	form	string	No	Phone number of the contact linked to the profile
ContactTypeId	form	string	No	Type of contact (person, organisation etc.) linked to the profile
ContactTypeName	form	string	No	Type of contact (person, organisation etc.) linked to the profile
FirstName	form	string	No	First name of the contact linked to the profile
Surname	form	string	No	Surname of the contact linked to the profile
Title	form	string	No	Title of contact linked to the profile
LegalName	form	string	No	Legal name of contact linked to the profile
TradingName	form	string	No	Trading name of contact linked to the profile
Abn	query	string	No	Australian Business Number
Acn	query	string	No	Australian Company Number
Arbn	query	string	No	Australian Registered Body Number
GstRegistered	query	bool	No	Indicates if the Contact is registered for GST.
ESL	query	bool	No	True if english is a secondary language for the contact.
Language	query	string	No	Language that is the primary language for the contact.
InterpreterRequired	query	bool	No	True if an interpreter is required.
LicenseeNotes	query	string	No	Licensee specific notes about the contact.
ProfilePhotoUrl	form	string	No	Profile photo of contact linked to the profile
ProfilePhotoThumbnailUrl	form	string	No	Thumbnail photo of contact linked to the profile
ProfileImageId	form	Guid	No	Profile photo id of contact linked to the profile
Description	form	string	No	Profile description
EmploymentIndustry	form	string	No	Employment Industry
EmploymentRole	form	string	No	Employment Role
EmploymentGeographicArea	form	string	No	Areas of Work
Timezone	query	Guid	No	The contacts timezone.
TimezoneName	query	string	No	Timezone Name
PrimaryAddress	query	string	No	The primary address of the contact
IsActiveContact	form	bool	No	Is this an active contact? Or an inactive contact (deleted account)?

**ContactDetailModel** Parameters:
Name	Parameter	Data Type	Required	Description
ContactMethodId	body	Guid	No	Id of the Contact Method
ContactMethodName	body	string	No	Contact Method Name
ContactAddress	body	ContactAddressModel	No	If the contact method is an address, this will contain the address details.
ContactPhone	body	PhoneModel	No	If the contact method is a phone, this will contain the phone details
CountryId	body	Guid?	No	Id of the country
ContactDetails	body	string	No	A summary string representing the contact details
Notes	body	string	No	Notes about the contact details
ContactDetailsCode	body	string	No	Area Code if contact details are a phone number
OrderContactMethod	body	int	No	Order number of the contact method
IsPrimaryContactMethod	body	bool	No	True if this is the primary contact method
IsAddress	body	bool	No	True if this contact method is an address

**ContactAddressModel** Parameters:
Name	Parameter	Data Type	Required	Description
Address	body	AddressModel	No	Address Details
IsPostal	body	bool	No	True if this is a postal address.
IsPrimaryLocation	body	bool	No	True if this is the primary address.
IsRegisteredLocation	body	bool	No	True if this address is the registered tax address.
SuburbName	body	string	No	Suburb Name
StateName	body	string	No	State Name
CountryName	body	string	No	Country Name

**AddressModel** Parameters:
Name	Parameter	Data Type	Required	Description
DistanceAway	body	double	No	The distance between this project and another specified set of gps coordinates.
Latitude	body	Double?	No	The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
Longitude	body	Double?	No	The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
AddressFormatId	body	Guid	No	Address Format Id Guid - this will be determined by the service.
SuburbId	body	Guid	No	Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered.
SuburbName	body	string	No	The suburb name.
StateShortName	body	string	No	The shortened State Name e.g Vic for Victoria.
PostCode	body	string	No	The suburb postcode.
CountryId	body	Guid	No	Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.
CountryName	body	string	No	the name of the country the address is within.
ISOCountryCode	query	string	No	ISO Country Code.
LotNumber	body	string	No	The address Lot number.
SubUnit	body	string	No	The address Sub Unit number.
BuildingNumber	body	string	No	The address building number.
StreetNumber	body	string	No	The address street number.
StreetName	body	string	No	The address street name including street type.
AddressLineOne	body	string	No	A formatted address Line 1.
AddressLineTwo	body	string	No	A formatted address Line 2.
AddressFull	body	string	No	The full address string.
IsPhysical	body	bool?	No	True if the address is a physical location.
Notes	form	string	No	Notes about the address.
AutoMapCoordinates	body	bool?	No	If true, the address is eligible for having its coordinates calculated/updated.
LocationCoordinates	body	LocationCoordinates	No	Location Coordinates for the address.

**LocationCoordinatesModel** Parameters:
Name	Parameter	Data Type	Required	Description
Latitude	query	double	No	The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
Longitude	query	double	No	The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
Altitude	query	double?	No	The altitude of an address - the altitude above sea level."
Accuracy	query	double?	No	Accuracy of the latitude and longitude.
AltitudeAccuracy	query	double?	No	Accurancy of the Altitude.
Heading	query	double?	No	Direction you are heading.
Speed	query	double?	No	Speed you are going.
VerticalSpeed	query	double?	No	Speed your altitude is ascending/descending at.

**PhoneModel** Parameters:
Name	Parameter	Data Type	Required	Description
CountryCode	body	string	No	Country Code
AreaCode	body	string	No	Area Code
LocalNumber	body	string	No	Local Number

**ContactDetailModel** Parameters:
Name	Parameter	Data Type	Required	Description
ContactMethodId	query	Guid	No	Contact Method Id
ContactMethodName	query	string	No	Contact Method Name
ContactAddress	query	ContactAddressModel	No	Contact Address Details
ContactPhone	query	PhoneModel	No	Contact Phone Details
CountryId	query	Guid	No	Country id
ContactDetails	query	string	No	Contact Details
Notes	query	string	No	Notes
ContactDetailsCode	query	string	No	Contact Details Code
OrderContactMethod	query	int	No	Order of Contact Method Id
IsPrimaryContactMethod	query	bool	No	Contact Method Id
IsAddress	query	bool	No	Is contact details an address
ContactContactDetailId	query	Guid	No	Contact Contact Detail Id
ContactId	query	Guid	No	Contact Id
ContactDetailId	query	Guid	No	Contact Details Id
IsPrimaryLocation	query	bool	No	Is contact details a primary location
IsRegisteredLocation	query	bool	No	Is contact details a registered location
IsPostal	query	bool	No	Is contact details a postal address
IsPhone	query	bool	No	Is contact details a phone number
EmailSignatureId	query	Guid	No	Email Signature Id
EmailSignatureHTML	query	string	No	Email Signature HTML
EmailSignatureText	query	string	No	Email Signature Text
ApiFrameworkAlternateKey	query	string	No	API Key from Framework

**ContactAddressModel** Parameters:
Name	Parameter	Data Type	Required	Description
Location	query	GeoLocationModel	No	Location Details.
IsPostal	query	bool	No	Is address postal.
IsPrimaryLocation	query	bool	No	Is address primary.
IsRegisteredLocation	query	bool	No	Is address registered.
ContactAddressId	query	Guid	No	Contact Address Id.
SuburbName	query	string	No	Contact Address Suburb Name.
StateName	query	string	No	Contact Address Street Name.
CountryName	query	string	No	Contact Country Name.

**GeoLocationModel** Parameters:
Name	Parameter	Data Type	Required	Description
GeoLocationId	query	Guid	No	The location id
StateId	query	Guid	No	The state id
StateName	query	string	No	The state name
SuburbId	query	Guid	No	The suburb id
SuburbName	query	string	No	The suburb name
CountryId	query	Guid	No	The country id
CountryName	query	string	No	The country name
LotNumber	query	string	No	The lot number
SubUnit	query	string	No	The unit number
BuildingNumber	query	string	No	The building number
PostalDeliveryNumber	query	string	No	PO Box Number
StreetNumber	query	string	No	The Street Number
StreetName	query	string	No	The Street name
AddressLineOne	query	string	No	Address Line ONe
AddressLineTwo	query	string	No	Address Line Two
PostCode	query	string	No	Post code
IsPhysical	query	bool	No	Is location physical
Notes	query	string	No	Notes about the location
AddressFull	query	string	No	The address in full
AddressFormatId	query	Guid	No	Address format id.
Latitude	query	double	No	Latitude
Longitude	query	double	No	Longitude
Timezone	query	Guid?	No	Timezone Id
Estate	form	GeoEstateModel	No
GeoEstateId	form	Guid	No
GeoEstateStageId	form	Guid	No
GeoEstateStageName	form	string	No
IgnoreValidation	form	bool	No

**GeoEstateModel** Parameters:
Name	Parameter	Data Type	Required
GeoEstateId	form	Guid	No
Name	form	string	No
Notes	form	string	No
DeveloperContactId	form	Guid	No
DeveloperName	form	string	No
DeveloperProfilePhotoUrl	form	string	No
DeveloperProfilePhotoThumbnail	form	string	No
RecordStatus	form	string	No
Stages	form	List<GeoEstateStageModel>	No
CurrentEstateStageId	form	Guid	No
CurrentEstateStageName	form	string	No

**GeoEstateStageModel** Parameters:
Name	Parameter	Data Type	Required
GeoEstateStageId	form	Guid	No
GeoEstateId	form	Guid	No
Name	form	string	No
Notes	form	string	No
RecordStatus	form	string	No

**PhoneModel** Parameters:
Name	Parameter	Data Type	Required	Description
CountryCode	query	string	No	Phone Country Code.
AreaCode	query	string	No	Phone Area Code.
LocalNumber	query	string	No	Phone Local Number.

**AddOrUpdateUserProfileResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Errors	form	List<ResponseError>	No
UserProfileId	query	Guid	No	Guid representing the object that is the User Profile Id in Eros.
ResponseStatus	query	ResponseStatus	No	Service Stack Response Status.

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/profiles HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	UserProfile: 
	{
		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
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Errors: 
	[
		{
			ErrorCode: String,
			FieldName: String,
			Message: String,
			Meta: 
			{
				String: String
			}
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}