CIQIP REST API

Get manufacturer

Obtaining manufacturer list.

GET /api/manufacturer
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
Example Response
{
    "manufacturer": [
        {
            "id": 1,
            "name": "Norco Cooperative Ltd"
        },
        {
            "id": 2,
            "name": "The a2 Milk Company (Australia) Pty Ltd"
        }
    ]
}

Get manufacturer info

Obtaining manufacturer detailed information.

GET /api/manufacturer/:manufacturer_id
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
manufacturer_id string Required: manufacturer's id
Example Response
{
    "manufacturer": {
        "info": {
            "id": 1,
            "name": "Norco Cooperative Ltd"
        },
        "address": [
            {
                "id": 1,
                "name": "Norco Cooperative Ltd",
                "address": "107 Wilson Street, South Lismore, NSW 2480, Australia",
                "CNCA": ""
            }
        ],
        "product": [
            {
                "id": 1,
                "name": "Norco Milk Full Cream 1 Litre",
                "GTIN": "09310272008361",
                "spec": "1L/bottle"
            }
        ],
        "farm": []
    }
}

Get production batch

Obtaining production batch list.

GET /api/batch
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
Example Response
{
    "batch": [
        "20170727",
        "20170803",
        "20170810",
        ...
        "20180517",
        "20180524",
        "20180607"
    ]
}

Get production spec.

Obtaining production specification list.

GET /api/spec
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
Example Response
{
    "spec": [
        "1L/bottle"
    ]
}

Get order

Obtaining order number list.

GET /api/order
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
Example Response
{
    "order": [
        "PGS0313",
        "PGS0494",
        "SPT5249",
        ...
        "SPT5309",
        "SPT5310",
        "SPT5314"
    ]
}

Get product

Obtaining product name list.

GET /api/product
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
Example Response
{
    "product": [
        "Norco Milk Full Cream 1 Litre",
        "a2 Milk Full Cream 1L",
        "A2 fresh milk 1 litre",
        "Norco fresh milk 1 litre"
    ]
}

Search packages by batch, spec, order, product, device, manufacturer

GET /api/search?batch=20170803
or
GET /api/search?batch=20170803&device=99000512000374
or
GET /api/search?order=SPT5307&manufacturer=Norco Cooperative Ltd
or
...
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
Example Response
{
    "package": [
        {
            "id": 56,
            "device": [
                "99000218806721",
                "99000218806722",
                "99000218806726",
                "99000218806740",
                "99000218806742",
                "99000218806743",
                "99000218806745",
                "99000218806749",
                "99000218806757",
                "99000218806901",
                "99000218806904",
                "99000218806905",
                "99000218806909",
                "99000218806913",
                "99000218806915",
                "99000218806923",
                "99000218806924",
                "99000218806946",
                "99000218806953",
                "99000218806966",
                "99000218806972",
                "99000218806988"
            ],
            "spec": "1L/bottle",
            "product": "a2 Milk Full Cream 1L",
            "order": "SPT5307",
            "batch": "20180510",
            "end_date": "05/31/2018 23:59:59",
            "start_date": "05/10/2018 00:00:00"
        }
    ]
}

Get package device info

Obtaining measuremunt values of device.

GET api/package/:package_id/device/:sendum_device_num
Parameters
Name Type Description
authenticateit_identity_ticket header Required: Session's ticket
package_id string Required: package id
sendum_device_num string Required: device identifier
Example Response
{
    "info": [
        {
            "date_time": "2018-05-19 04:26:12",
            "lat": "",
            "lng": "",
            "address": "",
            "battarey": "0",
            "signal": "",
            "tilt": "96",
            "temperature": "31.8",
            "temp_probe": "",
            "humidity": "56",
            "pressure": "100793",
            "light": "0",
            "irlight": "",
            "gps_jam": "ON",
            "voltage": "3725"
        },
        {
            "date_time": "2018-05-19 04:26:12",
            "lat": "22.64374",
            "lng": "113.82681",
            "address": "",
            "battarey": "0",
            "signal": "",
            "tilt": "",
            "temperature": "",
            "temp_probe": "",
            "humidity": "",
            "pressure": "",
            "light": "",
            "irlight": "",
            "gps_jam": "ON",
            "voltage": ""
        },
        ...
        {
            "date_time": "2018-05-15 03:11:30",
            "lat": "30.96117",
            "lng": "112.94910",
            "address": "",
            "battarey": "0",
            "signal": "",
            "tilt": "",
            "temperature": "",
            "temp_probe": "",
            "humidity": "",
            "pressure": "",
            "light": "",
            "irlight": "",
            "gps_jam": "ON",
            "voltage": ""
        }
    ]
}

results matching ""

    No results matching ""