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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Region xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Regions">
  <_x003C_CreatedByStaff_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Staff">
    <d2p1:_x003C_FirstName_x003E_k__BackingField>String</d2p1:_x003C_FirstName_x003E_k__BackingField>
    <d2p1:_x003C_IsActive_x003E_k__BackingField>false</d2p1:_x003C_IsActive_x003E_k__BackingField>
    <d2p1:_x003C_IsEnabled_x003E_k__BackingField>false</d2p1:_x003C_IsEnabled_x003E_k__BackingField>
    <d2p1:_x003C_StaffID_x003E_k__BackingField>String</d2p1:_x003C_StaffID_x003E_k__BackingField>
    <d2p1:_x003C_Surname_x003E_k__BackingField>String</d2p1:_x003C_Surname_x003E_k__BackingField>
    <d2p1:_x003C_Title_x003E_k__BackingField>String</d2p1:_x003C_Title_x003E_k__BackingField>
    <d2p1:_x003C_Username_x003E_k__BackingField>String</d2p1:_x003C_Username_x003E_k__BackingField>
  </_x003C_CreatedByStaff_x003E_k__BackingField>
  <_x003C_CreatedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_CreatedDateTime_x003E_k__BackingField>
  <_x003C_Description_x003E_k__BackingField>String</_x003C_Description_x003E_k__BackingField>
  <_x003C_IsDefault_x003E_k__BackingField>false</_x003C_IsDefault_x003E_k__BackingField>
  <_x003C_LastSavedByStaff_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Staff">
    <d2p1:_x003C_FirstName_x003E_k__BackingField>String</d2p1:_x003C_FirstName_x003E_k__BackingField>
    <d2p1:_x003C_IsActive_x003E_k__BackingField>false</d2p1:_x003C_IsActive_x003E_k__BackingField>
    <d2p1:_x003C_IsEnabled_x003E_k__BackingField>false</d2p1:_x003C_IsEnabled_x003E_k__BackingField>
    <d2p1:_x003C_StaffID_x003E_k__BackingField>String</d2p1:_x003C_StaffID_x003E_k__BackingField>
    <d2p1:_x003C_Surname_x003E_k__BackingField>String</d2p1:_x003C_Surname_x003E_k__BackingField>
    <d2p1:_x003C_Title_x003E_k__BackingField>String</d2p1:_x003C_Title_x003E_k__BackingField>
    <d2p1:_x003C_Username_x003E_k__BackingField>String</d2p1:_x003C_Username_x003E_k__BackingField>
  </_x003C_LastSavedByStaff_x003E_k__BackingField>
  <_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastSavedDateTime_x003E_k__BackingField>
  <_x003C_Name_x003E_k__BackingField>String</_x003C_Name_x003E_k__BackingField>
  <_x003C_RegionID_x003E_k__BackingField>String</_x003C_RegionID_x003E_k__BackingField>
</Region>