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 |
---|---|---|---|---|
Id | form | long | No | |
DateTime | form | DateTime | No | |
StatusCode | form | int | No | |
StatusDescription | form | string | No | |
HttpMethod | form | string | No | |
AbsoluteUri | form | string | No | |
PathInfo | form | string | No | |
RequestBody | form | string | No | |
RequestDto | form | Object | No | |
UserAuthId | form | string | No | |
SessionId | form | string | No | |
IpAddress | form | string | No | |
ForwardedFor | form | string | No | |
Referer | form | string | No | |
Headers | form | Dictionary<string, string> | No | |
FormData | form | Dictionary<string, string> | No | |
Items | form | Dictionary<string, string> | No | |
Session | form | Object | No | |
ResponseDto | form | Object | No | |
ErrorResponse | form | Object | No | |
ExceptionSource | form | string | No | |
ExceptionData | form | IDictionary | No | |
RequestDuration | form | TimeSpan | 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/TodayLogsGETManyRequest HTTP/1.1
Host: api.jiwa.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"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":[{"StatusDescription":"String","HttpMethod":"String","AbsoluteUri":"String","PathInfo":"String","RequestBody":"String","RequestDto":{},"UserAuthId":"String","SessionId":"String","IpAddress":"String","ForwardedFor":"String","Referer":"String","Headers":{"String":"String"},"FormData":{"String":"String"},"Items":{"String":"String"},"Session":{},"ResponseDto":{},"ErrorResponse":{},"ExceptionSource":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}