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 | |
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 | |
BM_Shift_RecID | query | string | No | |
BM_Shift_RecIDStartsWith | query | string | No | |
BM_Shift_RecIDEndsWith | query | string | No | |
BM_Shift_RecIDContains | query | string | No | |
BM_Shift_RecIDLike | query | string | No | |
BM_Shift_RecIDBetween | query | string[] | No | |
BM_Shift_RecIDIn | query | string[] | No | |
Name | query | string | No | |
NameStartsWith | query | string | No | |
NameEndsWith | query | string | No | |
NameContains | query | string | No | |
NameLike | query | string | No | |
NameBetween | query | string[] | No | |
NameIn | query | string[] | No | |
IsWorkDay | query | bool? | No | |
StartDateTime | query | DateTime? | No | |
StartDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
StartDateTimeGreaterThan | query | DateTime? | No | |
StartDateTimeLessThan | query | DateTime? | No | |
StartDateTimeLessThanOrEqualTo | query | DateTime? | No | |
StartDateTimeNotEqualTo | query | DateTime? | No | |
StartDateTimeBetween | query | Nullable<DateTime>[] | No | |
StartDateTimeIn | query | Nullable<DateTime>[] | No | |
EndDateTime | query | DateTime? | No | |
EndDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
EndDateTimeGreaterThan | query | DateTime? | No | |
EndDateTimeLessThan | query | DateTime? | No | |
EndDateTimeLessThanOrEqualTo | query | DateTime? | No | |
EndDateTimeNotEqualTo | query | DateTime? | No | |
EndDateTimeBetween | query | Nullable<DateTime>[] | No | |
EndDateTimeIn | query | Nullable<DateTime>[] | 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 | |
ItemNo | form | int | No | |
BM_Shift_RecID | form | string | No | |
Name | form | string | No | |
IsWorkDay | form | bool | No | |
StartDateTime | form | DateTime? | No | |
EndDateTime | form | DateTime? | 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/BM_ShiftWeekdayQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"BM_Shift_RecID":"String","BM_Shift_RecIDStartsWith":"String","BM_Shift_RecIDEndsWith":"String","BM_Shift_RecIDContains":"String","BM_Shift_RecIDLike":"String","BM_Shift_RecIDBetween":["String"],"BM_Shift_RecIDIn":["String"],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["String"],"IsWorkDay":false,"StartDateTime":"0001-01-01T00:00:00.0000000","StartDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","StartDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","StartDateTimeLessThan":"0001-01-01T00:00:00.0000000","StartDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","StartDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","StartDateTimeBetween":["0001-01-01T00:00:00.0000000"],"StartDateTimeIn":["0001-01-01T00:00:00.0000000"],"EndDateTime":"0001-01-01T00:00:00.0000000","EndDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","EndDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","EndDateTimeLessThan":"0001-01-01T00:00:00.0000000","EndDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","EndDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","EndDateTimeBetween":["0001-01-01T00:00:00.0000000"],"EndDateTimeIn":["0001-01-01T00:00:00.0000000"],"RowHash":"AA==","Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"Results":[{"RecID":"String","BM_Shift_RecID":"String","Name":"String","StartDateTime":"0001-01-01T00:00:00.0000000","EndDateTime":"0001-01-01T00:00:00.0000000","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"}}}