JiwaAPI

<back to all web services

IN_RegionQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/IN_RegionRetrieves a list of regions.
IN_RegionQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
NamequerystringNo
NameStartsWithquerystringNo
NameEndsWithquerystringNo
NameContainsquerystringNo
NameLikequerystringNo
NameBetweenquerystring[]No
NameInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
IsDefaultquerybool?No
HR_Staff_RecID_CreatedByquerystringNo
HR_Staff_RecID_CreatedByStartsWithquerystringNo
HR_Staff_RecID_CreatedByEndsWithquerystringNo
HR_Staff_RecID_CreatedByContainsquerystringNo
HR_Staff_RecID_CreatedByLikequerystringNo
HR_Staff_RecID_CreatedByBetweenquerystring[]No
HR_Staff_RecID_CreatedByInquerystring[]No
CreatedDateTimequeryDateTime?No
CreatedDateTimeGreaterThanOrEqualToqueryDateTime?No
CreatedDateTimeGreaterThanqueryDateTime?No
CreatedDateTimeLessThanqueryDateTime?No
CreatedDateTimeLessThanOrEqualToqueryDateTime?No
CreatedDateTimeNotEqualToqueryDateTime?No
CreatedDateTimeBetweenqueryDateTime[]No
CreatedDateTimeInqueryDateTime[]No
HR_Staff_RecID_LastSavedByquerystringNo
HR_Staff_RecID_LastSavedByStartsWithquerystringNo
HR_Staff_RecID_LastSavedByEndsWithquerystringNo
HR_Staff_RecID_LastSavedByContainsquerystringNo
HR_Staff_RecID_LastSavedByLikequerystringNo
HR_Staff_RecID_LastSavedByBetweenquerystring[]No
HR_Staff_RecID_LastSavedByInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
IN_Region Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
NameformstringNo
DescriptionformstringNo
IsDefaultformboolNo
HR_Staff_RecID_CreatedByformstringNo
CreatedDateTimeformDateTimeNo
HR_Staff_RecID_LastSavedByformstringNo
LastSavedDateTimeformDateTimeNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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 /Queries/IN_Region HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"RecID":"String","Name":"String","Description":"String","HR_Staff_RecID_CreatedBy":"String","HR_Staff_RecID_LastSavedBy":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}