Platform Subscription API

<back to all web services

SaveProject

Inserts or Updates a project details and its contact connections and addresses.

Requires Authentication
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription;
using Eros.Saguna.Common.Library.ValidationEngine;
using Eros.Saguna.Common.WebAPI.ServiceModel;
using Eros.Saguna.Common.WebAPIModel.Models;

namespace Eros.Saguna.Common.Library.ValidationEngine
{
    public partial class RuleValidationResult
    {
        public virtual string RuleCode { get; set; }
        public virtual string Message { get; set; }
        public virtual string Key { get; set; }
        public virtual string Tag { get; set; }
        public virtual string ErrorCode { get; set; }
    }

    public partial class ValidationErrorList
    {
        public virtual List<RuleValidationResult> ValidationErrors { get; set; }
    }

}

namespace Eros.Saguna.Common.WebAPI.ServiceModel
{
    public partial class 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")]
        public virtual double DistanceAway { 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")]
        public virtual double Latitude { 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")]
        public virtual double Longitude { 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")]
        public virtual Guid AddressFormatId { 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")]
        public virtual Guid SuburbId { get; set; }

        ///<summary>
        ///The suburb name.
        ///</summary>
        [ApiMember(DataType="string", Description="The suburb name.", Name="SuburbName", ParameterType="query")]
        public virtual string SuburbName { 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")]
        public virtual string StateShortName { get; set; }

        ///<summary>
        ///The suburb postcode.
        ///</summary>
        [ApiMember(DataType="string", Description="The suburb postcode.", Name="PostCode", ParameterType="query")]
        public virtual string PostCode { 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")]
        public virtual Guid CountryId { 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")]
        public virtual string CountryName { 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")]
        public virtual string ISOCountryCode { get; set; }

        ///<summary>
        ///The address Lot number.
        ///</summary>
        [ApiMember(DataType="string", Description="The address Lot number.", Name="LotNumber", ParameterType="query")]
        public virtual string LotNumber { get; set; }

        ///<summary>
        ///The address Sub Unit number.
        ///</summary>
        [ApiMember(DataType="string", Description="The address Sub Unit number.", Name="SubUnit", ParameterType="query")]
        public virtual string SubUnit { get; set; }

        ///<summary>
        ///The address building number.
        ///</summary>
        [ApiMember(DataType="string", Description="The address building number.", Name="BuildingNumber", ParameterType="query")]
        public virtual string BuildingNumber { get; set; }

        ///<summary>
        ///The address street number.
        ///</summary>
        [ApiMember(DataType="string", Description="The address street number.", Name="StreetNumber", ParameterType="query")]
        public virtual string StreetNumber { 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")]
        public virtual string StreetName { get; set; }

        ///<summary>
        ///A formatted address Line 1.
        ///</summary>
        [ApiMember(DataType="string", Description="A formatted address Line 1.", Name="AddressLineOne", ParameterType="query")]
        public virtual string AddressLineOne { get; set; }

        ///<summary>
        ///A formatted address Line 2.
        ///</summary>
        [ApiMember(DataType="string", Description="A formatted address Line 2.", Name="AddressLineTwo", ParameterType="query")]
        public virtual string AddressLineTwo { get; set; }

        ///<summary>
        ///The full address string.
        ///</summary>
        [ApiMember(DataType="string", Description="The full address string.", Name="AddressFull", ParameterType="query")]
        public virtual string AddressFull { 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")]
        public virtual bool? IsPhysical { get; set; }

        ///<summary>
        ///Notes about the address.
        ///</summary>
        [ApiMember(DataType="string", Description="Notes about the address.", Name="Notes", ParameterType="query")]
        public virtual string Notes { 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")]
        public virtual bool? AutoMapCoordinates { get; set; }

        ///<summary>
        ///Location Coordinates for the address.
        ///</summary>
        [ApiMember(DataType="LocationCoordinates", Description="Location Coordinates for the address.", Name="LocationCoordinates", ParameterType="query")]
        public virtual LocationCoordinatesModel LocationCoordinates { get; set; }
    }

    public partial class 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")]
        public virtual double Latitude { 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")]
        public virtual double Longitude { 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")]
        public virtual double? Altitude { get; set; }

        ///<summary>
        ///Accuracy of the latitude and longitude.
        ///</summary>
        [ApiMember(DataType="Double?", Description="Accuracy of the latitude and longitude.", Name="Accuracy", ParameterType="query")]
        public virtual double? Accuracy { get; set; }

        ///<summary>
        ///Accurancy of the Altitude.
        ///</summary>
        [ApiMember(DataType="Double?", Description="Accurancy of the Altitude.", Name="AltitudeAccuracy", ParameterType="query")]
        public virtual double? AltitudeAccuracy { get; set; }

        ///<summary>
        ///Direction you are heading.
        ///</summary>
        [ApiMember(DataType="Double?", Description="Direction you are heading.", Name="Heading", ParameterType="query")]
        public virtual double? Heading { get; set; }

        ///<summary>
        ///Speed you are going.
        ///</summary>
        [ApiMember(DataType="Double?", Description="Speed you are going.", Name="Speed", ParameterType="query")]
        public virtual double? Speed { 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")]
        public virtual double? VerticalSpeed { get; set; }
    }

    public partial class 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")]
        public virtual string Reference { get; set; }

        ///<summary>
        ///A name for the project.
        ///</summary>
        [ApiMember(DataType="string", Description="A name for the project.", IsRequired=true, Name="Name", ParameterType="query")]
        public virtual string Name { get; set; }

        ///<summary>
        ///A description for the project.
        ///</summary>
        [ApiMember(DataType="string", Description="A description for the project.", IsRequired=true, Name="Description", ParameterType="query")]
        public virtual string Description { 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")]
        public virtual List<SubscriptionLinkContact> ProjectContacts { get; set; }

        ///<summary>
        ///An address for the project.
        ///</summary>
        [ApiMember(DataType="AddressModel", Description="An address for the project.", Name="ProjectAddress", ParameterType="query")]
        public virtual AddressModel ProjectAddress { 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")]
        public virtual SubscriptionObjectModel CustomerContactGroup { get; set; }

        ///<summary>
        ///Project Group Name.
        ///</summary>
        [ApiMember(DataType="string", Description="Project Group Name.", Name="GroupName", ParameterType="query")]
        public virtual string GroupName { get; set; }

        ///<summary>
        ///Stage Name.
        ///</summary>
        [ApiMember(DataType="string", Description="Stage Name.", Name="StageName", ParameterType="query")]
        public virtual string StageName { 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")]
        public virtual Guid PrimaryProjectImageId { 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")]
        public virtual string PrimaryProjectPhotoUrl { 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")]
        public virtual string PrimaryProjectThumbnailUrl { get; set; }

        ///<summary>
        ///Image height of the projects logo.
        ///</summary>
        [ApiMember(DataType="int", Description="Image height of the projects logo.", Name="PrimaryProjectPhotoHeight", ParameterType="query")]
        public virtual int PrimaryProjectPhotoHeight { get; set; }

        ///<summary>
        ///Image height of the projects logo.
        ///</summary>
        [ApiMember(DataType="int", Description="Image height of the projects logo.", Name="PrimaryProjectPhotoWidth", ParameterType="query")]
        public virtual int PrimaryProjectPhotoWidth { get; set; }

        ///<summary>
        ///Dynamically linked content.
        ///</summary>
        [ApiMember(DataType="string", Description="Dynamically linked content.", Name="DynamicContent", ParameterType="query")]
        public virtual string DynamicContent { 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")]
        public virtual Char DocumentableObjectConnection { 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")]
        public virtual List<DimensionValueModel> DimensionValues { 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")]
        public virtual List<Guid> Calendars { get; set; }

        ///<summary>
        ///The Document Site ID.
        ///</summary>
        [ApiMember(DataType="Guid", Description="The Document Site ID.", Name="DocumentSiteId", ParameterType="query")]
        public virtual Guid? DocumentSiteId { get; set; }

        public virtual Guid ObjectSubscriptionId { get; set; }
        public virtual string ObjectHash { get; set; }
    }

    public partial class 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")]
        public virtual Guid ContactId { 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")]
        public virtual string ContactAlternateKey { 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")]
        public virtual Guid RoleId { 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")]
        public virtual string RoleAlternateKey { get; set; }
    }

    public partial class SubscriptionObjectModel
        : ISubscription
    {
        ///<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")]
        public virtual Guid SuiteDataSourceInstanceId { 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")]
        public virtual string AlternateKey { 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")]
        public virtual Guid ObjectId { 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")]
        public virtual Guid RmsTableCtxId { 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")]
        public virtual bool IgnoreValidation { get; set; }
    }

}

namespace Eros.Saguna.Common.WebAPIModel.Models
{
    public partial class DimensionValueModel
    {
        public virtual Guid DimensionValueId { get; set; }
        public virtual Guid DimensionId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Description { get; set; }
        public virtual string ShortName { get; set; }
        public virtual Guid TrafficLightId { get; set; }
        public virtual string TrafficLightColour { get; set; }
        public virtual Guid ObjectConnectionId { get; set; }
        public virtual Guid OwnerContactId { get; set; }
        public virtual string RecordStatus { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription
{
    ///<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.")]
    public partial class SaveProject
        : ValidationErrorList, ISubscription
    {
        ///<summary>
        ///Guid representing the external systems datasource information.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId")]
        public virtual Guid SuiteDataSourceInstanceId { 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")]
        public virtual string AlternateKey { 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")]
        public virtual Guid ObjectId { 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")]
        public virtual bool IgnoreHash { get; set; }

        public virtual bool IgnoreValidation { 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")]
        public virtual SubscriptionCommonProjectModel Project { get; set; }

        public virtual Guid LicenseeId { get; set; }
        public virtual Guid SessionId { get; set; }
    }

}

C# SaveProject DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
	}
}