Modificar objeto

Para modificar un objeto en cliente, se debe enviar un PUT como el que se especifica a continuación.

PUT https://api.persat.com.ar/v1/clientobjvalue/uid_client/obj_id/field_1

Path Parameters

Name	Type	Description
uid_client*	String	Indentificador del cliente
obj_id*	Number	Identificador del tipo de objeto. Heladeras por ej.
field_1*	String	Identificador del elemento a modificar

Headers

Name	Type	Description
Authorization*	String	Bearer API_KEY
Content-Type*	String	application/json

Request Body

Name	Type	Description
uid_client	String	Identificador del cliente al que quiero mover el objeto
fields	Object	Los campos del objeto a insertar. Ver en el ejemplo en esta misma sección

200: OK La consulta se ejecutó con éxito

{
    "success": true,
    "data": {
        "uid_client": "AABC9098",
        "obj_id": 2,
        "fields": {
            "1": "AABCSA090AA",
            "4": "cycle de frost",
            "3": "1500"
            "6": "",
            "7": "",
            "8": ""
        },
        "updated": "2022-05-19T19:38:44.000Z"
    }
}

404: Not Found El objeto a modificar no existe

{
    "success": false,
    "error": {
        "status": 404,
        "type": "NOT_FOUND",
        "userMessage": "El recurso no existe"
    }
}

400: Bad Request Error en alguno de los campos enviados. userMessage contiene informacipon adicional.

{
    "success": false,
    "error": {
        "status": 400,
        "type": "BAD_REQUEST",
        "userMessage": "'obj_id' debe ser un number"
    }
}

Ejemplo Modificando un campo del Objeto

En este ejemplo queremos modificar la heladera identificada con

• field_1: AABCSA090AA - Identificador de la heladera

• obj_id: 2 - Tipo de Objeto Heladera

• uid_client: AABC9098 - Identificador del cliente

Y modificar únicamente el tipo de heladera que es el field "4" para nuestra plantilla

La consulta PUT entonces queda así:

https://api.persat.com.ar/v1/clientobjvalue/AABC9098/2/AABCSA090AA

body

{
    "fields": {
        "4": "cycle de frost"
    }
}

Los valores a insertar son siempre strings, mas alla de que en la definición de la plantilla sean de tipo Numero, email, etc.

Por el momento, no se realizan validaciones durante la inserción o modificación de estos campos.

Analizando la Respuesta

En caso que no haya ningun error, obtenemos el objeto completo con la modificación realizada

{
    "success": true,
    "data": {
        "uid_client": "AABC9098",
        "obj_id": 2,
        "fields": {
            "1": "AABCSA090AA",
            "4": "cycle de frost",
            "3": "1500"
            "6": "",
            "7": "",
            "8": ""
        },
        "updated": "2022-05-19T19:38:44.000Z"
    }
}

updated: Es la fecha de inserción o modificación en UTC

Ejemplo Moviendo el objeto a otro cliente

En este ejemplo queremos mover la heladera a otro cliente. La heladera esta identificada por estos datos

• field_1: AABCSA090AA - Identificador de la heladera

• obj_id: 2 - Tipo de Objeto Heladera

• uid_client: AABC9098 - Identificador del cliente

Y la queremos mover al cliente con uid_client: BJJKJ777. La consulta PUT entonces queda igual que en el ejemplo anterior solo que lo que cambia ahora es el body

body

{
    "uid_client": "BJJKJ777"
}

Analizando la Respuesta

En caso que no haya ningun error, obtenemos el objeto, ahora situado en el nuevo cliente

{
    "success": true,
    "data": {
        "uid_client": "BJJKJ777",
        "obj_id": 2,
        "fields": {
            "1": "AABCSA090AA",
            "4": "cycle de frost",
            "3": "1500"
            "6": "",
            "7": "",
            "8": ""
        },
        "updated": "2022-05-19T19:38:44.000Z"
    }
}

Se puede mover un objeto a otro cliente mientras se modifican los campos internos al mismo tiempo. Es cuestión de enviar en el body ambas modificaciones

body

{
    "uid_client": "BJJKJ777",
    "fields": {
        "4": "cycle de frost"
    }
}