export class RuleValidationResult
{
/** @description Validation/Error message details */
// @ApiMember(DataType="Guid", Description="Validation/Error message details", Name="Message", ParameterType="body")
public Message: string;
/** @description Summary/label of validation/error */
// @ApiMember(DataType="Guid", Description="Summary/label of validation/error", Name="Key", ParameterType="body")
public Key: string;
/** @description Key/code representing validation/error */
// @ApiMember(DataType="Guid", Description="Key/code representing validation/error", Name="ErrorCode", ParameterType="body")
public ErrorCode: string;
public constructor(init?: Partial<RuleValidationResult>) { (Object as any).assign(this, init); }
}
export class ValidationErrorList
{
/** @description List of any validation/errors occuring during a method call */
// @ApiMember(DataType="List<RuleValidationResult>", Description="List of any validation/errors occuring during a method call", Name="ValidationErrors", ParameterType="body")
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 PSTPF. */
// @ApiMember(DataType="Guid", Description="Guid of the Role List Item object within PSTPF.", Name="RoleId", ParameterType="body")
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="body")
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(Description="The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.", 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(Description="The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.", ParameterType="query")
public Longitude: number;
/** @description The altitude of an address - the altitude above sea level." */
// @ApiMember(Description="The altitude of an address - the altitude above sea level.\"", ParameterType="query")
public Altitude?: number;
/** @description Accuracy of the latitude and longitude. */
// @ApiMember(Description="Accuracy of the latitude and longitude.", ParameterType="query")
public Accuracy?: number;
/** @description Accurancy of the Altitude. */
// @ApiMember(Description="Accurancy of the Altitude.", ParameterType="query")
public AltitudeAccuracy?: number;
/** @description Direction you are heading. */
// @ApiMember(Description="Direction you are heading.", ParameterType="query")
public Heading?: number;
/** @description Speed you are going. */
// @ApiMember(Description="Speed you are going.", ParameterType="query")
public Speed?: number;
/** @description Speed your altitude is ascending/descending at. */
// @ApiMember(Description="Speed your altitude is ascending/descending at.", 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="body")
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.", Name="Latitude", ParameterType="body")
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.", Name="Longitude", ParameterType="body")
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="body")
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="body")
public SuburbId: string;
/** @description The suburb name. */
// @ApiMember(DataType="string", Description="The suburb name.", Name="SuburbName", ParameterType="body")
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="body")
public StateShortName: string;
/** @description The suburb postcode. */
// @ApiMember(DataType="string", Description="The suburb postcode.", Name="PostCode", ParameterType="body")
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="body")
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="body")
public CountryName: string;
/** @description ISO Country Code. */
// @ApiMember(Description="ISO Country Code.", ParameterType="query")
public ISOCountryCode: string;
/** @description The address Lot number. */
// @ApiMember(DataType="string", Description="The address Lot number.", Name="LotNumber", ParameterType="body")
public LotNumber: string;
/** @description The address Sub Unit number. */
// @ApiMember(DataType="string", Description="The address Sub Unit number.", Name="SubUnit", ParameterType="body")
public SubUnit: string;
/** @description The address building number. */
// @ApiMember(DataType="string", Description="The address building number.", Name="BuildingNumber", ParameterType="body")
public BuildingNumber: string;
/** @description The address street number. */
// @ApiMember(DataType="string", Description="The address street number.", Name="StreetNumber", ParameterType="body")
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="body")
public StreetName: string;
/** @description A formatted address Line 1. */
// @ApiMember(DataType="string", Description="A formatted address Line 1.", Name="AddressLineOne", ParameterType="body")
public AddressLineOne: string;
/** @description A formatted address Line 2. */
// @ApiMember(DataType="string", Description="A formatted address Line 2.", Name="AddressLineTwo", ParameterType="body")
public AddressLineTwo: string;
/** @description The full address string. */
// @ApiMember(DataType="string", Description="The full address string.", Name="AddressFull", ParameterType="body")
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="body")
public IsPhysical?: boolean;
/** @description Notes about the address. */
// @ApiMember(DataType="string", Description="Notes about the address.", Name="Notes")
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="body")
public AutoMapCoordinates?: boolean;
/** @description Location Coordinates for the address. */
// @ApiMember(DataType="LocationCoordinates", Description="Location Coordinates for the address.", Name="LocationCoordinates", ParameterType="body")
public LocationCoordinates: LocationCoordinatesModel;
public constructor(init?: Partial<AddressModel>) { (Object as any).assign(this, init); }
}
export class ContactAddressModel
{
/** @description Address Details */
// @ApiMember(DataType="AddressModel", Description="Address Details", Name="Address", ParameterType="body")
public Address: AddressModel;
/** @description True if this is a postal address. */
// @ApiMember(DataType="bool", Description="True if this is a postal address.", Name="IsPostal", ParameterType="body")
public IsPostal: boolean;
/** @description True if this is the primary address. */
// @ApiMember(DataType="bool", Description="True if this is the primary address.", Name="IsPrimaryLocation", ParameterType="body")
public IsPrimaryLocation: boolean;
/** @description True if this address is the registered tax address. */
// @ApiMember(DataType="bool", Description="True if this address is the registered tax address.", Name="IsRegisteredLocation", ParameterType="body")
public IsRegisteredLocation: boolean;
/** @description Suburb Name */
// @ApiMember(DataType="string", Description="Suburb Name", Name="SuburbName", ParameterType="body")
public SuburbName: string;
/** @description State Name */
// @ApiMember(DataType="string", Description="State Name", Name="StateName", ParameterType="body")
public StateName: string;
/** @description Country Name */
// @ApiMember(DataType="string", Description="Country Name", Name="CountryName", ParameterType="body")
public CountryName: string;
public constructor(init?: Partial<ContactAddressModel>) { (Object as any).assign(this, init); }
}
export class PhoneModel
{
/** @description Country Code */
// @ApiMember(DataType="string", Description="Country Code", Name="CountryCode", ParameterType="body")
public CountryCode: string;
/** @description Area Code */
// @ApiMember(DataType="string", Description="Area Code", Name="AreaCode", ParameterType="body")
public AreaCode: string;
/** @description Local Number */
// @ApiMember(DataType="string", Description="Local Number", Name="LocalNumber", ParameterType="body")
public LocalNumber: string;
public constructor(init?: Partial<PhoneModel>) { (Object as any).assign(this, init); }
}
export class ContactDetailModel
{
/** @description Id of the Contact Method */
// @ApiMember(DataType="Guid", Description="Id of the Contact Method", Name="ContactMethodId", ParameterType="body")
public ContactMethodId: string;
/** @description Contact Method Name */
// @ApiMember(DataType="string", Description="Contact Method Name", Name="ContactMethodName", ParameterType="body")
public ContactMethodName: string;
/** @description If the contact method is an address, this will contain the address details. */
// @ApiMember(DataType="ContactAddressModel", Description="If the contact method is an address, this will contain the address details.", Name="ContactAddress", ParameterType="body")
public ContactAddress: ContactAddressModel;
/** @description If the contact method is a phone, this will contain the phone details */
// @ApiMember(DataType="PhoneModel", Description="If the contact method is a phone, this will contain the phone details", Name="ContactPhone", ParameterType="body")
public ContactPhone: PhoneModel;
/** @description Id of the country */
// @ApiMember(DataType="Guid?", Description="Id of the country", Name="CountryId", ParameterType="body")
public CountryId?: string;
/** @description A summary string representing the contact details */
// @ApiMember(DataType="string", Description="A summary string representing the contact details", Name="ContactDetails", ParameterType="body")
public ContactDetails: string;
/** @description Notes about the contact details */
// @ApiMember(DataType="string", Description="Notes about the contact details", Name="Notes", ParameterType="body")
public Notes: string;
/** @description Area Code if contact details are a phone number */
// @ApiMember(DataType="string", Description="Area Code if contact details are a phone number", Name="ContactDetailsCode", ParameterType="body")
public ContactDetailsCode: string;
/** @description Order number of the contact method */
// @ApiMember(DataType="int", Description="Order number of the contact method", Name="OrderContactMethod", ParameterType="body")
public OrderContactMethod: number;
/** @description True if this is the primary contact method */
// @ApiMember(DataType="bool", Description="True if this is the primary contact method", Name="IsPrimaryContactMethod", ParameterType="body")
public IsPrimaryContactMethod: boolean;
/** @description True if this contact method is an address */
// @ApiMember(DataType="bool", Description="True if this contact method is an address", Name="IsAddress", ParameterType="body")
public IsAddress: boolean;
public constructor(init?: Partial<ContactDetailModel>) { (Object as any).assign(this, init); }
}
export class SubscriptionContactModel
{
/** @description Guid of the contact object within PSTPF. */
// @ApiMember(DataType="Guid", Description="Guid of the contact object within PSTPF.", Name="ContactId", ParameterType="body")
public ContactId: string;
/** @description Guid of the Contact Type List Item object within PSTPF. */
// @ApiMember(DataType="Guid", Description="Guid of the Contact Type List Item object within PSTPF.", Name="ContactType", ParameterType="body")
public ContactType: string;
/** @description Guid of the Marital Status List Item object within PSTPF. */
// @ApiMember(DataType="Guid?", Description="Guid of the Marital Status List Item object within PSTPF.", Name="MaritalStatus", ParameterType="body")
public MaritalStatus?: string;
/** @description Guid of the Gender List Item object within PSTPF. */
// @ApiMember(DataType="Guid?", Description="Guid of the Gender List Item object within PSTPF.", Name="Gender", ParameterType="body")
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="body")
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="body")
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="body")
public Surname: string;
/** @description The full name for the contact. */
// @ApiMember(DataType="string", Description="The full name for the contact.", Name="FullName", ParameterType="body")
public FullName: string;
/** @description A short name for the contact. */
// @ApiMember(DataType="string", Description="A short name for the contact.", Name="ShortName", ParameterType="body")
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="body")
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="body")
public Title: string;
/** @description A salutation for the contact. */
// @ApiMember(DataType="string", Description="A salutation for the contact.", Name="Salutation", ParameterType="body")
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="body")
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="body")
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="body")
public Arbn: string;
/** @description A trading name for the contact. */
// @ApiMember(DataType="string", Description="A trading name for the contact.", Name="TradingName", ParameterType="body")
public TradingName: string;
/** @description A legal name for the contact. */
// @ApiMember(DataType="string", Description="A legal name for the contact.", Name="LegalName", ParameterType="body")
public LegalName: string;
/** @description Any notes/description for the contact. */
// @ApiMember(DataType="string", Description="Any notes/description for the contact.", Name="Notes", ParameterType="body")
public Notes: string;
/** @description Contact Employment Industry. */
// @ApiMember(DataType="string", Description="Contact Employment Industry.", Name="EmploymentIndustry", ParameterType="body")
public EmploymentIndustry: string;
/** @description Contact Employment Role. */
// @ApiMember(DataType="string", Description="Contact Employment Role.", Name="EmploymentRole", ParameterType="body")
public EmploymentRole: string;
/** @description Contact Employment Geographic Area. */
// @ApiMember(DataType="string", Description="Contact Employment Geographic Area.", Name="EmploymentGeographicArea", ParameterType="body")
public EmploymentGeographicArea: string;
/** @description The Contacts Drivers Licence Number */
// @ApiMember(DataType="string", Description="The Contacts Drivers Licence Number", Name="DriversLicence", ParameterType="body")
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="body")
public GstRegistered: boolean;
/** @description The status of the contact in PSTPF */
// @ApiMember(DataType="string", Description="The status of the contact in PSTPF", Name="RecordStatus", ParameterType="body")
public RecordStatus: string;
/** @description A list of roles this contact has. */
// @ApiMember(DataType="List<ContactRole>", Description="A list of roles this contact has.", Name="ContactRoles", ParameterType="body")
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.", Name="ContactDetails", ParameterType="body")
public ContactDetails: ContactDetailModel[];
/** @description Custom Content XML for the contact. */
// @ApiMember(DataType="string", Description="Custom Content XML for the contact.", Name="CustomContentXML", ParameterType="body")
public CustomContentXML: string;
/** @description URL to the Primary Image. */
// @ApiMember(DataType="string", Description="URL to the Primary Image.", Name="BlobImageURLPrimary", ParameterType="body")
public BlobImageURLPrimary: string;
/** @description URL to the Primary Image thumbnail. */
// @ApiMember(DataType="string", Description="URL to the Primary Image thumbnail.", Name="BlobImageURLPrimaryThumbnail", ParameterType="body")
public BlobImageURLPrimaryThumbnail: string;
/** @description The primary mobile for the contact. */
// @ApiMember(DataType="string", Description="The primary mobile for the contact.", Name="PrimaryMobile", ParameterType="body")
public PrimaryMobile: string;
/** @description The primary email for the contact. */
// @ApiMember(DataType="string", Description="The primary email for the contact.", Name="PrimaryEmail", ParameterType="body")
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="body")
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="body")
public AlternateKey: string;
/** @description Guid of the contact object within PSTPF. 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 PSTPF. If ObjectId is known, the external system may pass this instead of the alternate key.", Name="ObjectId", ParameterType="body")
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", ParameterType="body")
public IgnoreHash: 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="body")
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="body")
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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/SaveContact HTTP/1.1
Host: production-eros-platform-apisubscription.azurewebsites.net
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"AlternateKey":"String","IgnoreHash":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-01T00:00:00.0000000","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":[{"Message":"String","Key":"String","ErrorCode":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}