Page Comparison

...

URL

http://test.birdsystem.co.ukcom/client/Temp-Consignment-Info/Convert-Into-Consignment/?ids=12010436_12010437&type=LOCAL&start=0

Method

get

Payload

-

Response

[Error]
Errors will be prompted one by one when occurred.

Code Block

language	js

{
    "numberOfTotalConsignmentsToProcess": 1,
    "numberOfConsignmentsProcessed": 1,
    "finished": true,
    "data": null,
    "errorIdList": [
        {
            "id": 12010439,
            "message": "Cannot find delivery service, please check."
        }
    ],
    "success": true,
    "refresh": false
}

[Success]

Code Block

language	js

{
    "numberOfTotalConsignmentsToProcess": 1,
    "numberOfConsignmentsProcessed": 1,
    "finished": true,
    "data": {
        "12010439": "1507310110000001"
    },
    "errorIdList": [],
    "success": true,
    "refresh": false
}

Response

explanation

numberOfTotalConsignmentsToProcess Total number of consignments to be converted
numberOfConsignmentsProcessed Total number of consignment converted in this request
finished Whether all consignments have been converted.
data In the example above '12010439' is the id of temp_consignment_info, '1507310110000001' is the id of converted 'consignment'

Parameters

Mandatory

Comment

ids

NO

temp_consignment_info ids imploded by "," (comma), if 'ids' is not given then system will default to all unprocessed records.

type

YES

LOCAL, RETURN or DIRECT, see Basic Concepts

start

YES

Default to 0

Currently up to 25 temp_consignment_info records will be processed during each request.

When 'finished' is 'false', you need to request again and set 'start' to be 'start+=numberOfConsignmentsProcessed' until 'finished' is 'true'

Versions Compared

Old Version 1

New Version Current

Key