export class RuleValidationResult
{
public RuleCode: string;
public Message: string;
public Key: string;
public Tag: string;
public ErrorCode: string;
public constructor(init?: Partial<RuleValidationResult>) { (Object as any).assign(this, init); }
}
export class ValidationErrorList
{
public ValidationErrors: RuleValidationResult[];
public constructor(init?: Partial<ValidationErrorList>) { (Object as any).assign(this, init); }
}
export class ContactRole
{
/** @description Guid of the Role List Item object within Eros. */
// @ApiMember(DataType="Guid", Description="Guid of the Role List Item object within Eros.", IsRequired=true, Name="RoleId", ParameterType="query")
public RoleId: string;
/** @description The unique key that represents the role type on the external system. */
// @ApiMember(DataType="string", Description="The unique key that represents the role type on the external system.", Name="AlternateKey", ParameterType="query")
public AlternateKey: string;
public constructor(init?: Partial<ContactRole>) { (Object as any).assign(this, init); }
}
export class LocationCoordinatesModel
{
/** @description The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface. */
// @ApiMember(DataType="Double?", Description="The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.", IsRequired=true, Name="Latitude", ParameterType="query")
public Latitude: number;
/** @description The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface. */
// @ApiMember(DataType="Double?", Description="The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.", IsRequired=true, Name="Longitude", ParameterType="query")
public Longitude: number;
/** @description The altitude of an address - the altitude above sea level. */
// @ApiMember(DataType="Double?", Description="The altitude of an address - the altitude above sea level.", Name="Altitude", ParameterType="query")
public Altitude?: number;
/** @description Accuracy of the latitude and longitude. */
// @ApiMember(DataType="Double?", Description="Accuracy of the latitude and longitude.", Name="Accuracy", ParameterType="query")
public Accuracy?: number;
/** @description Accurancy of the Altitude. */
// @ApiMember(DataType="Double?", Description="Accurancy of the Altitude.", Name="AltitudeAccuracy", ParameterType="query")
public AltitudeAccuracy?: number;
/** @description Direction you are heading. */
// @ApiMember(DataType="Double?", Description="Direction you are heading.", Name="Heading", ParameterType="query")
public Heading?: number;
/** @description Speed you are going. */
// @ApiMember(DataType="Double?", Description="Speed you are going.", Name="Speed", ParameterType="query")
public Speed?: number;
/** @description Speed your altitude is ascending/descending at. */
// @ApiMember(DataType="Double?", Description="Speed your altitude is ascending/descending at.", Name="VerticalSpeed", ParameterType="query")
public VerticalSpeed?: number;
public constructor(init?: Partial<LocationCoordinatesModel>) { (Object as any).assign(this, init); }
}
export class AddressModel
{
/** @description The distance between this project and another specified set of gps coordinates. */
// @ApiMember(DataType="double", Description="The distance between this project and another specified set of gps coordinates.", Name="DistanceAway", ParameterType="query")
public DistanceAway: number;
/** @description The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface. */
// @ApiMember(DataType="Double?", Description="The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.", IsRequired=true, Name="Latitude", ParameterType="query")
public Latitude: number;
/** @description The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface. */
// @ApiMember(DataType="Double?", Description="The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.", IsRequired=true, Name="Longitude", ParameterType="query")
public Longitude: number;
/** @description Address Format Id Guid - this will be determined by the service. */
// @ApiMember(DataType="Guid", Description="Address Format Id Guid - this will be determined by the service.", Name="AddressFormatId", ParameterType="query")
public AddressFormatId: string;
/** @description Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered. */
// @ApiMember(DataType="Guid", Description="Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered.", Name="SuburbId", ParameterType="query")
public SuburbId: string;
/** @description The suburb name. */
// @ApiMember(DataType="string", Description="The suburb name.", Name="SuburbName", ParameterType="query")
public SuburbName: string;
/** @description The shortened State Name e.g Vic for Victoria. */
// @ApiMember(DataType="string", Description="The shortened State Name e.g Vic for Victoria.", Name="StateShortName", ParameterType="query")
public StateShortName: string;
/** @description The suburb postcode. */
// @ApiMember(DataType="string", Description="The suburb postcode.", Name="PostCode", ParameterType="query")
public PostCode: string;
/** @description Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered. */
// @ApiMember(DataType="Guid", Description="Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.", Name="CountryId", ParameterType="query")
public CountryId: string;
/** @description the name of the country the address is within. */
// @ApiMember(DataType="string", Description="the name of the country the address is within.", Name="CountryName", ParameterType="query")
public CountryName: string;
/** @description A 2 digit ISO Country Code representing the country. */
// @ApiMember(DataType="string", Description="A 2 digit ISO Country Code representing the country.", Name="ISOCountryCode", ParameterType="query")
public ISOCountryCode: string;
/** @description The address Lot number. */
// @ApiMember(DataType="string", Description="The address Lot number.", Name="LotNumber", ParameterType="query")
public LotNumber: string;
/** @description The address Sub Unit number. */
// @ApiMember(DataType="string", Description="The address Sub Unit number.", Name="SubUnit", ParameterType="query")
public SubUnit: string;
/** @description The address building number. */
// @ApiMember(DataType="string", Description="The address building number.", Name="BuildingNumber", ParameterType="query")
public BuildingNumber: string;
/** @description The address street number. */
// @ApiMember(DataType="string", Description="The address street number.", Name="StreetNumber", ParameterType="query")
public StreetNumber: string;
/** @description The address street name including street type. */
// @ApiMember(DataType="string", Description="The address street name including street type.", Name="StreetName", ParameterType="query")
public StreetName: string;
/** @description A formatted address Line 1. */
// @ApiMember(DataType="string", Description="A formatted address Line 1.", Name="AddressLineOne", ParameterType="query")
public AddressLineOne: string;
/** @description A formatted address Line 2. */
// @ApiMember(DataType="string", Description="A formatted address Line 2.", Name="AddressLineTwo", ParameterType="query")
public AddressLineTwo: string;
/** @description The full address string. */
// @ApiMember(DataType="string", Description="The full address string.", Name="AddressFull", ParameterType="query")
public AddressFull: string;
/** @description True if the address is a physical location. */
// @ApiMember(DataType="bool?", Description="True if the address is a physical location.", Name="IsPhysical", ParameterType="query")
public IsPhysical?: boolean;
/** @description Notes about the address. */
// @ApiMember(DataType="string", Description="Notes about the address.", Name="Notes", ParameterType="query")
public Notes: string;
/** @description If true, the address is eligible for having its coordinates calculated/updated. */
// @ApiMember(DataType="bool?", Description="If true, the address is eligible for having its coordinates calculated/updated.", Name="AutoMapCoordinates", ParameterType="query")
public AutoMapCoordinates?: boolean;
/** @description Location Coordinates for the address. */
// @ApiMember(DataType="LocationCoordinates", Description="Location Coordinates for the address.", Name="LocationCoordinates", ParameterType="query")
public LocationCoordinates: LocationCoordinatesModel;
public constructor(init?: Partial<AddressModel>) { (Object as any).assign(this, init); }
}
export class ContactAddressModel
{
public Address: AddressModel;
public IsPostal: boolean;
public IsPrimaryLocation: boolean;
public IsRegisteredLocation: boolean;
public SuburbName: string;
public StateName: string;
public CountryName: string;
public constructor(init?: Partial<ContactAddressModel>) { (Object as any).assign(this, init); }
}
export class PhoneModel
{
public CountryCode: string;
public AreaCode: string;
public LocalNumber: string;
public constructor(init?: Partial<PhoneModel>) { (Object as any).assign(this, init); }
}
export class ContactDetailModel
{
public ContactMethodId: string;
public ContactMethodName: string;
public ContactAddress: ContactAddressModel;
public ContactPhone: PhoneModel;
public CountryId?: string;
public ContactDetails: string;
public Notes: string;
public ContactDetailsCode: string;
public OrderContactMethod: number;
public IsPrimaryContactMethod: boolean;
public IsAddress: boolean;
public constructor(init?: Partial<ContactDetailModel>) { (Object as any).assign(this, init); }
}
export class SubscriptionContactModel
{
/** @description Guid of the contact object within Eros. */
// @ApiMember(DataType="Guid", Description="Guid of the contact object within Eros.", Name="ContactId", ParameterType="query")
public ContactId: string;
/** @description Guid of the Contact Type List Item object within Eros. */
// @ApiMember(DataType="Guid", Description="Guid of the Contact Type List Item object within Eros.", IsRequired=true, Name="ContactType", ParameterType="query")
public ContactType: string;
/** @description Guid of the Marital Status List Item object within Eros. */
// @ApiMember(DataType="Guid?", Description="Guid of the Marital Status List Item object within Eros.", Name="MaritalStatus", ParameterType="query")
public MaritalStatus?: string;
/** @description Guid of the Gender List Item object within Eros. */
// @ApiMember(DataType="Guid?", Description="Guid of the Gender List Item object within Eros.", Name="Gender", ParameterType="query")
public Gender?: string;
/** @description The first given name for the contact. Applies to a person contact type. */
// @ApiMember(DataType="string", Description="The first given name for the contact. Applies to a person contact type.", Name="FirstName", ParameterType="query")
public FirstName: string;
/** @description The middle name(s) for the contact. Applies to a person contact type. */
// @ApiMember(DataType="string", Description="The middle name(s) for the contact. Applies to a person contact type.", Name="MiddleName", ParameterType="query")
public MiddleName: string;
/** @description The surname for the contact. Applies to a person contact type. */
// @ApiMember(DataType="string", Description="The surname for the contact. Applies to a person contact type.", Name="Surname", ParameterType="query")
public Surname: string;
/** @description The full name for the contact. */
// @ApiMember(DataType="string", Description="The full name for the contact.", Name="FullName", ParameterType="query")
public FullName: string;
/** @description A short name for the contact. */
// @ApiMember(DataType="string", Description="A short name for the contact.", Name="ShortName", ParameterType="query")
public ShortName: string;
/** @description The birth date for the contact. Applies to a person contact type. */
// @ApiMember(DataType="DateTime?", Description="The birth date for the contact. Applies to a person contact type.", Name="BirthDate", ParameterType="query")
public BirthDate?: string;
/** @description The title for the contact. Applies to a person contact type. */
// @ApiMember(DataType="string", Description="The title for the contact. Applies to a person contact type.", Name="Title", ParameterType="query")
public Title: string;
/** @description A salutation for the contact. */
// @ApiMember(DataType="string", Description="A salutation for the contact.", Name="Salutation", ParameterType="query")
public Salutation: string;
/** @description The A.B.N for the contact. */
// @ApiMember(DataType="string", Description="The A.B.N for the contact.", Name="Abn", ParameterType="query")
public Abn: string;
/** @description The A.C.N for the contact. */
// @ApiMember(DataType="string", Description="The A.C.N for the contact.", Name="Acn", ParameterType="query")
public Acn: string;
/** @description The A.R.B.N for the contact. */
// @ApiMember(DataType="string", Description="The A.R.B.N for the contact.", Name="Arbn", ParameterType="query")
public Arbn: string;
/** @description A trading name for the contact. */
// @ApiMember(DataType="string", Description="A trading name for the contact.", Name="TradingName", ParameterType="query")
public TradingName: string;
/** @description A legal name for the contact. */
// @ApiMember(DataType="string", Description="A legal name for the contact.", Name="LegalName", ParameterType="query")
public LegalName: string;
/** @description Any notes/description for the contact. */
// @ApiMember(DataType="string", Description="Any notes/description for the contact.", Name="Notes", ParameterType="query")
public Notes: string;
/** @description Contact Employment Industry. */
// @ApiMember(DataType="string", Description="Contact Employment Industry.", Name="EmploymentIndustry", ParameterType="query")
public EmploymentIndustry: string;
/** @description Contact Employment Role. */
// @ApiMember(DataType="string", Description="Contact Employment Role.", Name="EmploymentRole", ParameterType="query")
public EmploymentRole: string;
/** @description Contact Employment Geographic Area. */
// @ApiMember(DataType="string", Description="Contact Employment Geographic Area.", Name="EmploymentGeographicArea", ParameterType="query")
public EmploymentGeographicArea: string;
/** @description The Contacts Drivers Licence Number */
// @ApiMember(DataType="string", Description="The Contacts Drivers Licence Number", Name="DriversLicence", ParameterType="query")
public DriversLicence: string;
/** @description Indicates if the Contact is registered for GST */
// @ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST", Name="GstRegistered", ParameterType="query")
public GstRegistered: boolean;
/** @description The status of the contact in EROS */
// @ApiMember(DataType="string", Description="The status of the contact in EROS", Name="RecordStatus", ParameterType="query")
public RecordStatus: string;
/** @description A list of roles this contact has. */
// @ApiMember(DataType="List<ContactRole>", Description="A list of roles this contact has.", IsRequired=true, Name="ContactRoles", ParameterType="query")
public ContactRoles: ContactRole[] = [];
/** @description A list of the contact details for the contact. */
// @ApiMember(DataType="List<ContactDetailModel>", Description="A list of the contact details for the contact.", IsRequired=true, Name="ContactDetails", ParameterType="query")
public ContactDetails: ContactDetailModel[] = [];
/** @description Custom Content XML for the contact. */
// @ApiMember(DataType="string", Description="Custom Content XML for the contact.", Name="CustomContentXML", ParameterType="query")
public CustomContentXML: string;
public BlobImageURLPrimary: string;
public BlobImageURLPrimaryThumbnail: string;
/** @description The primary mobile for the contact. */
// @ApiMember(DataType="string", Description="The primary mobile for the contact.", Name="PrimaryMobile", ParameterType="query")
public PrimaryMobile: string;
/** @description The primary email for the contact. */
// @ApiMember(DataType="string", Description="The primary email for the contact.", Name="PrimaryEmail", ParameterType="query")
public PrimaryEmail: string;
public constructor(init?: Partial<SubscriptionContactModel>) { (Object as any).assign(this, init); }
}
/** @description Inserts or Updates a contact and its details and roles. */
// @Api(Description="Inserts or Updates a contact and its details and roles.")
export class SaveContact extends ValidationErrorList implements ISubscription
{
/** @description Guid representing the external systems datasource information. */
// @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")
public SuiteDataSourceInstanceId: string;
/** @description The unique key that represents the contact on the external system. */
// @ApiMember(DataType="string", Description="The unique key that represents the contact on the external system.", IsRequired=true, Name="AlternateKey", ParameterType="query")
public AlternateKey: string;
/** @description Guid of the contact object within Eros. If ObjectId is known, the external system may pass this instead of the alternate key. */
// @ApiMember(DataType="Guid", Description="Guid of the contact object within Eros. If ObjectId is known, the external system may pass this instead of the alternate key.", Name="ObjectId", ParameterType="query")
public ObjectId: string;
/** @description 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. */
// @ApiMember(DataType="bool", Description="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.", Name="IgnoreHash")
public IgnoreHash: boolean;
public IgnoreValidation: boolean;
/** @description Set this to be true if the contact is to be deleted */
// @ApiMember(DataType="bool", Description="Set this to be true if the contact is to be deleted", Name="MarkAsDeleted", ParameterType="query")
public MarkAsDeleted: boolean;
/** @description Object containing all details of the contact to be inserted or updated. */
// @ApiMember(DataType="SubscriptionContactModel", Description="Object containing all details of the contact to be inserted or updated.", IsRequired=true, Name="Contact", ParameterType="query")
public Contact: SubscriptionContactModel;
public LicenseeId: string;
public SessionId: string;
public constructor(init?: Partial<SaveContact>) { super(init); (Object as any).assign(this, init); }
}
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 /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
}
}