import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* 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.")
open class SaveProject : ValidationErrorList(), ISubscription
{
/**
* Guid representing the external systems datasource information.
*/
@ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId")
override var SuiteDataSourceInstanceId:UUID? = null
/**
* 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")
override var AlternateKey:String? = null
/**
* 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")
override var ObjectId:UUID? = null
/**
* 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")
open var IgnoreHash:Boolean? = null
override var IgnoreValidation:Boolean? = null
/**
* 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")
open var Project:SubscriptionCommonProjectModel? = null
open var LicenseeId:UUID? = null
open var SessionId:UUID? = null
}
open class ValidationErrorList
{
open var ValidationErrors:ArrayList<RuleValidationResult>? = null
}
open class RuleValidationResult
{
open var RuleCode:String? = null
open var Message:String? = null
open var Key:String? = null
open var Tag:String? = null
open var ErrorCode:String? = null
}
open class SubscriptionCommonProjectModel
{
/**
* 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")
open var Reference:String? = null
/**
* A name for the project.
*/
@ApiMember(DataType="string", Description="A name for the project.", IsRequired=true, Name="Name", ParameterType="query")
open var Name:String? = null
/**
* A description for the project.
*/
@ApiMember(DataType="string", Description="A description for the project.", IsRequired=true, Name="Description", ParameterType="query")
open var Description:String? = null
/**
* 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")
open var ProjectContacts:ArrayList<SubscriptionLinkContact>? = null
/**
* An address for the project.
*/
@ApiMember(DataType="AddressModel", Description="An address for the project.", Name="ProjectAddress", ParameterType="query")
open var ProjectAddress:AddressModel? = null
/**
* A link to the Customer Contact Group.
*/
@ApiMember(DataType="SubscriptionObjectModel", Description="A link to the Customer Contact Group.", Name="CustomerContactGroup", ParameterType="query")
open var CustomerContactGroup:SubscriptionObjectModel? = null
/**
* Project Group Name.
*/
@ApiMember(DataType="string", Description="Project Group Name.", Name="GroupName", ParameterType="query")
open var GroupName:String? = null
/**
* Stage Name.
*/
@ApiMember(DataType="string", Description="Stage Name.", Name="StageName", ParameterType="query")
open var StageName:String? = null
/**
* 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")
open var PrimaryProjectImageId:UUID? = null
/**
* URL to the projects primary full image.
*/
@ApiMember(DataType="string", Description="URL to the projects primary full image.", Name="PrimaryProjectPhotoUrl", ParameterType="query")
open var PrimaryProjectPhotoUrl:String? = null
/**
* URL to the projects primary thumbnail image.
*/
@ApiMember(DataType="string", Description="URL to the projects primary thumbnail image.", Name="PrimaryProjectThumbnailUrl", ParameterType="query")
open var PrimaryProjectThumbnailUrl:String? = null
/**
* Image height of the projects logo.
*/
@ApiMember(DataType="int", Description="Image height of the projects logo.", Name="PrimaryProjectPhotoHeight", ParameterType="query")
open var PrimaryProjectPhotoHeight:Int? = null
/**
* Image height of the projects logo.
*/
@ApiMember(DataType="int", Description="Image height of the projects logo.", Name="PrimaryProjectPhotoWidth", ParameterType="query")
open var PrimaryProjectPhotoWidth:Int? = null
/**
* Dynamically linked content.
*/
@ApiMember(DataType="string", Description="Dynamically linked content.", Name="DynamicContent", ParameterType="query")
open var DynamicContent:String? = null
/**
* 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")
open var DocumentableObjectConnection:String? = null
/**
* Dimension values linked to the project.
*/
@ApiMember(DataType="List<DimensionValueModel>", Description="Dimension values linked to the project.", Name="DimensionValues", ParameterType="query")
open var DimensionValues:ArrayList<DimensionValueModel>? = null
/**
* Dimension values linked to the project.
*/
@ApiMember(DataType="List<Guid>", Description="Dimension values linked to the project.", Name="Calendars", ParameterType="query")
open var Calendars:ArrayList<UUID>? = null
/**
* The Document Site ID.
*/
@ApiMember(DataType="Guid", Description="The Document Site ID.", Name="DocumentSiteId", ParameterType="query")
open var DocumentSiteId:UUID? = null
open var ObjectSubscriptionId:UUID? = null
open var ObjectHash:String? = null
}
open class SubscriptionLinkContact
{
/**
* Guid of the contact object within Eros.
*/
@ApiMember(DataType="Guid", Description="Guid of the contact object within Eros.", Name="ContactId", ParameterType="query")
open var ContactId:UUID? = null
/**
* 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")
open var ContactAlternateKey:String? = null
/**
* 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")
open var RoleId:UUID? = null
/**
* 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")
open var RoleAlternateKey:String? = null
}
open class AddressModel
{
/**
* 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")
open var DistanceAway:Double? = null
/**
* 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")
open var Latitude:Double? = null
/**
* 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")
open var Longitude:Double? = null
/**
* 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")
open var AddressFormatId:UUID? = null
/**
* 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")
open var SuburbId:UUID? = null
/**
* The suburb name.
*/
@ApiMember(DataType="string", Description="The suburb name.", Name="SuburbName", ParameterType="query")
open var SuburbName:String? = null
/**
* 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")
open var StateShortName:String? = null
/**
* The suburb postcode.
*/
@ApiMember(DataType="string", Description="The suburb postcode.", Name="PostCode", ParameterType="query")
open var PostCode:String? = null
/**
* 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")
open var CountryId:UUID? = null
/**
* 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")
open var CountryName:String? = null
/**
* 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")
open var ISOCountryCode:String? = null
/**
* The address Lot number.
*/
@ApiMember(DataType="string", Description="The address Lot number.", Name="LotNumber", ParameterType="query")
open var LotNumber:String? = null
/**
* The address Sub Unit number.
*/
@ApiMember(DataType="string", Description="The address Sub Unit number.", Name="SubUnit", ParameterType="query")
open var SubUnit:String? = null
/**
* The address building number.
*/
@ApiMember(DataType="string", Description="The address building number.", Name="BuildingNumber", ParameterType="query")
open var BuildingNumber:String? = null
/**
* The address street number.
*/
@ApiMember(DataType="string", Description="The address street number.", Name="StreetNumber", ParameterType="query")
open var StreetNumber:String? = null
/**
* The address street name including street type.
*/
@ApiMember(DataType="string", Description="The address street name including street type.", Name="StreetName", ParameterType="query")
open var StreetName:String? = null
/**
* A formatted address Line 1.
*/
@ApiMember(DataType="string", Description="A formatted address Line 1.", Name="AddressLineOne", ParameterType="query")
open var AddressLineOne:String? = null
/**
* A formatted address Line 2.
*/
@ApiMember(DataType="string", Description="A formatted address Line 2.", Name="AddressLineTwo", ParameterType="query")
open var AddressLineTwo:String? = null
/**
* The full address string.
*/
@ApiMember(DataType="string", Description="The full address string.", Name="AddressFull", ParameterType="query")
open var AddressFull:String? = null
/**
* True if the address is a physical location.
*/
@ApiMember(DataType="bool?", Description="True if the address is a physical location.", Name="IsPhysical", ParameterType="query")
open var IsPhysical:Boolean? = null
/**
* Notes about the address.
*/
@ApiMember(DataType="string", Description="Notes about the address.", Name="Notes", ParameterType="query")
open var Notes:String? = null
/**
* 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")
open var AutoMapCoordinates:Boolean? = null
/**
* Location Coordinates for the address.
*/
@ApiMember(DataType="LocationCoordinates", Description="Location Coordinates for the address.", Name="LocationCoordinates", ParameterType="query")
open var LocationCoordinates:LocationCoordinatesModel? = null
}
open class LocationCoordinatesModel
{
/**
* 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")
open var Latitude:Double? = null
/**
* 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")
open var Longitude:Double? = null
/**
* 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")
open var Altitude:Double? = null
/**
* Accuracy of the latitude and longitude.
*/
@ApiMember(DataType="Double?", Description="Accuracy of the latitude and longitude.", Name="Accuracy", ParameterType="query")
open var Accuracy:Double? = null
/**
* Accurancy of the Altitude.
*/
@ApiMember(DataType="Double?", Description="Accurancy of the Altitude.", Name="AltitudeAccuracy", ParameterType="query")
open var AltitudeAccuracy:Double? = null
/**
* Direction you are heading.
*/
@ApiMember(DataType="Double?", Description="Direction you are heading.", Name="Heading", ParameterType="query")
open var Heading:Double? = null
/**
* Speed you are going.
*/
@ApiMember(DataType="Double?", Description="Speed you are going.", Name="Speed", ParameterType="query")
open var Speed:Double? = null
/**
* Speed your altitude is ascending/descending at.
*/
@ApiMember(DataType="Double?", Description="Speed your altitude is ascending/descending at.", Name="VerticalSpeed", ParameterType="query")
open var VerticalSpeed:Double? = null
}
open class SubscriptionObjectModel : ISubscription
{
/**
* Guid representing the external systems datasource information.
*/
@ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")
override var SuiteDataSourceInstanceId:UUID? = null
/**
* 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")
override var AlternateKey:String? = null
/**
* 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")
override var ObjectId:UUID? = null
/**
* 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")
open var RmsTableCtxId:UUID? = null
/**
* 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")
override var IgnoreValidation:Boolean? = null
}
open class DimensionValueModel
{
open var DimensionValueId:UUID? = null
open var DimensionId:UUID? = null
open var Name:String? = null
open var Description:String? = null
open var ShortName:String? = null
open var TrafficLightId:UUID? = null
open var TrafficLightColour:String? = null
open var ObjectConnectionId:UUID? = null
open var OwnerContactId:UUID? = null
open var RecordStatus:String? = null
}
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
}
}