| POST | /api/dimensions | ||
|---|---|---|---|
| PUT | /api/dimensions/{DimensionId} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Dimension | body | DimensionModel | Yes | Details of the dimension to be added or updated. |
| DimensionId | path | Guid | Yes | Id of the dimension. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DimensionId | form | Guid | No | Id of the Dimension itself. |
| Name | form | string | No | Dimension name. |
| Description | form | string | No | Dimension description. |
| ShortName | form | string | No | Dimension shortened name. |
| HasTrafficLightForValues | form | bool | No | True if the values for the dimension should have colours associated with them. |
| HasImage | form | bool | No | |
| OwnerContactId | form | Guid | No | Owner Id of the dimension. |
| RecordStatus | form | string | No | Record status of the dimension. |
| DimensionValues | form | List<DimensionValueModel> | No | Dimension values for this dimension. |
| ObjectConnectionId | form | Guid | No | Id that links this dimension to an object. |
| 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DimensionId | query | Guid | No | Id of the Dimension created. |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
Content-Type: text/csv
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: text/csv
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"}}}