| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FileID | query | string | No | |
| FileIDStartsWith | query | string | No | |
| FileIDEndsWith | query | string | No | |
| FileIDContains | query | string | No | |
| FileIDLike | query | string | No | |
| FileIDBetween | query | string[] | No | |
| FileIDIn | 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 | DateTime[] | No | |
| LastSavedDateTimeIn | query | DateTime[] | No | |
| PhysicalFileName | query | string | No | |
| PhysicalFileNameStartsWith | query | string | No | |
| PhysicalFileNameEndsWith | query | string | No | |
| PhysicalFileNameContains | query | string | No | |
| PhysicalFileNameLike | query | string | No | |
| PhysicalFileNameBetween | query | string[] | No | |
| PhysicalFileNameIn | query | string[] | No | |
| FullPhysicalFileName | query | string | No | |
| FullPhysicalFileNameStartsWith | query | string | No | |
| FullPhysicalFileNameEndsWith | query | string | No | |
| FullPhysicalFileNameContains | query | string | No | |
| FullPhysicalFileNameLike | query | string | No | |
| FullPhysicalFileNameBetween | query | string[] | No | |
| FullPhysicalFileNameIn | query | string[] | No | |
| FileDescription | query | string | No | |
| FileDescriptionStartsWith | query | string | No | |
| FileDescriptionEndsWith | query | string | No | |
| FileDescriptionContains | query | string | No | |
| FileDescriptionLike | query | string | No | |
| FileDescriptionBetween | query | string[] | No | |
| FileDescriptionIn | query | string[] | No | |
| FileInDB | query | bool? | No | |
| FileBinary | query | byte[] | No | |
| RowHash | query | byte[] | 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 |
|---|---|---|---|---|
| FileID | form | string | No | |
| LastSavedDateTime | form | DateTime | No | |
| PhysicalFileName | form | string | No | |
| FullPhysicalFileName | form | string | No | |
| FileDescription | form | string | No | |
| FileInDB | form | bool | No | |
| FileBinary | form | byte[] | No | |
| RowHash | form | byte[] | 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_FileQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"FileID":"String","FileIDStartsWith":"String","FileIDEndsWith":"String","FileIDContains":"String","FileIDLike":"String","FileIDBetween":["String"],"FileIDIn":["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"],"PhysicalFileName":"String","PhysicalFileNameStartsWith":"String","PhysicalFileNameEndsWith":"String","PhysicalFileNameContains":"String","PhysicalFileNameLike":"String","PhysicalFileNameBetween":["String"],"PhysicalFileNameIn":["String"],"FullPhysicalFileName":"String","FullPhysicalFileNameStartsWith":"String","FullPhysicalFileNameEndsWith":"String","FullPhysicalFileNameContains":"String","FullPhysicalFileNameLike":"String","FullPhysicalFileNameBetween":["String"],"FullPhysicalFileNameIn":["String"],"FileDescription":"String","FileDescriptionStartsWith":"String","FileDescriptionEndsWith":"String","FileDescriptionContains":"String","FileDescriptionLike":"String","FileDescriptionBetween":["String"],"FileDescriptionIn":["String"],"FileInDB":false,"FileBinary":"AA==","RowHash":"AA==","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":[{"FileID":"String","PhysicalFileName":"String","FullPhysicalFileName":"String","FileDescription":"String","FileBinary":"AA==","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"}}}