| All Verbs | /api/timezones |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Timezones | form | DataListModel | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ListId | query | Guid | Yes | Guid of the List PKID. |
| Name | query | String | No | Name of the list. |
| OwnerContactId | query | Guid | No | The owner of this item. |
| DataListItems | query | List<DataListItemModel> | No | List Items in the list. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ListItemId | query | Guid | Yes | Guid of the list item PKID. |
| Name | query | string | No | Name of the list item. |
| ShortName | query | string | No | Short Version Name of the list item. |
| PrimaryImagePath | query | string | No | The primary image url |
| RecordStatus | query | string | No | Record Status of the List Item (A=Active, I=Inactive, D=Deleted). |
| Order | query | int | No | The order (if any) of this item in the list. |
| OwnerContactId | query | Guid | No | The owner of this item. |
| ExtraValues | form | List<Object> | No |
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 /api/timezones HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Timezones:
{
Name: String,
DataListItems:
[
{
Name: String,
ShortName: String,
PrimaryImagePath: String,
RecordStatus: String,
Order: 0,
ExtraValues:
[
{
}
]
}
]
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}