Formats for Sending Data to Input

The successfully executed requests return the 200 OK response code, except for cases of load resume.

Responses with the 4XX codes contain descriptions of errors in the JSON format, for example:

{
    "code": 123,
    "description": "Incorrect value of parameter fruit_id. Must be positive integer."
}

Request Parameter Sending Errors

Request parameters are sent with the Content-type header: application/json.

If the Content-Type header is not sent or application/json is not specified on sending input parameters, the error is displayed:

{
    {"code": 1017, "description": "Data is sent without the Content-Type header with the value: \"application/json\". Request contents cannot be parsed."}
}

If parameter type transformation error occurred, and the mobile platform does not have specified format, the error is displayed:

{
    {"description": "Error trying to transform parameter type: "Parameter name". Row number: "Row No". Attribute name: "Attribute name". Parameter type: "Searched type", "code": 6000}
}

If parameter type transformation error occurred, and the mobile platform contains specified format, the error is displayed:

{
    {"description": "Error trying to transform parameter type: "Parameter name". Row number: "Row No". Attribute name: "Attribute name". Parameter type: "Searched type". The parameter must have the following format: "Format", "code": 6000}
}

Example:

  1. The sent data:

{"IM_UPSERT_ROWS":[[null, "801", "150075", "5", "7", "0", "045104100045690000", "5800", "0001596325", null, null, null, null, "IT", "IT", "1", "1", "KZ", null, "0", "X", null, "0", null, null, "X", "2017-02-13", "12:44:09", "37202-15", "0", "KG", "7", null, null, "2017-02-03", "5003086817", "7", null, "PRINTER PDF-FORMS", "TV", "702", "001", "5500027245", "X", null, "0", null, "20", "20", "0", "20", "20", "0", "458886", null, "005", "000", "N2-10-1", null, null, "0", null, "20", "20", "0", "20", "20", "0", "459166", null, null, null, null, null, "0", "0", "0", "0", "0", "0", "0", null, null, null, "0", "0", "0", null, "A 655 492 05 40*collar", null, null, null, null, null, null, null, null, null, "0", null, null, null, null, "0", null, "20", null, "4", null, null, "0", "0", null, null, null, null, "1801", "0", null, null, "0", null, null, null, "0", null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, "00000000000000000000000000000000", "00000000000000000000000000000000", "00000000000000000000000000000000", "00000000000000000000000000000000", "0", null, null]]}

  1. The returned error:

{"description": "Error trying to transform parameter type: "IM_UPSERT_ROWS". Attribute name: "UTVERZHD_TIME". Parameter type: "TIMS". Row number: "1 (if it was sent for the first time, and there is no other data)". The parameter must have the following format: "hh:mm:ss.S", "code": 6000}

Table Resource Parameters

Scalar and table input parameters:

{
    "scalar_param": 123,
    "table_param": <table_rows>
}

Scalar input table parameters are also used to determine a method for adding input parameters using mobile application state. If the parameter is not accessible, it must be removed from table resource description.

Table rows

Table delta

List of resources with structure description

Resource Description

Table resource description (SAP, Oracle, MS SQL Server, JSON)

WEB resource description

WebDAV resource description

Table Structure

[
    {"column_name_1": <data_type_description_1>},
    {"column_name_2": <data_type_description_2>},
    ...
]

Data Type Description

{
    "HyperHive": "text",
    "format": "<format>"
}

NOTE. Numeric parameters for data type from source are not supported.

The "format" field is optional and contains records in the format: <YYYY-MM-DD>.

List of Logs

[
  {
    "time": "2012-04-23T18:25:43.511Z",
    "level": "info",
    "data": "Watermelon weight is edited"
  },
  ...
]

Field value constraints:

See also:

Server API | Special Headers