JiwaAPI

<back to all web services

SY_LicenceUsageQuery

Requires Authentication
SY_LicenceUsageQuery Parameters:
NameParameterData TypeRequiredDescription
SY_Licence_RecIDquerystringNo
SY_Licence_RecIDStartsWithquerystringNo
SY_Licence_RecIDEndsWithquerystringNo
SY_Licence_RecIDContainsquerystringNo
SY_Licence_RecIDLikequerystringNo
SY_Licence_RecIDBetweenquerystring[]No
SY_Licence_RecIDInquerystring[]No
HR_Staff_StaffIDquerystringNo
HR_Staff_StaffIDStartsWithquerystringNo
HR_Staff_StaffIDEndsWithquerystringNo
HR_Staff_StaffIDContainsquerystringNo
HR_Staff_StaffIDLikequerystringNo
HR_Staff_StaffIDBetweenquerystring[]No
HR_Staff_StaffIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_LicenceUsage Parameters:
NameParameterData TypeRequiredDescription
SY_Licence_RecIDformstringNo
HR_Staff_StaffIDformstringNo
LastSavedDateTimeformDateTimeNo
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/SY_LicenceUsageQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"SY_Licence_RecID":"String","SY_Licence_RecIDStartsWith":"String","SY_Licence_RecIDEndsWith":"String","SY_Licence_RecIDContains":"String","SY_Licence_RecIDLike":"String","SY_Licence_RecIDBetween":["String"],"SY_Licence_RecIDIn":["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"],"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"],"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":[{"SY_Licence_RecID":"String","HR_Staff_StaffID":"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"}}}