| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | string | No | |
| RecIDStartsWith | query | string | No | |
| RecIDEndsWith | query | string | No | |
| RecIDContains | query | string | No | |
| RecIDLike | query | string | No | |
| RecIDBetween | query | string[] | No | |
| RecIDIn | query | string[] | No | |
| ResourceID | query | string | No | |
| ResourceIDStartsWith | query | string | No | |
| ResourceIDEndsWith | query | string | No | |
| ResourceIDContains | query | string | No | |
| ResourceIDLike | query | string | No | |
| ResourceIDBetween | query | string[] | No | |
| ResourceIDIn | query | string[] | No | |
| ResourceName | query | string | No | |
| ResourceNameStartsWith | query | string | No | |
| ResourceNameEndsWith | query | string | No | |
| ResourceNameContains | query | string | No | |
| ResourceNameLike | query | string | No | |
| ResourceNameBetween | query | string[] | No | |
| ResourceNameIn | query | string[] | No | |
| IssueDate | query | DateTime? | No | |
| IssueDateGreaterThanOrEqualTo | query | DateTime? | No | |
| IssueDateGreaterThan | query | DateTime? | No | |
| IssueDateLessThan | query | DateTime? | No | |
| IssueDateLessThanOrEqualTo | query | DateTime? | No | |
| IssueDateNotEqualTo | query | DateTime? | No | |
| IssueDateBetween | query | DateTime[] | No | |
| IssueDateIn | query | DateTime[] | No | |
| Scope | query | string | No | |
| ScopeStartsWith | query | string | No | |
| ScopeEndsWith | query | string | No | |
| ScopeContains | query | string | No | |
| ScopeLike | query | string | No | |
| ScopeBetween | query | string[] | No | |
| ScopeIn | query | string[] | No | |
| Note | query | string | No | |
| NoteStartsWith | query | string | No | |
| NoteEndsWith | query | string | No | |
| NoteContains | query | string | No | |
| NoteLike | query | string | No | |
| NoteBetween | query | string[] | No | |
| NoteIn | query | string[] | No | |
| CommenceDate | query | DateTime? | No | |
| CommenceDateGreaterThanOrEqualTo | query | DateTime? | No | |
| CommenceDateGreaterThan | query | DateTime? | No | |
| CommenceDateLessThan | query | DateTime? | No | |
| CommenceDateLessThanOrEqualTo | query | DateTime? | No | |
| CommenceDateNotEqualTo | query | DateTime? | No | |
| CommenceDateBetween | query | DateTime[] | No | |
| CommenceDateIn | query | DateTime[] | No | |
| ExpiryDate | query | DateTime? | No | |
| ExpiryDateGreaterThanOrEqualTo | query | DateTime? | No | |
| ExpiryDateGreaterThan | query | DateTime? | No | |
| ExpiryDateLessThan | query | DateTime? | No | |
| ExpiryDateLessThanOrEqualTo | query | DateTime? | No | |
| ExpiryDateNotEqualTo | query | DateTime? | No | |
| ExpiryDateBetween | query | DateTime[] | No | |
| ExpiryDateIn | query | DateTime[] | No | |
| CALs | query | int? | No | |
| CALsGreaterThanOrEqualTo | query | int? | No | |
| CALsGreaterThan | query | int? | No | |
| CALsLessThan | query | int? | No | |
| CALsLessThanOrEqualTo | query | int? | No | |
| CALsNotEqualTo | query | int? | No | |
| CALsBetween | query | int[] | No | |
| CALsIn | query | int[] | No | |
| Version | query | string | No | |
| VersionStartsWith | query | string | No | |
| VersionEndsWith | query | string | No | |
| VersionContains | query | string | No | |
| VersionLike | query | string | No | |
| VersionBetween | query | string[] | No | |
| VersionIn | query | string[] | No | |
| CompanyName | query | string | No | |
| CompanyNameStartsWith | query | string | No | |
| CompanyNameEndsWith | query | string | No | |
| CompanyNameContains | query | string | No | |
| CompanyNameLike | query | string | No | |
| CompanyNameBetween | query | string[] | No | |
| CompanyNameIn | query | string[] | No | |
| Signature | query | string | No | |
| SignatureStartsWith | query | string | No | |
| SignatureEndsWith | query | string | No | |
| SignatureContains | query | string | No | |
| SignatureLike | query | string | No | |
| SignatureBetween | query | string[] | No | |
| SignatureIn | query | string[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | form | string | No | |
| ResourceID | form | string | No | |
| ResourceName | form | string | No | |
| IssueDate | form | DateTime | No | |
| Scope | form | string | No | |
| Note | form | string | No | |
| CommenceDate | form | DateTime | No | |
| ExpiryDate | form | DateTime | No | |
| CALs | form | int | No | |
| Version | form | string | No | |
| CompanyName | form | string | No | |
| Signature | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/SY_LicenceQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/json
Content-Type: application/json
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],"Version":"String","VersionStartsWith":"String","VersionEndsWith":"String","VersionContains":"String","VersionLike":"String","VersionBetween":["String"],"VersionIn":["String"],"CompanyName":"String","CompanyNameStartsWith":"String","CompanyNameEndsWith":"String","CompanyNameContains":"String","CompanyNameLike":"String","CompanyNameBetween":["String"],"CompanyNameIn":["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: application/json
Content-Length: length
{"Results":[{"RecID":"String","ResourceID":"String","ResourceName":"String","Scope":"String","Note":"String","Version":"String","CompanyName":"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"}}}