Platform Subscription API

SaveContact

Inserts or Updates a contact and its details and roles.

**SaveContact** Parameters:
Name	Parameter	Data Type	Required	Description
SuiteDataSourceInstanceId	query	Guid	Yes	Guid representing the external systems datasource information.
AlternateKey	query	string	Yes	The unique key that represents the contact on the external system.
ObjectId	query	Guid	No	Guid of the contact object within Eros. If ObjectId is known, the external system may pass this instead of the alternate key.
IgnoreHash	query	bool	No	If set to true, the object will be updated/refreshed. If false, the hash representation of the Contact model and its data will be compared with the current Contact to determine if there are any changes to save.
IgnoreValidation	query	bool	No
MarkAsDeleted	query	bool	No	Set this to be true if the contact is to be deleted
Contact	query	SubscriptionContactModel	Yes	Object containing all details of the contact to be inserted or updated.
LicenseeId	query	Guid	No
SessionId	query	Guid	No

**ValidationErrorList** Parameters:
Name	Parameter	Data Type	Required	Description
ValidationErrors	form	List<RuleValidationResult>	No

**RuleValidationResult** Parameters:
Name	Parameter	Data Type	Required
RuleCode	form	string	No
Message	form	string	No
Key	form	string	No
Tag	form	string	No
ErrorCode	form	string	No

**SubscriptionContactModel** Parameters:
Name	Parameter	Data Type	Required	Description
ContactId	query	Guid	No	Guid of the contact object within Eros.
ContactType	query	Guid	Yes	Guid of the Contact Type List Item object within Eros.
MaritalStatus	query	Guid?	No	Guid of the Marital Status List Item object within Eros.
Gender	query	Guid?	No	Guid of the Gender List Item object within Eros.
FirstName	query	string	No	The first given name for the contact. Applies to a person contact type.
MiddleName	query	string	No	The middle name(s) for the contact. Applies to a person contact type.
Surname	query	string	No	The surname for the contact. Applies to a person contact type.
FullName	query	string	No	The full name for the contact.
ShortName	query	string	No	A short name for the contact.
BirthDate	query	DateTime?	No	The birth date for the contact. Applies to a person contact type.
Title	query	string	No	The title for the contact. Applies to a person contact type.
Salutation	query	string	No	A salutation for the contact.
Abn	query	string	No	The A.B.N for the contact.
Acn	query	string	No	The A.C.N for the contact.
Arbn	query	string	No	The A.R.B.N for the contact.
TradingName	query	string	No	A trading name for the contact.
LegalName	query	string	No	A legal name for the contact.
Notes	query	string	No	Any notes/description for the contact.
EmploymentIndustry	query	string	No	Contact Employment Industry.
EmploymentRole	query	string	No	Contact Employment Role.
EmploymentGeographicArea	query	string	No	Contact Employment Geographic Area.
DriversLicence	query	string	No	The Contacts Drivers Licence Number
GstRegistered	query	bool	No	Indicates if the Contact is registered for GST
RecordStatus	query	string	No	The status of the contact in EROS
ContactRoles	query	List<ContactRole>	Yes	A list of roles this contact has.
ContactDetails	query	List<ContactDetailModel>	Yes	A list of the contact details for the contact.
CustomContentXML	query	string	No	Custom Content XML for the contact.
BlobImageURLPrimary	form	string	No
BlobImageURLPrimaryThumbnail	form	string	No
PrimaryMobile	query	string	No	The primary mobile for the contact.
PrimaryEmail	query	string	No	The primary email for the contact.

**ContactRole** Parameters:
Name	Parameter	Data Type	Required	Description
RoleId	query	Guid	Yes	Guid of the Role List Item object within Eros.
AlternateKey	query	string	No	The unique key that represents the role type on the external system.

**ContactDetailModel** Parameters:
Name	Parameter	Data Type	Required
ContactMethodId	form	Guid	No
ContactMethodName	form	string	No
ContactAddress	form	ContactAddressModel	No
ContactPhone	form	PhoneModel	No
CountryId	form	Guid?	No
ContactDetails	form	string	No
Notes	form	string	No
ContactDetailsCode	form	string	No
OrderContactMethod	form	int	No
IsPrimaryContactMethod	form	bool	No
IsAddress	form	bool	No

**ContactAddressModel** Parameters:
Name	Parameter	Data Type	Required
Address	form	AddressModel	No
IsPostal	form	bool	No
IsPrimaryLocation	form	bool	No
IsRegisteredLocation	form	bool	No
SuburbName	form	string	No
StateName	form	string	No
CountryName	form	string	No

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

**LocationCoordinatesModel** Parameters:
Name	Parameter	Data Type	Required	Description
Latitude	query	Double?	Yes	The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
Longitude	query	Double?	Yes	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
CountryCode	form	string	No
AreaCode	form	string	No
LocalNumber	form	string	No

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 /jsv/reply/SaveContact HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AlternateKey: String,
	IgnoreHash: False,
	IgnoreValidation: False,
	MarkAsDeleted: False,
	Contact: 
	{
		MaritalStatus: 00000000-0000-0000-0000-000000000000,
		Gender: 00000000-0000-0000-0000-000000000000,
		FirstName: String,
		MiddleName: String,
		Surname: String,
		FullName: String,
		ShortName: String,
		BirthDate: 0001-01-01,
		Title: String,
		Salutation: String,
		Abn: String,
		Acn: String,
		Arbn: String,
		TradingName: String,
		LegalName: String,
		Notes: String,
		EmploymentIndustry: String,
		EmploymentRole: String,
		EmploymentGeographicArea: String,
		DriversLicence: String,
		GstRegistered: False,
		RecordStatus: String,
		ContactRoles: 
		[
			{
				AlternateKey: String
			}
		],
		ContactDetails: 
		[
			{
				ContactMethodName: String,
				ContactAddress: 
				{
					Address: 
					{
						DistanceAway: 0,
						Latitude: 0,
						Longitude: 0,
						SuburbName: String,
						StateShortName: String,
						PostCode: String,
						CountryName: String,
						ISOCountryCode: String,
						LotNumber: String,
						SubUnit: String,
						BuildingNumber: String,
						StreetNumber: String,
						StreetName: String,
						AddressLineOne: String,
						AddressLineTwo: String,
						AddressFull: String,
						IsPhysical: False,
						Notes: String,
						AutoMapCoordinates: False,
						LocationCoordinates: 
						{
							Latitude: 0,
							Longitude: 0,
							Altitude: 0,
							Accuracy: 0,
							AltitudeAccuracy: 0,
							Heading: 0,
							Speed: 0,
							VerticalSpeed: 0
						}
					},
					IsPostal: False,
					IsPrimaryLocation: False,
					IsRegisteredLocation: False,
					SuburbName: String,
					StateName: String,
					CountryName: String
				},
				ContactPhone: 
				{
					CountryCode: String,
					AreaCode: String,
					LocalNumber: String
				},
				CountryId: 00000000-0000-0000-0000-000000000000,
				ContactDetails: String,
				Notes: String,
				ContactDetailsCode: String,
				OrderContactMethod: 0,
				IsPrimaryContactMethod: False,
				IsAddress: True
			}
		],
		CustomContentXML: String,
		BlobImageURLPrimary: String,
		BlobImageURLPrimaryThumbnail: String,
		PrimaryMobile: String,
		PrimaryEmail: String
	},
	ValidationErrors: 
	[
		{
			RuleCode: String,
			Message: String,
			Key: String,
			Tag: String,
			ErrorCode: String
		}
	]
}

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

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