JiwaAPI

<back to all web services

RegionGETRequest

Requires Authentication
The following routes are available for this service:
GET/Regions/{RegionID}Retrieves a region.
RegionGETRequest Parameters:
NameParameterData TypeRequiredDescription
RegionIDpathstringNo
Region Parameters:
NameParameterData TypeRequiredDescription
RegionIDformstringNo
NameformstringNo
IsDefaultformbool?No
DescriptionformstringNo
CreatedDateTimeformDateTime?No
LastSavedDateTimeformDateTime?No
CreatedByStaffformStaffMemberNo
LastSavedByStaffformStaffMemberNo
StaffMember Parameters:
NameParameterData TypeRequiredDescription
StaffIDformstringNo
TitleformstringNo
FirstNameformstringNo
SurnameformstringNo
UsernameformstringNo
IsActiveformbool?No
IsEnabledformbool?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + 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}}