namespace Eros.Saguna.Common.WebAPI.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type RuleValidationResult() =
member val RuleCode:String = null with get,set
member val Message:String = null with get,set
member val Key:String = null with get,set
member val Tag:String = null with get,set
member val ErrorCode:String = null with get,set
[<AllowNullLiteral>]
type ValidationErrorList() =
member val ValidationErrors:ResizeArray<RuleValidationResult> = null with get,set
[<AllowNullLiteral>]
type SubscriptionLinkContact() =
///<summary>
///Guid of the contact object within Eros.
///</summary>
[<ApiMember(DataType="Guid", Description="Guid of the contact object within Eros.", Name="ContactId", ParameterType="query")>]
member val ContactId:Guid = new Guid() with get,set
///<summary>
///The unique key that represents the contact on the external system.
///</summary>
[<ApiMember(DataType="string", Description="The unique key that represents the contact on the external system.", IsRequired=true, Name="ContactAlternateKey", ParameterType="query")>]
member val ContactAlternateKey:String = null with get,set
///<summary>
///Guid of the Role List Item object within Eros.
///</summary>
[<ApiMember(DataType="Guid", Description="Guid of the Role List Item object within Eros.", IsRequired=true, Name="RoleId", ParameterType="query")>]
member val RoleId:Guid = new Guid() with get,set
///<summary>
///The unique key that represents the role type on the external system. Note: Use of this is not currently implemented
///</summary>
[<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")>]
member val RoleAlternateKey:String = null with get,set
[<AllowNullLiteral>]
type LocationCoordinatesModel() =
///<summary>
///The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
///</summary>
[<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")>]
member val Latitude:Double = new Double() with get,set
///<summary>
///The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
///</summary>
[<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")>]
member val Longitude:Double = new Double() with get,set
///<summary>
///The altitude of an address - the altitude above sea level.
///</summary>
[<ApiMember(DataType="Double?", Description="The altitude of an address - the altitude above sea level.", Name="Altitude", ParameterType="query")>]
member val Altitude:Nullable<Double> = new Nullable<Double>() with get,set
///<summary>
///Accuracy of the latitude and longitude.
///</summary>
[<ApiMember(DataType="Double?", Description="Accuracy of the latitude and longitude.", Name="Accuracy", ParameterType="query")>]
member val Accuracy:Nullable<Double> = new Nullable<Double>() with get,set
///<summary>
///Accurancy of the Altitude.
///</summary>
[<ApiMember(DataType="Double?", Description="Accurancy of the Altitude.", Name="AltitudeAccuracy", ParameterType="query")>]
member val AltitudeAccuracy:Nullable<Double> = new Nullable<Double>() with get,set
///<summary>
///Direction you are heading.
///</summary>
[<ApiMember(DataType="Double?", Description="Direction you are heading.", Name="Heading", ParameterType="query")>]
member val Heading:Nullable<Double> = new Nullable<Double>() with get,set
///<summary>
///Speed you are going.
///</summary>
[<ApiMember(DataType="Double?", Description="Speed you are going.", Name="Speed", ParameterType="query")>]
member val Speed:Nullable<Double> = new Nullable<Double>() with get,set
///<summary>
///Speed your altitude is ascending/descending at.
///</summary>
[<ApiMember(DataType="Double?", Description="Speed your altitude is ascending/descending at.", Name="VerticalSpeed", ParameterType="query")>]
member val VerticalSpeed:Nullable<Double> = new Nullable<Double>() with get,set
[<AllowNullLiteral>]
type AddressModel() =
///<summary>
///The distance between this project and another specified set of gps coordinates.
///</summary>
[<ApiMember(DataType="double", Description="The distance between this project and another specified set of gps coordinates.", Name="DistanceAway", ParameterType="query")>]
member val DistanceAway:Double = new Double() with get,set
///<summary>
///The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
///</summary>
[<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")>]
member val Latitude:Double = new Double() with get,set
///<summary>
///The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
///</summary>
[<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")>]
member val Longitude:Double = new Double() with get,set
///<summary>
///Address Format Id Guid - this will be determined by the service.
///</summary>
[<ApiMember(DataType="Guid", Description="Address Format Id Guid - this will be determined by the service.", Name="AddressFormatId", ParameterType="query")>]
member val AddressFormatId:Guid = new Guid() with get,set
///<summary>
///Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered.
///</summary>
[<ApiMember(DataType="Guid", Description="Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered.", Name="SuburbId", ParameterType="query")>]
member val SuburbId:Guid = new Guid() with get,set
///<summary>
///The suburb name.
///</summary>
[<ApiMember(DataType="string", Description="The suburb name.", Name="SuburbName", ParameterType="query")>]
member val SuburbName:String = null with get,set
///<summary>
///The shortened State Name e.g Vic for Victoria.
///</summary>
[<ApiMember(DataType="string", Description="The shortened State Name e.g Vic for Victoria.", Name="StateShortName", ParameterType="query")>]
member val StateShortName:String = null with get,set
///<summary>
///The suburb postcode.
///</summary>
[<ApiMember(DataType="string", Description="The suburb postcode.", Name="PostCode", ParameterType="query")>]
member val PostCode:String = null with get,set
///<summary>
///Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.
///</summary>
[<ApiMember(DataType="Guid", Description="Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.", Name="CountryId", ParameterType="query")>]
member val CountryId:Guid = new Guid() with get,set
///<summary>
///the name of the country the address is within.
///</summary>
[<ApiMember(DataType="string", Description="the name of the country the address is within.", Name="CountryName", ParameterType="query")>]
member val CountryName:String = null with get,set
///<summary>
///A 2 digit ISO Country Code representing the country.
///</summary>
[<ApiMember(DataType="string", Description="A 2 digit ISO Country Code representing the country.", Name="ISOCountryCode", ParameterType="query")>]
member val ISOCountryCode:String = null with get,set
///<summary>
///The address Lot number.
///</summary>
[<ApiMember(DataType="string", Description="The address Lot number.", Name="LotNumber", ParameterType="query")>]
member val LotNumber:String = null with get,set
///<summary>
///The address Sub Unit number.
///</summary>
[<ApiMember(DataType="string", Description="The address Sub Unit number.", Name="SubUnit", ParameterType="query")>]
member val SubUnit:String = null with get,set
///<summary>
///The address building number.
///</summary>
[<ApiMember(DataType="string", Description="The address building number.", Name="BuildingNumber", ParameterType="query")>]
member val BuildingNumber:String = null with get,set
///<summary>
///The address street number.
///</summary>
[<ApiMember(DataType="string", Description="The address street number.", Name="StreetNumber", ParameterType="query")>]
member val StreetNumber:String = null with get,set
///<summary>
///The address street name including street type.
///</summary>
[<ApiMember(DataType="string", Description="The address street name including street type.", Name="StreetName", ParameterType="query")>]
member val StreetName:String = null with get,set
///<summary>
///A formatted address Line 1.
///</summary>
[<ApiMember(DataType="string", Description="A formatted address Line 1.", Name="AddressLineOne", ParameterType="query")>]
member val AddressLineOne:String = null with get,set
///<summary>
///A formatted address Line 2.
///</summary>
[<ApiMember(DataType="string", Description="A formatted address Line 2.", Name="AddressLineTwo", ParameterType="query")>]
member val AddressLineTwo:String = null with get,set
///<summary>
///The full address string.
///</summary>
[<ApiMember(DataType="string", Description="The full address string.", Name="AddressFull", ParameterType="query")>]
member val AddressFull:String = null with get,set
///<summary>
///True if the address is a physical location.
///</summary>
[<ApiMember(DataType="bool?", Description="True if the address is a physical location.", Name="IsPhysical", ParameterType="query")>]
member val IsPhysical:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<summary>
///Notes about the address.
///</summary>
[<ApiMember(DataType="string", Description="Notes about the address.", Name="Notes", ParameterType="query")>]
member val Notes:String = null with get,set
///<summary>
///If true, the address is eligible for having its coordinates calculated/updated.
///</summary>
[<ApiMember(DataType="bool?", Description="If true, the address is eligible for having its coordinates calculated/updated.", Name="AutoMapCoordinates", ParameterType="query")>]
member val AutoMapCoordinates:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<summary>
///Location Coordinates for the address.
///</summary>
[<ApiMember(DataType="LocationCoordinates", Description="Location Coordinates for the address.", Name="LocationCoordinates", ParameterType="query")>]
member val LocationCoordinates:LocationCoordinatesModel = null with get,set
[<AllowNullLiteral>]
type SubscriptionObjectModel() =
///<summary>
///Guid representing the external systems datasource information.
///</summary>
[<ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")>]
member val SuiteDataSourceInstanceId:Guid = new Guid() with get,set
///<summary>
///The unique key that represents the object on the external system.
///</summary>
[<ApiMember(DataType="string", Description="The unique key that represents the object on the external system.", IsRequired=true, Name="AlternateKey", ParameterType="query")>]
member val AlternateKey:String = null with get,set
///<summary>
///Guid of the object within Eros. If ObjectId is known, the external system may pass this instead of the alternate key.
///</summary>
[<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")>]
member val ObjectId:Guid = new Guid() with get,set
///<summary>
///Guid of the RmsTableCtx within Eros. This is used if the alternate key is provided to identify the object to update.
///</summary>
[<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")>]
member val RmsTableCtxId:Guid = new Guid() with get,set
///<summary>
///Validation ensures that this object has a value in alternateKey or ObjectId, ignoring validation skips this requirement.
///</summary>
[<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")>]
member val IgnoreValidation:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type DimensionValueModel() =
member val DimensionValueId:Guid = new Guid() with get,set
member val DimensionId:Guid = new Guid() with get,set
member val Name:String = null with get,set
member val Description:String = null with get,set
member val ShortName:String = null with get,set
member val TrafficLightId:Guid = new Guid() with get,set
member val TrafficLightColour:String = null with get,set
member val ObjectConnectionId:Guid = new Guid() with get,set
member val OwnerContactId:Guid = new Guid() with get,set
member val RecordStatus:String = null with get,set
[<AllowNullLiteral>]
type SubscriptionCommonProjectModel() =
///<summary>
///A reference number used for identifying the project in the external system.
///</summary>
[<ApiMember(DataType="string", Description="A reference number used for identifying the project in the external system.", Name="Reference", ParameterType="query")>]
member val Reference:String = null with get,set
///<summary>
///A name for the project.
///</summary>
[<ApiMember(DataType="string", Description="A name for the project.", IsRequired=true, Name="Name", ParameterType="query")>]
member val Name:String = null with get,set
///<summary>
///A description for the project.
///</summary>
[<ApiMember(DataType="string", Description="A description for the project.", IsRequired=true, Name="Description", ParameterType="query")>]
member val Description:String = null with get,set
///<summary>
///A list of ProjectContact records that link contacts (and their role in the project) to the project.
///</summary>
[<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")>]
member val ProjectContacts:ResizeArray<SubscriptionLinkContact> = null with get,set
///<summary>
///An address for the project.
///</summary>
[<ApiMember(DataType="AddressModel", Description="An address for the project.", Name="ProjectAddress", ParameterType="query")>]
member val ProjectAddress:AddressModel = null with get,set
///<summary>
///A link to the Customer Contact Group.
///</summary>
[<ApiMember(DataType="SubscriptionObjectModel", Description="A link to the Customer Contact Group.", Name="CustomerContactGroup", ParameterType="query")>]
member val CustomerContactGroup:SubscriptionObjectModel = null with get,set
///<summary>
///Project Group Name.
///</summary>
[<ApiMember(DataType="string", Description="Project Group Name.", Name="GroupName", ParameterType="query")>]
member val GroupName:String = null with get,set
///<summary>
///Stage Name.
///</summary>
[<ApiMember(DataType="string", Description="Stage Name.", Name="StageName", ParameterType="query")>]
member val StageName:String = null with get,set
///<summary>
///Guid of the Media Object representing the projects primary image.
///</summary>
[<ApiMember(DataType="Guid", Description="Guid of the Media Object representing the projects primary image.", Name="PrimaryProjectImageId", ParameterType="query")>]
member val PrimaryProjectImageId:Guid = new Guid() with get,set
///<summary>
///URL to the projects primary full image.
///</summary>
[<ApiMember(DataType="string", Description="URL to the projects primary full image.", Name="PrimaryProjectPhotoUrl", ParameterType="query")>]
member val PrimaryProjectPhotoUrl:String = null with get,set
///<summary>
///URL to the projects primary thumbnail image.
///</summary>
[<ApiMember(DataType="string", Description="URL to the projects primary thumbnail image.", Name="PrimaryProjectThumbnailUrl", ParameterType="query")>]
member val PrimaryProjectThumbnailUrl:String = null with get,set
///<summary>
///Image height of the projects logo.
///</summary>
[<ApiMember(DataType="int", Description="Image height of the projects logo.", Name="PrimaryProjectPhotoHeight", ParameterType="query")>]
member val PrimaryProjectPhotoHeight:Int32 = new Int32() with get,set
///<summary>
///Image height of the projects logo.
///</summary>
[<ApiMember(DataType="int", Description="Image height of the projects logo.", Name="PrimaryProjectPhotoWidth", ParameterType="query")>]
member val PrimaryProjectPhotoWidth:Int32 = new Int32() with get,set
///<summary>
///Dynamically linked content.
///</summary>
[<ApiMember(DataType="string", Description="Dynamically linked content.", Name="DynamicContent", ParameterType="query")>]
member val DynamicContent:String = null with get,set
///<summary>
///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.
///</summary>
[<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")>]
member val DocumentableObjectConnection:Char = new Char() with get,set
///<summary>
///Dimension values linked to the project.
///</summary>
[<ApiMember(DataType="List<DimensionValueModel>", Description="Dimension values linked to the project.", Name="DimensionValues", ParameterType="query")>]
member val DimensionValues:ResizeArray<DimensionValueModel> = null with get,set
///<summary>
///Dimension values linked to the project.
///</summary>
[<ApiMember(DataType="List<Guid>", Description="Dimension values linked to the project.", Name="Calendars", ParameterType="query")>]
member val Calendars:ResizeArray<Guid> = null with get,set
///<summary>
///The Document Site ID.
///</summary>
[<ApiMember(DataType="Guid", Description="The Document Site ID.", Name="DocumentSiteId", ParameterType="query")>]
member val DocumentSiteId:Nullable<Guid> = new Nullable<Guid>() with get,set
member val ObjectSubscriptionId:Guid = new Guid() with get,set
member val ObjectHash:String = null with get,set
///<summary>
///Inserts or Updates a project details and its contact connections and addresses.
///</summary>
[<Api(Description="Inserts or Updates a project details and its contact connections and addresses.")>]
[<AllowNullLiteral>]
type SaveProject() =
inherit ValidationErrorList()
///<summary>
///Guid representing the external systems datasource information.
///</summary>
[<ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId")>]
member val SuiteDataSourceInstanceId:Guid = new Guid() with get,set
///<summary>
///The unique key that represents the project on the external system.
///</summary>
[<ApiMember(DataType="string", Description="The unique key that represents the project on the external system.", IsRequired=true, Name="AlternateKey")>]
member val AlternateKey:String = null with get,set
///<summary>
///Guid of the project object within Eros. If ObjectId is known, the external system may pass this instead of the alternate key.
///</summary>
[<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")>]
member val ObjectId:Guid = new Guid() with get,set
///<summary>
///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.
///</summary>
[<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")>]
member val IgnoreHash:Boolean = new Boolean() with get,set
member val IgnoreValidation:Boolean = new Boolean() with get,set
///<summary>
///Object containing all details of the project to be inserted or updated.
///</summary>
[<ApiMember(DataType="SubscriptionCommonProjectModel", Description="Object containing all details of the project to be inserted or updated.", IsRequired=true, Name="Project", ParameterType="query")>]
member val Project:SubscriptionCommonProjectModel = null with get,set
member val LicenseeId:Guid = new Guid() with get,set
member val SessionId:Guid = new Guid() with get,set
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
}
}