Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | query | string | No | |
RecIDStartsWith | query | string | No | |
RecIDEndsWith | query | string | No | |
RecIDContains | query | string | No | |
RecIDLike | query | string | No | |
RecIDBetween | query | string[] | No | |
RecIDIn | query | string[] | No | |
SY_Forms_ClassName | query | string | No | |
SY_Forms_ClassNameStartsWith | query | string | No | |
SY_Forms_ClassNameEndsWith | query | string | No | |
SY_Forms_ClassNameContains | query | string | No | |
SY_Forms_ClassNameLike | query | string | No | |
SY_Forms_ClassNameBetween | query | string[] | No | |
SY_Forms_ClassNameIn | query | string[] | No | |
HR_Staff_RecID | query | string | No | |
HR_Staff_RecIDStartsWith | query | string | No | |
HR_Staff_RecIDEndsWith | query | string | No | |
HR_Staff_RecIDContains | query | string | No | |
HR_Staff_RecIDLike | query | string | No | |
HR_Staff_RecIDBetween | query | string[] | No | |
HR_Staff_RecIDIn | query | string[] | No | |
WindowState | query | byte? | No | |
WindowStateGreaterThanOrEqualTo | query | byte? | No | |
WindowStateGreaterThan | query | byte? | No | |
WindowStateLessThan | query | byte? | No | |
WindowStateLessThanOrEqualTo | query | byte? | No | |
WindowStateNotEqualTo | query | byte? | No | |
WindowStateBetween | query | byte[] | No | |
WindowStateIn | query | byte[] | No | |
Top | query | int? | No | |
TopGreaterThanOrEqualTo | query | int? | No | |
TopGreaterThan | query | int? | No | |
TopLessThan | query | int? | No | |
TopLessThanOrEqualTo | query | int? | No | |
TopNotEqualTo | query | int? | No | |
TopBetween | query | int[] | No | |
TopIn | query | int[] | No | |
Left | query | int? | No | |
LeftGreaterThanOrEqualTo | query | int? | No | |
LeftGreaterThan | query | int? | No | |
LeftLessThan | query | int? | No | |
LeftLessThanOrEqualTo | query | int? | No | |
LeftNotEqualTo | query | int? | No | |
LeftBetween | query | int[] | No | |
LeftIn | query | int[] | No | |
Width | query | int? | No | |
WidthGreaterThanOrEqualTo | query | int? | No | |
WidthGreaterThan | query | int? | No | |
WidthLessThan | query | int? | No | |
WidthLessThanOrEqualTo | query | int? | No | |
WidthNotEqualTo | query | int? | No | |
WidthBetween | query | int[] | No | |
WidthIn | query | int[] | No | |
Height | query | int? | No | |
HeightGreaterThanOrEqualTo | query | int? | No | |
HeightGreaterThan | query | int? | No | |
HeightLessThan | query | int? | No | |
HeightLessThanOrEqualTo | query | int? | No | |
HeightNotEqualTo | query | int? | No | |
HeightBetween | query | int[] | No | |
HeightIn | query | int[] | No | |
Context | query | string | No | |
ContextStartsWith | query | string | No | |
ContextEndsWith | query | string | No | |
ContextContains | query | string | No | |
ContextLike | query | string | No | |
ContextBetween | query | string[] | No | |
ContextIn | query | string[] | No | |
Floating | query | bool? | 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 | string | No | |
SY_Forms_ClassName | form | string | No | |
HR_Staff_RecID | form | string | No | |
WindowState | form | byte | No | |
Top | form | int | No | |
Left | form | int | No | |
Width | form | int | No | |
Height | form | int | No | |
Context | form | string | No | |
Floating | form | bool? | 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_FormSettingsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"SY_Forms_ClassName":"String","SY_Forms_ClassNameStartsWith":"String","SY_Forms_ClassNameEndsWith":"String","SY_Forms_ClassNameContains":"String","SY_Forms_ClassNameLike":"String","SY_Forms_ClassNameBetween":["String"],"SY_Forms_ClassNameIn":["String"],"HR_Staff_RecID":"String","HR_Staff_RecIDStartsWith":"String","HR_Staff_RecIDEndsWith":"String","HR_Staff_RecIDContains":"String","HR_Staff_RecIDLike":"String","HR_Staff_RecIDBetween":["String"],"HR_Staff_RecIDIn":["String"],"WindowState":0,"WindowStateGreaterThanOrEqualTo":0,"WindowStateGreaterThan":0,"WindowStateLessThan":0,"WindowStateLessThanOrEqualTo":0,"WindowStateNotEqualTo":0,"WindowStateBetween":"AA==","WindowStateIn":"AA==","Top":0,"TopGreaterThanOrEqualTo":0,"TopGreaterThan":0,"TopLessThan":0,"TopLessThanOrEqualTo":0,"TopNotEqualTo":0,"TopBetween":[0],"TopIn":[0],"Left":0,"LeftGreaterThanOrEqualTo":0,"LeftGreaterThan":0,"LeftLessThan":0,"LeftLessThanOrEqualTo":0,"LeftNotEqualTo":0,"LeftBetween":[0],"LeftIn":[0],"Width":0,"WidthGreaterThanOrEqualTo":0,"WidthGreaterThan":0,"WidthLessThan":0,"WidthLessThanOrEqualTo":0,"WidthNotEqualTo":0,"WidthBetween":[0],"WidthIn":[0],"Height":0,"HeightGreaterThanOrEqualTo":0,"HeightGreaterThan":0,"HeightLessThan":0,"HeightLessThanOrEqualTo":0,"HeightNotEqualTo":0,"HeightBetween":[0],"HeightIn":[0],"Context":"String","ContextStartsWith":"String","ContextEndsWith":"String","ContextContains":"String","ContextLike":"String","ContextBetween":["String"],"ContextIn":["String"],"Floating":false,"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":[{"RecID":"String","SY_Forms_ClassName":"String","HR_Staff_RecID":"String","Context":"String","Floating":false}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}