API: Catálogos

M: Consultar catálogos

HTTP GET:

https://<hostname>/api/order-entry/catalog[/<id>]

URL PARAMETERS

Nombre Tipo Requerido Descripción
id Id de Catálogo Numérico no Si se incluye, permite consultar una catálogo específico.

OUTPUT:

Json con los campos:

EJEMPLO CON CURL:

curl -u <api_key>:<password>
     -X GET
     https://<hostname>/api/order-entry/catalog

RESPUESTA:

{
    "success": true,
    "data": [
        {
            "id": "1",
            "client_id": "22",
            "name": "Verano",
            "creation_date": "2017-09-07 18:13:10.742+00",
            "changed_date": "2017-09-07 18:13:12.499+00"
        },
        {
            "id": "2",
            "client_id": "22",
            "name": "Invierno",
            "creation_date": "2017-09-07 22:45:24+00",
            "changed_date": "2017-09-07 22:45:24+00"
        }
    ]
}

HTTP POST:

https://<hostname>/api/order-entry/catalog

POST BODY:

Campo Nombre Tipo Formato Requerido
name Nombre Texto no

OUTPUT:

Json con los campos:

EJEMPLO CON CURL:

curl -u <api_key>:<password>
     -X POST
     https://<hostname>/api/vehicles/catalog
     -d "name=Primavera"

RESPUESTA:

{
    "success": true,
    "data": {
        "id": "3",
        "client_id": "22",
        "name": "Primavera",
        "creation_date": "2017-09-08 14:45:14+00",
        "changed_date": "2017-09-08 14:45:14+00"
    }
}

M: Editar catálogo existente

HTTP PUT:

https://<hostname>/api/order-entry/catalog/<id>

URL PARAMETERS

Nombre Tipo Requerido
id Id de Catálogo Numérico

POST BODY:

Campo Nombre Tipo Formato Requerido
name Nombre Texto no

OUTPUT:

Json con los campos:

EJEMPLO CON CURL:

curl -u <api_key>:<password>
     -X PUT
     https://<hostname>/api/vehicles/catalog/3
     -d "name=Otoño"

RESPUESTA:

{
    "success": true,
    "data": {
        "id": "3",
        "client_id": "22",
        "name": "Otoño",
        "creation_date": "2017-09-08 14:45:14+00",
        "changed_date": "2017-11-07 03:15:52+00"
    }
}

M: Eliminar catálogo existente

HTTP DELETE:

https://<hostname>/api/order-entry/catalog/<id>

URL PARAMETERS

Nombre Tipo Requerido
id Id de Catálogo Numérico

OUTPUT:

Json con los campos:

EJEMPLO CON CURL:

curl -u <api_key>:<password>
     -X DELETE
     https://<hostname>/api/vehicles/catalog/3

RESPUESTA:

{
    "success": true
}

Ver documentación en Productos

O: Catalog Object

Campo Nombre Tipo Descripción
id Id Numérico Identificador único del Catálogo en la base de datos.
client_id Id de la Compañía Numérico Identificador único de la Compañía.
name Nombre Texto (máximo 255 caracteres)
creation_date Fecha de creación Fecha
changed_date Fecha de última modificación Fecha