This is a developer preview of Kubbos API. It's in beta, so it's subject to changes. If you need any of the "Coming soon" API services documented as soon as possible. Contact Us!

#areas.list
#areas.findById
#areas.create
#areas.update
#areas.delete

areas.list

Request

{
/* — search criteria (optional) — */
"descriptionArea":""
}

Response

{
    "data":     {
        "result":         [
                        {
                "version": 0,
                "id": "159",
                "descriptionArea": "Levante y Cataluña"
            },
                        {
				....
			},
                        {
                "version": 0,
                "id": "156",
                "descriptionArea": "Norte"
            }
        ],
        "total": 6
    },
    "success": true
}

areas.findById

areas.findById

Request

{"id": "158"}

Response

{
    "data":     {
        "version": 0,
        "id": "158",
        "descriptionArea": "Centro"
    },
    "success": true
}

areas.create

Request

{
"descriptionArea": "Centro"
}

Response

{
    "data":     {
        "errors": [],
        "messages": [        {
            "description": "Operación realizada correctamente",
            "id": "operation_success"
        }],
        "warns": []
    },
    "id": "158",
    "success": true,
    "version": 0
}

areas.update

Request

{
"descriptionArea": "Zona Centro",
"id": "158",
"version": 0
}

Response

{
    "data":     {
        "errors": [],
        "messages": [        {
            "description": "Operación realizada correctamente",
            "id": "operation_success"
        }],
        "warns": []
    },
    "id": "158",
    "success": true,
    "version": 1
}

areas.delete

Request

{
"id": "158",
"version": 1
}

Response

{
    "data":     {
        "errors": [],
        "messages": [        {
            "description": "Operación realizada correctamente",
            "id": "operation_success"
        }],
        "warns": []
    },
    "id": "158",
    "success": true,
    "version": 1
}
  • No labels