| POST | /api/dimensions | ||
|---|---|---|---|
| PUT | /api/dimensions/{DimensionId} |
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Add or update a dimensions details.
*/
@Api(Description="Add or update a dimensions details.")
open class SaveDimension
{
/**
* Details of the dimension to be added or updated.
*/
@ApiMember(DataType="DimensionModel", Description="Details of the dimension to be added or updated.", IsRequired=true, Name="Dimension")
open var Dimension:DimensionModel? = null
/**
* Id of the dimension.
*/
@ApiMember(DataType="Guid", Description="Id of the dimension.", IsRequired=true, Name="DimensionId")
open var DimensionId:UUID? = null
}
open class DimensionModel
{
/**
* Id of the Dimension itself.
*/
@ApiMember(DataType="Guid", Description="Id of the Dimension itself.", Name="DimensionId")
open var DimensionId:UUID? = null
/**
* Dimension name.
*/
@ApiMember(DataType="string", Description="Dimension name.", Name="Name")
open var Name:String? = null
/**
* Dimension description.
*/
@ApiMember(DataType="string", Description="Dimension description.", Name="Description")
open var Description:String? = null
/**
* Dimension shortened name.
*/
@ApiMember(DataType="string", Description="Dimension shortened name.", Name="ShortName")
open var ShortName:String? = null
/**
* True if the values for the dimension should have colours associated with them.
*/
@ApiMember(DataType="bool", Description="True if the values for the dimension should have colours associated with them.", Name="HasTrafficLightForValues")
open var HasTrafficLightForValues:Boolean? = null
/**
*
*/
@ApiMember(DataType="bool", Description="", Name="HasImage")
open var HasImage:Boolean? = null
/**
* Owner Id of the dimension.
*/
@ApiMember(DataType="Guid", Description="Owner Id of the dimension.", Name="OwnerContactId")
open var OwnerContactId:UUID? = null
/**
* Record status of the dimension.
*/
@ApiMember(DataType="string", Description="Record status of the dimension.", Name="RecordStatus")
open var RecordStatus:String? = null
/**
* Dimension values for this dimension.
*/
@ApiMember(DataType="List<DimensionValueModel>", Description="Dimension values for this dimension.", Name="DimensionValues")
open var DimensionValues:ArrayList<DimensionValueModel>? = null
/**
* Id that links this dimension to an object.
*/
@ApiMember(Description="Id that links this dimension to an object.")
open var ObjectConnectionId:UUID? = null
}
open class DimensionValueModel
{
/**
* Id of the dimension value.
*/
@ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")
open var DimensionValueId:UUID? = null
/**
* Dimension Id this value is for.
*/
@ApiMember(Description="Dimension Id this value is for.", ParameterType="body")
open var DimensionId:UUID? = null
/**
* Name of the dimension value.
*/
@ApiMember(Description="Name of the dimension value.", ParameterType="body")
open var Name:String? = null
/**
* Description of the dimension value.
*/
@ApiMember(Description="Description of the dimension value.", ParameterType="body")
open var Description:String? = null
/**
* Short Name for the dimension value.
*/
@ApiMember(Description="Short Name for the dimension value.", ParameterType="body")
open var ShortName:String? = null
/**
* Id of the colour associated.
*/
@ApiMember(Description="Id of the colour associated.", ParameterType="body")
open var TrafficLightId:UUID? = null
/**
* Colour associated with the dimension value.
*/
@ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")
open var TrafficLightColour:String? = null
/**
* Id that links this dimension value to an object.
*/
@ApiMember(Description="Id that links this dimension value to an object.", ParameterType="body")
open var ObjectConnectionId:UUID? = null
/**
* Owner Id of the dimension value.
*/
@ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")
open var OwnerContactId:UUID? = null
/**
* Record status of the dimension value.
*/
@ApiMember(Description="Record status of the dimension value.", ParameterType="body")
open var RecordStatus:String? = null
}
@ApiResponse(Description="Success of the create/update of the dimension")
open class SaveDimensionResponse
{
/**
* Id of the Dimension created.
*/
@ApiMember(DataType="Guid", Description="Id of the Dimension created.", Name="DimensionId", ParameterType="query")
open var DimensionId:UUID? = null
open var ResponseStatus:ResponseStatus? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/dimensions HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Dimension":{"DimensionId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","HasTrafficLightForValues":false,"HasImage":false,"OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String","DimensionValues":[{"DimensionValueId":"00000000-0000-0000-0000-000000000000","DimensionId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","TrafficLightId":"00000000-0000-0000-0000-000000000000","TrafficLightColour":"String","ObjectConnectionId":"00000000-0000-0000-0000-000000000000","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"}],"ObjectConnectionId":"00000000-0000-0000-0000-000000000000"},"DimensionId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"DimensionId":"00000000-0000-0000-0000-000000000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}