| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | Guid? | No | |
| RecIDIn | query | Guid[] | No | |
| SY_PluginSnippet_RecID | query | Guid? | No | |
| SY_PluginSnippet_RecIDIn | query | Guid[] | No | |
| ID | query | string | No | |
| IDStartsWith | query | string | No | |
| IDEndsWith | query | string | No | |
| IDContains | query | string | No | |
| IDLike | query | string | No | |
| IDBetween | query | string[] | No | |
| IDIn | query | string[] | No | |
| Type | query | string | No | |
| TypeStartsWith | query | string | No | |
| TypeEndsWith | query | string | No | |
| TypeContains | query | string | No | |
| TypeLike | query | string | No | |
| TypeBetween | query | string[] | No | |
| TypeIn | query | string[] | No | |
| Tooltip | query | string | No | |
| TooltipStartsWith | query | string | No | |
| TooltipEndsWith | query | string | No | |
| TooltipContains | query | string | No | |
| TooltipLike | query | string | No | |
| TooltipBetween | query | string[] | No | |
| TooltipIn | query | string[] | No | |
| Default | query | string | No | |
| DefaultStartsWith | query | string | No | |
| DefaultEndsWith | query | string | No | |
| DefaultContains | query | string | No | |
| DefaultLike | query | string | No | |
| DefaultBetween | query | string[] | No | |
| DefaultIn | query | string[] | No | |
| ItemNo | query | int? | No | |
| ItemNoGreaterThanOrEqualTo | query | int? | No | |
| ItemNoGreaterThan | query | int? | No | |
| ItemNoLessThan | query | int? | No | |
| ItemNoLessThanOrEqualTo | query | int? | No | |
| ItemNoNotEqualTo | query | int? | No | |
| ItemNoBetween | query | int[] | No | |
| ItemNoIn | query | int[] | 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 |
|---|---|---|---|---|
| RecID | form | Guid | No | |
| SY_PluginSnippet_RecID | form | Guid | No | |
| ID | form | string | No | |
| Type | form | string | No | |
| Tooltip | form | string | No | |
| Default | form | string | No | |
| ItemNo | form | int | 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_PluginSnippetDeclarationQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RecID":"00000000000000000000000000000000","RecIDIn":["00000000-0000-0000-0000-000000000000"],"SY_PluginSnippet_RecID":"00000000000000000000000000000000","SY_PluginSnippet_RecIDIn":["00000000-0000-0000-0000-000000000000"],"ID":"String","IDStartsWith":"String","IDEndsWith":"String","IDContains":"String","IDLike":"String","IDBetween":["String"],"IDIn":["String"],"Type":"String","TypeStartsWith":"String","TypeEndsWith":"String","TypeContains":"String","TypeLike":"String","TypeBetween":["String"],"TypeIn":["String"],"Tooltip":"String","TooltipStartsWith":"String","TooltipEndsWith":"String","TooltipContains":"String","TooltipLike":"String","TooltipBetween":["String"],"TooltipIn":["String"],"Default":"String","DefaultStartsWith":"String","DefaultEndsWith":"String","DefaultContains":"String","DefaultLike":"String","DefaultBetween":["String"],"DefaultIn":["String"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"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":[{"ID":"String","Type":"String","Tooltip":"String","Default":"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"}}}