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 | |
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 | |
HR_Skills_RecID | query | string | No | |
HR_Skills_RecIDStartsWith | query | string | No | |
HR_Skills_RecIDEndsWith | query | string | No | |
HR_Skills_RecIDContains | query | string | No | |
HR_Skills_RecIDLike | query | string | No | |
HR_Skills_RecIDBetween | query | string[] | No | |
HR_Skills_RecIDIn | query | string[] | No | |
HR_SkillRatings_RecID | query | string | No | |
HR_SkillRatings_RecIDStartsWith | query | string | No | |
HR_SkillRatings_RecIDEndsWith | query | string | No | |
HR_SkillRatings_RecIDContains | query | string | No | |
HR_SkillRatings_RecIDLike | query | string | No | |
HR_SkillRatings_RecIDBetween | query | string[] | No | |
HR_SkillRatings_RecIDIn | query | string[] | No | |
QualificationDate | query | DateTime? | No | |
QualificationDateGreaterThanOrEqualTo | query | DateTime? | No | |
QualificationDateGreaterThan | query | DateTime? | No | |
QualificationDateLessThan | query | DateTime? | No | |
QualificationDateLessThanOrEqualTo | query | DateTime? | No | |
QualificationDateNotEqualTo | query | DateTime? | No | |
QualificationDateBetween | query | DateTime[] | No | |
QualificationDateIn | query | DateTime[] | No | |
Notes | query | string | No | |
NotesStartsWith | query | string | No | |
NotesEndsWith | query | string | No | |
NotesContains | query | string | No | |
NotesLike | query | string | No | |
NotesBetween | query | string[] | No | |
NotesIn | 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 | string | No | |
HR_Staff_RecID | form | string | No | |
HR_Skills_RecID | form | string | No | |
HR_SkillRatings_RecID | form | string | No | |
QualificationDate | form | DateTime | No | |
Notes | 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/HR_StaffSkillsQuery 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"],"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"],"HR_Skills_RecID":"String","HR_Skills_RecIDStartsWith":"String","HR_Skills_RecIDEndsWith":"String","HR_Skills_RecIDContains":"String","HR_Skills_RecIDLike":"String","HR_Skills_RecIDBetween":["String"],"HR_Skills_RecIDIn":["String"],"HR_SkillRatings_RecID":"String","HR_SkillRatings_RecIDStartsWith":"String","HR_SkillRatings_RecIDEndsWith":"String","HR_SkillRatings_RecIDContains":"String","HR_SkillRatings_RecIDLike":"String","HR_SkillRatings_RecIDBetween":["String"],"HR_SkillRatings_RecIDIn":["String"],"QualificationDate":"0001-01-01T00:00:00.0000000","QualificationDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","QualificationDateGreaterThan":"0001-01-01T00:00:00.0000000","QualificationDateLessThan":"0001-01-01T00:00:00.0000000","QualificationDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","QualificationDateNotEqualTo":"0001-01-01T00:00:00.0000000","QualificationDateBetween":["0001-01-01T00:00:00.0000000"],"QualificationDateIn":["0001-01-01T00:00:00.0000000"],"Notes":"String","NotesStartsWith":"String","NotesEndsWith":"String","NotesContains":"String","NotesLike":"String","NotesBetween":["String"],"NotesIn":["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":[{"RecID":"String","HR_Staff_RecID":"String","HR_Skills_RecID":"String","HR_SkillRatings_RecID":"String","Notes":"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"}}}