GET | /Regions/{RegionID} | Retrieves a region. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RegionID | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RegionID | form | string | No | |
Name | form | string | No | |
IsDefault | form | bool? | No | |
Description | form | string | No | |
CreatedDateTime | form | DateTime? | No | |
LastSavedDateTime | form | DateTime? | No | |
CreatedByStaff | form | StaffMember | No | |
LastSavedByStaff | form | StaffMember | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
StaffID | form | string | No | |
Title | form | string | No | |
FirstName | form | string | No | |
Surname | form | string | No | |
Username | form | string | No | |
IsActive | form | bool? | No | |
IsEnabled | form | bool? | 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.
GET /Regions/{RegionID} HTTP/1.1 Host: api.jiwa.com.au Accept: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"RegionID":"String","Name":"String","IsDefault":false,"Description":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTime":"0001-01-01T00:00:00.0000000","CreatedByStaff":{"StaffID":"String","Title":"String","FirstName":"String","Surname":"String","Username":"String","IsActive":false,"IsEnabled":false},"LastSavedByStaff":{"StaffID":"String","Title":"String","FirstName":"String","Surname":"String","Username":"String","IsActive":false,"IsEnabled":false}}