| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | Guid? | No | |
| RecIDIn | query | Guid[] | No | |
| Title | query | string | No | |
| TitleStartsWith | query | string | No | |
| TitleEndsWith | query | string | No | |
| TitleContains | query | string | No | |
| TitleLike | query | string | No | |
| TitleBetween | query | string[] | No | |
| TitleIn | query | string[] | No | |
| Description | query | string | No | |
| DescriptionStartsWith | query | string | No | |
| DescriptionEndsWith | query | string | No | |
| DescriptionContains | query | string | No | |
| DescriptionLike | query | string | No | |
| DescriptionBetween | query | string[] | No | |
| DescriptionIn | query | string[] | No | |
| Shortcut | query | string | No | |
| ShortcutStartsWith | query | string | No | |
| ShortcutEndsWith | query | string | No | |
| ShortcutContains | query | string | No | |
| ShortcutLike | query | string | No | |
| ShortcutBetween | query | string[] | No | |
| ShortcutIn | query | string[] | No | |
| Author | query | string | No | |
| AuthorStartsWith | query | string | No | |
| AuthorEndsWith | query | string | No | |
| AuthorContains | query | string | No | |
| AuthorLike | query | string | No | |
| AuthorBetween | query | string[] | No | |
| AuthorIn | query | string[] | No | |
| IsEnabled | query | bool? | No | |
| Code | query | string | No | |
| CodeStartsWith | query | string | No | |
| CodeEndsWith | query | string | No | |
| CodeContains | query | string | No | |
| CodeLike | query | string | No | |
| CodeBetween | query | string[] | No | |
| CodeIn | query | string[] | No | |
| Language | query | byte? | No | |
| LanguageGreaterThanOrEqualTo | query | byte? | No | |
| LanguageGreaterThan | query | byte? | No | |
| LanguageLessThan | query | byte? | No | |
| LanguageLessThanOrEqualTo | query | byte? | No | |
| LanguageNotEqualTo | query | byte? | No | |
| LanguageBetween | query | byte[] | No | |
| LanguageIn | query | byte[] | No | |
| FolderPath | query | string | No | |
| FolderPathStartsWith | query | string | No | |
| FolderPathEndsWith | query | string | No | |
| FolderPathContains | query | string | No | |
| FolderPathLike | query | string | No | |
| FolderPathBetween | query | string[] | No | |
| FolderPathIn | query | string[] | No | |
| SnippetTypes | query | string | No | |
| SnippetTypesStartsWith | query | string | No | |
| SnippetTypesEndsWith | query | string | No | |
| SnippetTypesContains | query | string | No | |
| SnippetTypesLike | query | string | No | |
| SnippetTypesBetween | query | string[] | No | |
| SnippetTypesIn | query | string[] | No | |
| RowHash | query | byte[] | 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 |
| 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 | |
| Title | form | string | No | |
| Description | form | string | No | |
| Shortcut | form | string | No | |
| Author | form | string | No | |
| IsEnabled | form | bool | No | |
| Code | form | string | No | |
| Language | form | byte | No | |
| FolderPath | form | string | No | |
| SnippetTypes | form | string | No | |
| RowHash | form | byte[] | No | |
| LastSavedDateTime | form | DateTime | 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_PluginSnippetQuery 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"],"Title":"String","TitleStartsWith":"String","TitleEndsWith":"String","TitleContains":"String","TitleLike":"String","TitleBetween":["String"],"TitleIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"Shortcut":"String","ShortcutStartsWith":"String","ShortcutEndsWith":"String","ShortcutContains":"String","ShortcutLike":"String","ShortcutBetween":["String"],"ShortcutIn":["String"],"Author":"String","AuthorStartsWith":"String","AuthorEndsWith":"String","AuthorContains":"String","AuthorLike":"String","AuthorBetween":["String"],"AuthorIn":["String"],"IsEnabled":false,"Code":"String","CodeStartsWith":"String","CodeEndsWith":"String","CodeContains":"String","CodeLike":"String","CodeBetween":["String"],"CodeIn":["String"],"Language":0,"LanguageGreaterThanOrEqualTo":0,"LanguageGreaterThan":0,"LanguageLessThan":0,"LanguageLessThanOrEqualTo":0,"LanguageNotEqualTo":0,"LanguageBetween":"AA==","LanguageIn":"AA==","FolderPath":"String","FolderPathStartsWith":"String","FolderPathEndsWith":"String","FolderPathContains":"String","FolderPathLike":"String","FolderPathBetween":["String"],"FolderPathIn":["String"],"SnippetTypes":"String","SnippetTypesStartsWith":"String","SnippetTypesEndsWith":"String","SnippetTypesContains":"String","SnippetTypesLike":"String","SnippetTypesBetween":["String"],"SnippetTypesIn":["String"],"RowHash":"AA==","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"],"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":[{"Title":"String","Description":"String","Shortcut":"String","Author":"String","Code":"String","FolderPath":"String","SnippetTypes":"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"}}}