JiwaAPI

<back to all web services

HR_APIKeyQuery

Requires Authentication
HR_APIKeyQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDqueryGuid?No
RecIDInqueryGuid[]No
NamequerystringNo
NameStartsWithquerystringNo
NameEndsWithquerystringNo
NameContainsquerystringNo
NameLikequerystringNo
NameBetweenquerystring[]No
NameInquerystring[]No
HR_Staff_StaffIDquerystringNo
HR_Staff_StaffIDStartsWithquerystringNo
HR_Staff_StaffIDEndsWithquerystringNo
HR_Staff_StaffIDContainsquerystringNo
HR_Staff_StaffIDLikequerystringNo
HR_Staff_StaffIDBetweenquerystring[]No
HR_Staff_StaffIDInquerystring[]No
CreatedDateTimequeryDateTime?No
CreatedDateTimeGreaterThanOrEqualToqueryDateTime?No
CreatedDateTimeGreaterThanqueryDateTime?No
CreatedDateTimeLessThanqueryDateTime?No
CreatedDateTimeLessThanOrEqualToqueryDateTime?No
CreatedDateTimeNotEqualToqueryDateTime?No
CreatedDateTimeBetweenqueryDateTime[]No
CreatedDateTimeInqueryDateTime[]No
ExpiryDateTimequeryDateTime?No
ExpiryDateTimeGreaterThanOrEqualToqueryDateTime?No
ExpiryDateTimeGreaterThanqueryDateTime?No
ExpiryDateTimeLessThanqueryDateTime?No
ExpiryDateTimeLessThanOrEqualToqueryDateTime?No
ExpiryDateTimeNotEqualToqueryDateTime?No
ExpiryDateTimeBetweenqueryNullable<DateTime>[]No
ExpiryDateTimeInqueryNullable<DateTime>[]No
CancelledDateTimequeryDateTime?No
CancelledDateTimeGreaterThanOrEqualToqueryDateTime?No
CancelledDateTimeGreaterThanqueryDateTime?No
CancelledDateTimeLessThanqueryDateTime?No
CancelledDateTimeLessThanOrEqualToqueryDateTime?No
CancelledDateTimeNotEqualToqueryDateTime?No
CancelledDateTimeBetweenqueryNullable<DateTime>[]No
CancelledDateTimeInqueryNullable<DateTime>[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
KeyValuequerystringNo
KeyValueStartsWithquerystringNo
KeyValueEndsWithquerystringNo
KeyValueContainsquerystringNo
KeyValueLikequerystringNo
KeyValueBetweenquerystring[]No
KeyValueInquerystring[]No
IsEnabledquerybool?No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
HR_APIKey Parameters:
NameParameterData TypeRequiredDescription
RecIDformGuidNo
NameformstringNo
HR_Staff_StaffIDformstringNo
CreatedDateTimeformDateTimeNo
ExpiryDateTimeformDateTime?No
CancelledDateTimeformDateTime?No
LastSavedDateTimeformDateTimeNo
KeyValueformstringNo
IsEnabledformboolNo
ItemNoformintNo
RowHashformbyte[]No
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/HR_APIKeyQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"RecID":"00000000000000000000000000000000","RecIDIn":["00000000-0000-0000-0000-000000000000"],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["String"],"HR_Staff_StaffID":"String","HR_Staff_StaffIDStartsWith":"String","HR_Staff_StaffIDEndsWith":"String","HR_Staff_StaffIDContains":"String","HR_Staff_StaffIDLike":"String","HR_Staff_StaffIDBetween":["String"],"HR_Staff_StaffIDIn":["String"],"CreatedDateTime":"0001-01-01T00:00:00.0000000","CreatedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","CreatedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","CreatedDateTimeLessThan":"0001-01-01T00:00:00.0000000","CreatedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","CreatedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","CreatedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"CreatedDateTimeIn":["0001-01-01T00:00:00.0000000"],"ExpiryDateTime":"0001-01-01T00:00:00.0000000","ExpiryDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","ExpiryDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","ExpiryDateTimeLessThan":"0001-01-01T00:00:00.0000000","ExpiryDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","ExpiryDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","ExpiryDateTimeBetween":["0001-01-01T00:00:00.0000000"],"ExpiryDateTimeIn":["0001-01-01T00:00:00.0000000"],"CancelledDateTime":"0001-01-01T00:00:00.0000000","CancelledDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","CancelledDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","CancelledDateTimeLessThan":"0001-01-01T00:00:00.0000000","CancelledDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","CancelledDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","CancelledDateTimeBetween":["0001-01-01T00:00:00.0000000"],"CancelledDateTimeIn":["0001-01-01T00:00:00.0000000"],"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastSavedDateTimeIn":["0001-01-01T00:00:00.0000000"],"KeyValue":"String","KeyValueStartsWith":"String","KeyValueEndsWith":"String","KeyValueContains":"String","KeyValueLike":"String","KeyValueBetween":["String"],"KeyValueIn":["String"],"IsEnabled":false,"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"RowHash":"AA==","Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"Name":"String","HR_Staff_StaffID":"String","ExpiryDateTime":"0001-01-01T00:00:00.0000000","CancelledDateTime":"0001-01-01T00:00:00.0000000","KeyValue":"String","RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}