| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClassName | query | string | No | |
| ClassNameStartsWith | query | string | No | |
| ClassNameEndsWith | query | string | No | |
| ClassNameContains | query | string | No | |
| ClassNameLike | query | string | No | |
| ClassNameBetween | query | string[] | No | |
| ClassNameIn | 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 | |
| FormType | query | int? | No | |
| FormTypeGreaterThanOrEqualTo | query | int? | No | |
| FormTypeGreaterThan | query | int? | No | |
| FormTypeLessThan | query | int? | No | |
| FormTypeLessThanOrEqualTo | query | int? | No | |
| FormTypeNotEqualTo | query | int? | No | |
| FormTypeBetween | query | Nullable<Int32>[] | No | |
| FormTypeIn | query | Nullable<Int32>[] | No | |
| HelpFileName | query | string | No | |
| HelpFileNameStartsWith | query | string | No | |
| HelpFileNameEndsWith | query | string | No | |
| HelpFileNameContains | query | string | No | |
| HelpFileNameLike | query | string | No | |
| HelpFileNameBetween | query | string[] | No | |
| HelpFileNameIn | query | string[] | No | |
| HelpPageName | query | string | No | |
| HelpPageNameStartsWith | query | string | No | |
| HelpPageNameEndsWith | query | string | No | |
| HelpPageNameContains | query | string | No | |
| HelpPageNameLike | query | string | No | |
| HelpPageNameBetween | query | string[] | No | |
| HelpPageNameIn | query | string[] | No | |
| AssemblyFullName | query | string | No | |
| AssemblyFullNameStartsWith | query | string | No | |
| AssemblyFullNameEndsWith | query | string | No | |
| AssemblyFullNameContains | query | string | No | |
| AssemblyFullNameLike | query | string | No | |
| AssemblyFullNameBetween | query | string[] | No | |
| AssemblyFullNameIn | 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 |
|---|---|---|---|---|
| ClassName | form | string | No | |
| Description | form | string | No | |
| FormType | form | int? | No | |
| HelpFileName | form | string | No | |
| HelpPageName | form | string | No | |
| AssemblyFullName | 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_FormsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ClassName":"String","ClassNameStartsWith":"String","ClassNameEndsWith":"String","ClassNameContains":"String","ClassNameLike":"String","ClassNameBetween":["String"],"ClassNameIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"FormType":0,"FormTypeGreaterThanOrEqualTo":0,"FormTypeGreaterThan":0,"FormTypeLessThan":0,"FormTypeLessThanOrEqualTo":0,"FormTypeNotEqualTo":0,"FormTypeBetween":[0],"FormTypeIn":[0],"HelpFileName":"String","HelpFileNameStartsWith":"String","HelpFileNameEndsWith":"String","HelpFileNameContains":"String","HelpFileNameLike":"String","HelpFileNameBetween":["String"],"HelpFileNameIn":["String"],"HelpPageName":"String","HelpPageNameStartsWith":"String","HelpPageNameEndsWith":"String","HelpPageNameContains":"String","HelpPageNameLike":"String","HelpPageNameBetween":["String"],"HelpPageNameIn":["String"],"AssemblyFullName":"String","AssemblyFullNameStartsWith":"String","AssemblyFullNameEndsWith":"String","AssemblyFullNameContains":"String","AssemblyFullNameLike":"String","AssemblyFullNameBetween":["String"],"AssemblyFullNameIn":["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":[{"ClassName":"String","Description":"String","FormType":0,"HelpFileName":"String","HelpPageName":"String","AssemblyFullName":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}