Platform API

SaveDimensionValue

Add or update a dimension values details.

The following routes are available for this service:
PUT	/api/dimensionvalues/{DimensionValueId}
POST	/api/dimensionvalues

**SaveDimensionValue** Parameters:
Name	Parameter	Data Type	Required	Description
DimensionValue	body	DimensionValueModel	Yes	Details of the dimension value to be added or updated.
DimensionValueId	path	Guid	Yes	Id of the dimension value.

**DimensionValueModel** Parameters:
Name	Parameter	Data Type	Required	Description
DimensionValueId	body	Guid	No	Id of the dimension value.
DimensionId	body	Guid	No	Dimension Id this value is for.
Name	body	string	No	Name of the dimension value.
Description	body	string	No	Description of the dimension value.
ShortName	body	string	No	Short Name for the dimension value.
TrafficLightId	body	Guid	No	Id of the colour associated.
TrafficLightColour	body	string	No	Colour associated with the dimension value.
ObjectConnectionId	body	Guid	No	Id that links this dimension value to an object.
OwnerContactId	body	Guid	No	Owner Id of the dimension value.
RecordStatus	body	string	No	Record status of the dimension value.

**SaveDimensionValueResponse** Parameters:
Name	Parameter	Data Type	Required	Description
DimensionValueId	query	Guid	No	Id of the Dimension Value created.
ResponseStatus	form	ResponseStatus	No

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 /api/dimensionvalues HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	DimensionValue: 
	{
		Name: String,
		Description: String,
		ShortName: String,
		TrafficLightColour: String,
		RecordStatus: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}