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 SubscriptionLinkContact
{
/** @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 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="ContactAlternateKey", ParameterType="query")
public ContactAlternateKey: string;
/** @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. Note: Use of this is not currently implemented */
// @ApiMember(DataType="string", Description="The unique key that represents the role type on the external system. Note: Use of this is not currently implemented", Name="RoleAlternateKey", ParameterType="query")
public RoleAlternateKey: string;
public constructor(init?: Partial<SubscriptionLinkContact>) { (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 SubscriptionObjectModel 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 object on the external system. */
// @ApiMember(DataType="string", Description="The unique key that represents the object on the external system.", IsRequired=true, Name="AlternateKey", ParameterType="query")
public AlternateKey: string;
/** @description Guid of the 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 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 Guid of the RmsTableCtx within Eros. This is used if the alternate key is provided to identify the object to update. */
// @ApiMember(DataType="Guid", Description="Guid of the RmsTableCtx within Eros. This is used if the alternate key is provided to identify the object to update.", Name="RmsTableCtxId", ParameterType="query")
public RmsTableCtxId: string;
/** @description Validation ensures that this object has a value in alternateKey or ObjectId, ignoring validation skips this requirement. */
// @ApiMember(DataType="bool", Description="Validation ensures that this object has a value in alternateKey or ObjectId, ignoring validation skips this requirement.", Name="IgnoreValidation", ParameterType="query")
public IgnoreValidation: boolean;
public constructor(init?: Partial<SubscriptionObjectModel>) { (Object as any).assign(this, init); }
}
export class DimensionValueModel
{
public DimensionValueId: string;
public DimensionId: string;
public Name: string;
public Description: string;
public ShortName: string;
public TrafficLightId: string;
public TrafficLightColour: string;
public ObjectConnectionId: string;
public OwnerContactId: string;
public RecordStatus: string;
public constructor(init?: Partial<DimensionValueModel>) { (Object as any).assign(this, init); }
}
export class SubscriptionCommonProjectModel
{
/** @description A reference number used for identifying the project in the external system. */
// @ApiMember(DataType="string", Description="A reference number used for identifying the project in the external system.", Name="Reference", ParameterType="query")
public Reference: string;
/** @description A name for the project. */
// @ApiMember(DataType="string", Description="A name for the project.", IsRequired=true, Name="Name", ParameterType="query")
public Name: string;
/** @description A description for the project. */
// @ApiMember(DataType="string", Description="A description for the project.", IsRequired=true, Name="Description", ParameterType="query")
public Description: string;
/** @description A list of ProjectContact records that link contacts (and their role in the project) to the project. */
// @ApiMember(DataType="List<SubscriptionLinkContact>", Description="A list of ProjectContact records that link contacts (and their role in the project) to the project.", Name="ProjectContacts", ParameterType="query")
public ProjectContacts: SubscriptionLinkContact[];
/** @description An address for the project. */
// @ApiMember(DataType="AddressModel", Description="An address for the project.", Name="ProjectAddress", ParameterType="query")
public ProjectAddress: AddressModel;
/** @description A link to the Customer Contact Group. */
// @ApiMember(DataType="SubscriptionObjectModel", Description="A link to the Customer Contact Group.", Name="CustomerContactGroup", ParameterType="query")
public CustomerContactGroup: SubscriptionObjectModel;
/** @description Project Group Name. */
// @ApiMember(DataType="string", Description="Project Group Name.", Name="GroupName", ParameterType="query")
public GroupName: string;
/** @description Stage Name. */
// @ApiMember(DataType="string", Description="Stage Name.", Name="StageName", ParameterType="query")
public StageName: string;
/** @description Guid of the Media Object representing the projects primary image. */
// @ApiMember(DataType="Guid", Description="Guid of the Media Object representing the projects primary image.", Name="PrimaryProjectImageId", ParameterType="query")
public PrimaryProjectImageId: string;
/** @description URL to the projects primary full image. */
// @ApiMember(DataType="string", Description="URL to the projects primary full image.", Name="PrimaryProjectPhotoUrl", ParameterType="query")
public PrimaryProjectPhotoUrl: string;
/** @description URL to the projects primary thumbnail image. */
// @ApiMember(DataType="string", Description="URL to the projects primary thumbnail image.", Name="PrimaryProjectThumbnailUrl", ParameterType="query")
public PrimaryProjectThumbnailUrl: string;
/** @description Image height of the projects logo. */
// @ApiMember(DataType="int", Description="Image height of the projects logo.", Name="PrimaryProjectPhotoHeight", ParameterType="query")
public PrimaryProjectPhotoHeight: number;
/** @description Image height of the projects logo. */
// @ApiMember(DataType="int", Description="Image height of the projects logo.", Name="PrimaryProjectPhotoWidth", ParameterType="query")
public PrimaryProjectPhotoWidth: number;
/** @description Dynamically linked content. */
// @ApiMember(DataType="string", Description="Dynamically linked content.", Name="DynamicContent", ParameterType="query")
public DynamicContent: string;
/** @description If this is 'A' then a documentable ObjectConnection will be created. If this is 'D' then a documentable ObjectConnection will be removed if it exists. Any other value will be ignored. */
// @ApiMember(DataType="char", Description="If this is 'A' then a documentable ObjectConnection will be created. If this is 'D' then a documentable ObjectConnection will be removed if it exists. Any other value will be ignored.", Name="DocumentableObjectConnection", ParameterType="query")
public DocumentableObjectConnection: string;
/** @description Dimension values linked to the project. */
// @ApiMember(DataType="List<DimensionValueModel>", Description="Dimension values linked to the project.", Name="DimensionValues", ParameterType="query")
public DimensionValues: DimensionValueModel[];
/** @description Dimension values linked to the project. */
// @ApiMember(DataType="List<Guid>", Description="Dimension values linked to the project.", Name="Calendars", ParameterType="query")
public Calendars: string[];
/** @description The Document Site ID. */
// @ApiMember(DataType="Guid", Description="The Document Site ID.", Name="DocumentSiteId", ParameterType="query")
public DocumentSiteId?: string;
public ObjectSubscriptionId: string;
public ObjectHash: string;
public constructor(init?: Partial<SubscriptionCommonProjectModel>) { (Object as any).assign(this, init); }
}
/** @description Inserts or Updates a project details and its contact connections and addresses. */
// @Api(Description="Inserts or Updates a project details and its contact connections and addresses.")
export class SaveProject 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")
public SuiteDataSourceInstanceId: string;
/** @description The unique key that represents the project on the external system. */
// @ApiMember(DataType="string", Description="The unique key that represents the project on the external system.", IsRequired=true, Name="AlternateKey")
public AlternateKey: string;
/** @description Guid of the project 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 project 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 Project model and its data will be compared with the current Project 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 Project model and its data will be compared with the current Project to determine if there are any changes to save.", Name="IgnoreHash")
public IgnoreHash: boolean;
public IgnoreValidation: boolean;
/** @description Object containing all details of the project to be inserted or updated. */
// @ApiMember(DataType="SubscriptionCommonProjectModel", Description="Object containing all details of the project to be inserted or updated.", IsRequired=true, Name="Project", ParameterType="query")
public Project: SubscriptionCommonProjectModel;
public LicenseeId: string;
public SessionId: string;
public constructor(init?: Partial<SaveProject>) { 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/SaveProject 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,
Project:
{
Reference: String,
Name: String,
Description: String,
ProjectContacts:
[
{
ContactAlternateKey: String,
RoleAlternateKey: String
}
],
ProjectAddress:
{
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
}
},
CustomerContactGroup:
{
AlternateKey: String,
IgnoreValidation: False
},
GroupName: String,
StageName: String,
PrimaryProjectPhotoUrl: String,
PrimaryProjectThumbnailUrl: String,
PrimaryProjectPhotoHeight: 0,
PrimaryProjectPhotoWidth: 0,
DynamicContent: String,
DocumentableObjectConnection: ,
DimensionValues:
[
{
Name: String,
Description: String,
ShortName: String,
TrafficLightColour: String,
RecordStatus: String
}
],
Calendars:
[
00000000-0000-0000-0000-000000000000
],
DocumentSiteId: 00000000-0000-0000-0000-000000000000,
ObjectHash: 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
}
}