| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PKID | query | string | No | |
| PKIDStartsWith | query | string | No | |
| PKIDEndsWith | query | string | No | |
| PKIDContains | query | string | No | |
| PKIDLike | query | string | No | |
| PKIDBetween | query | string[] | No | |
| PKIDIn | query | string[] | No | |
| SourceDocDesc | query | string | No | |
| SourceDocDescStartsWith | query | string | No | |
| SourceDocDescEndsWith | query | string | No | |
| SourceDocDescContains | query | string | No | |
| SourceDocDescLike | query | string | No | |
| SourceDocDescBetween | query | string[] | No | |
| SourceDocDescIn | query | string[] | No | |
| SourceDocID | query | string | No | |
| SourceDocIDStartsWith | query | string | No | |
| SourceDocIDEndsWith | query | string | No | |
| SourceDocIDContains | query | string | No | |
| SourceDocIDLike | query | string | No | |
| SourceDocIDBetween | query | string[] | No | |
| SourceDocIDIn | query | string[] | No | |
| DestDocDesc | query | string | No | |
| DestDocDescStartsWith | query | string | No | |
| DestDocDescEndsWith | query | string | No | |
| DestDocDescContains | query | string | No | |
| DestDocDescLike | query | string | No | |
| DestDocDescBetween | query | string[] | No | |
| DestDocDescIn | query | string[] | No | |
| DestDocID | query | string | No | |
| DestDocIDStartsWith | query | string | No | |
| DestDocIDEndsWith | query | string | No | |
| DestDocIDContains | query | string | No | |
| DestDocIDLike | query | string | No | |
| DestDocIDBetween | query | string[] | No | |
| DestDocIDIn | query | string[] | No | |
| LinkDescriptor | query | string | No | |
| LinkDescriptorStartsWith | query | string | No | |
| LinkDescriptorEndsWith | query | string | No | |
| LinkDescriptorContains | query | string | No | |
| LinkDescriptorLike | query | string | No | |
| LinkDescriptorBetween | query | string[] | No | |
| LinkDescriptorIn | query | string[] | No | |
| LastSavedDateTime | query | DateTime? | No | |
| LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeGreaterThan | query | DateTime? | No | |
| LastSavedDateTimeLessThan | query | DateTime? | No | |
| LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
| LastSavedDateTimeBetween | query | Nullable<DateTime>[] | No | |
| LastSavedDateTimeIn | query | Nullable<DateTime>[] | No | |
| DateCreated | query | DateTime? | No | |
| DateCreatedGreaterThanOrEqualTo | query | DateTime? | No | |
| DateCreatedGreaterThan | query | DateTime? | No | |
| DateCreatedLessThan | query | DateTime? | No | |
| DateCreatedLessThanOrEqualTo | query | DateTime? | No | |
| DateCreatedNotEqualTo | query | DateTime? | No | |
| DateCreatedBetween | query | Nullable<DateTime>[] | No | |
| DateCreatedIn | query | Nullable<DateTime>[] | No | |
| StaffID | query | string | No | |
| StaffIDStartsWith | query | string | No | |
| StaffIDEndsWith | query | string | No | |
| StaffIDContains | query | string | No | |
| StaffIDLike | query | string | No | |
| StaffIDBetween | query | string[] | No | |
| StaffIDIn | query | string[] | No | |
| StaffName | query | string | No | |
| StaffNameStartsWith | query | string | No | |
| StaffNameEndsWith | query | string | No | |
| StaffNameContains | query | string | No | |
| StaffNameLike | query | string | No | |
| StaffNameBetween | query | string[] | No | |
| StaffNameIn | 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 |
|---|---|---|---|---|
| PKID | form | string | No | |
| SourceDocDesc | form | string | No | |
| SourceDocID | form | string | No | |
| DestDocDesc | form | string | No | |
| DestDocID | form | string | No | |
| LinkDescriptor | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| DateCreated | form | DateTime? | No | |
| StaffID | form | string | No | |
| StaffName | 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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/SY_DocumentLinksQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"PKID":"String","PKIDStartsWith":"String","PKIDEndsWith":"String","PKIDContains":"String","PKIDLike":"String","PKIDBetween":["String"],"PKIDIn":["String"],"SourceDocDesc":"String","SourceDocDescStartsWith":"String","SourceDocDescEndsWith":"String","SourceDocDescContains":"String","SourceDocDescLike":"String","SourceDocDescBetween":["String"],"SourceDocDescIn":["String"],"SourceDocID":"String","SourceDocIDStartsWith":"String","SourceDocIDEndsWith":"String","SourceDocIDContains":"String","SourceDocIDLike":"String","SourceDocIDBetween":["String"],"SourceDocIDIn":["String"],"DestDocDesc":"String","DestDocDescStartsWith":"String","DestDocDescEndsWith":"String","DestDocDescContains":"String","DestDocDescLike":"String","DestDocDescBetween":["String"],"DestDocDescIn":["String"],"DestDocID":"String","DestDocIDStartsWith":"String","DestDocIDEndsWith":"String","DestDocIDContains":"String","DestDocIDLike":"String","DestDocIDBetween":["String"],"DestDocIDIn":["String"],"LinkDescriptor":"String","LinkDescriptorStartsWith":"String","LinkDescriptorEndsWith":"String","LinkDescriptorContains":"String","LinkDescriptorLike":"String","LinkDescriptorBetween":["String"],"LinkDescriptorIn":["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"],"DateCreated":"0001-01-01T00:00:00.0000000","DateCreatedGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateCreatedGreaterThan":"0001-01-01T00:00:00.0000000","DateCreatedLessThan":"0001-01-01T00:00:00.0000000","DateCreatedLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateCreatedNotEqualTo":"0001-01-01T00:00:00.0000000","DateCreatedBetween":["0001-01-01T00:00:00.0000000"],"DateCreatedIn":["0001-01-01T00:00:00.0000000"],"StaffID":"String","StaffIDStartsWith":"String","StaffIDEndsWith":"String","StaffIDContains":"String","StaffIDLike":"String","StaffIDBetween":["String"],"StaffIDIn":["String"],"StaffName":"String","StaffNameStartsWith":"String","StaffNameEndsWith":"String","StaffNameContains":"String","StaffNameLike":"String","StaffNameBetween":["String"],"StaffNameIn":["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":[{"PKID":"String","SourceDocDesc":"String","SourceDocID":"String","DestDocDesc":"String","DestDocID":"String","LinkDescriptor":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","DateCreated":"0001-01-01T00:00:00.0000000","StaffID":"String","StaffName":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}