All Verbs | /Command/ |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Auth | query | string | No | |
CommandName | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
start | form | DateTime | No | |
DeviceUUID | form | string | No | |
APIKey | form | string | No | |
isAdmin | form | bool | No | |
Cmd | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
res | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Result | form | bool | No | |
ResMessage | form | string | No | |
Error | form | Error | No | |
PageInfo | form | BasePageInfo | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ErrorYn | form | bool | No | |
ExYn | form | bool | No | |
ErrorCode | form | string | No | |
ErrorDescription | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TotalRecordCount | form | int | No | |
TotalPageCount | form | int | No | |
CurrentPage | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
res | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Command/ HTTP/1.1
Host: baseservices.needion.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Auth: String,
CommandName: String,
start: 0001-01-01,
DeviceUUID: String,
APIKey: String,
isAdmin: False,
Cmd: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { res: String, Result: False, ResMessage: String, Error: { ErrorYn: False, ExYn: False, ErrorCode: String, ErrorDescription: String }, PageInfo: { TotalRecordCount: 0, TotalPageCount: 0, CurrentPage: 0 } }