JiwaAPI

<back to all web services

v_Jiwa_LicencesQuery

Requires Authentication
v_Jiwa_LicencesQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
ResourceIDquerystringNo
ResourceIDStartsWithquerystringNo
ResourceIDEndsWithquerystringNo
ResourceIDContainsquerystringNo
ResourceIDLikequerystringNo
ResourceIDBetweenquerystring[]No
ResourceIDInquerystring[]No
ResourceNamequerystringNo
ResourceNameStartsWithquerystringNo
ResourceNameEndsWithquerystringNo
ResourceNameContainsquerystringNo
ResourceNameLikequerystringNo
ResourceNameBetweenquerystring[]No
ResourceNameInquerystring[]No
IssueDatequeryDateTime?No
IssueDateGreaterThanOrEqualToqueryDateTime?No
IssueDateGreaterThanqueryDateTime?No
IssueDateLessThanqueryDateTime?No
IssueDateLessThanOrEqualToqueryDateTime?No
IssueDateNotEqualToqueryDateTime?No
IssueDateBetweenqueryDateTime[]No
IssueDateInqueryDateTime[]No
ScopequerystringNo
ScopeStartsWithquerystringNo
ScopeEndsWithquerystringNo
ScopeContainsquerystringNo
ScopeLikequerystringNo
ScopeBetweenquerystring[]No
ScopeInquerystring[]No
NotequerystringNo
NoteStartsWithquerystringNo
NoteEndsWithquerystringNo
NoteContainsquerystringNo
NoteLikequerystringNo
NoteBetweenquerystring[]No
NoteInquerystring[]No
CommenceDatequeryDateTime?No
CommenceDateGreaterThanOrEqualToqueryDateTime?No
CommenceDateGreaterThanqueryDateTime?No
CommenceDateLessThanqueryDateTime?No
CommenceDateLessThanOrEqualToqueryDateTime?No
CommenceDateNotEqualToqueryDateTime?No
CommenceDateBetweenqueryDateTime[]No
CommenceDateInqueryDateTime[]No
ExpiryDatequeryDateTime?No
ExpiryDateGreaterThanOrEqualToqueryDateTime?No
ExpiryDateGreaterThanqueryDateTime?No
ExpiryDateLessThanqueryDateTime?No
ExpiryDateLessThanOrEqualToqueryDateTime?No
ExpiryDateNotEqualToqueryDateTime?No
ExpiryDateBetweenqueryDateTime[]No
ExpiryDateInqueryDateTime[]No
CALsqueryint?No
CALsGreaterThanOrEqualToqueryint?No
CALsGreaterThanqueryint?No
CALsLessThanqueryint?No
CALsLessThanOrEqualToqueryint?No
CALsNotEqualToqueryint?No
CALsBetweenqueryint[]No
CALsInqueryint[]No
Usedqueryint?No
UsedGreaterThanOrEqualToqueryint?No
UsedGreaterThanqueryint?No
UsedLessThanqueryint?No
UsedLessThanOrEqualToqueryint?No
UsedNotEqualToqueryint?No
UsedBetweenqueryNullable<Int32>[]No
UsedInqueryNullable<Int32>[]No
Unusedqueryint?No
UnusedGreaterThanOrEqualToqueryint?No
UnusedGreaterThanqueryint?No
UnusedLessThanqueryint?No
UnusedLessThanOrEqualToqueryint?No
UnusedNotEqualToqueryint?No
UnusedBetweenqueryNullable<Int32>[]No
UnusedInqueryNullable<Int32>[]No
VersionquerystringNo
VersionStartsWithquerystringNo
VersionEndsWithquerystringNo
VersionContainsquerystringNo
VersionLikequerystringNo
VersionBetweenquerystring[]No
VersionInquerystring[]No
SignaturequerystringNo
SignatureStartsWithquerystringNo
SignatureEndsWithquerystringNo
SignatureContainsquerystringNo
SignatureLikequerystringNo
SignatureBetweenquerystring[]No
SignatureInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_Jiwa_Licences Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
ResourceIDformstringNo
ResourceNameformstringNo
IssueDateformDateTimeNo
ScopeformstringNo
NoteformstringNo
CommenceDateformDateTimeNo
ExpiryDateformDateTimeNo
CALsformintNo
Usedformint?No
Unusedformint?No
VersionformstringNo
SignatureformstringNo
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.

POST /csv/reply/v_Jiwa_LicencesQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"ResourceID":"String","ResourceIDStartsWith":"String","ResourceIDEndsWith":"String","ResourceIDContains":"String","ResourceIDLike":"String","ResourceIDBetween":["String"],"ResourceIDIn":["String"],"ResourceName":"String","ResourceNameStartsWith":"String","ResourceNameEndsWith":"String","ResourceNameContains":"String","ResourceNameLike":"String","ResourceNameBetween":["String"],"ResourceNameIn":["String"],"IssueDate":"0001-01-01T00:00:00.0000000","IssueDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","IssueDateGreaterThan":"0001-01-01T00:00:00.0000000","IssueDateLessThan":"0001-01-01T00:00:00.0000000","IssueDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","IssueDateNotEqualTo":"0001-01-01T00:00:00.0000000","IssueDateBetween":["0001-01-01T00:00:00.0000000"],"IssueDateIn":["0001-01-01T00:00:00.0000000"],"Scope":"String","ScopeStartsWith":"String","ScopeEndsWith":"String","ScopeContains":"String","ScopeLike":"String","ScopeBetween":["String"],"ScopeIn":["String"],"Note":"String","NoteStartsWith":"String","NoteEndsWith":"String","NoteContains":"String","NoteLike":"String","NoteBetween":["String"],"NoteIn":["String"],"CommenceDate":"0001-01-01T00:00:00.0000000","CommenceDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","CommenceDateGreaterThan":"0001-01-01T00:00:00.0000000","CommenceDateLessThan":"0001-01-01T00:00:00.0000000","CommenceDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","CommenceDateNotEqualTo":"0001-01-01T00:00:00.0000000","CommenceDateBetween":["0001-01-01T00:00:00.0000000"],"CommenceDateIn":["0001-01-01T00:00:00.0000000"],"ExpiryDate":"0001-01-01T00:00:00.0000000","ExpiryDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","ExpiryDateGreaterThan":"0001-01-01T00:00:00.0000000","ExpiryDateLessThan":"0001-01-01T00:00:00.0000000","ExpiryDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","ExpiryDateNotEqualTo":"0001-01-01T00:00:00.0000000","ExpiryDateBetween":["0001-01-01T00:00:00.0000000"],"ExpiryDateIn":["0001-01-01T00:00:00.0000000"],"CALs":0,"CALsGreaterThanOrEqualTo":0,"CALsGreaterThan":0,"CALsLessThan":0,"CALsLessThanOrEqualTo":0,"CALsNotEqualTo":0,"CALsBetween":[0],"CALsIn":[0],"Used":0,"UsedGreaterThanOrEqualTo":0,"UsedGreaterThan":0,"UsedLessThan":0,"UsedLessThanOrEqualTo":0,"UsedNotEqualTo":0,"UsedBetween":[0],"UsedIn":[0],"Unused":0,"UnusedGreaterThanOrEqualTo":0,"UnusedGreaterThan":0,"UnusedLessThan":0,"UnusedLessThanOrEqualTo":0,"UnusedNotEqualTo":0,"UnusedBetween":[0],"UnusedIn":[0],"Version":"String","VersionStartsWith":"String","VersionEndsWith":"String","VersionContains":"String","VersionLike":"String","VersionBetween":["String"],"VersionIn":["String"],"Signature":"String","SignatureStartsWith":"String","SignatureEndsWith":"String","SignatureContains":"String","SignatureLike":"String","SignatureBetween":["String"],"SignatureIn":["String"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"RecID":"String","ResourceID":"String","ResourceName":"String","Scope":"String","Note":"String","Used":0,"Unused":0,"Version":"String","Signature":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}