Saltar al contenido principal

Actualizar una solicitud de servicio

PUThttps://carchost.fieldcontrol.com.br/tickets/{id}

Actualiza los datos de una solicitud. status y archived no cambian por aquí, y el cliente, el tipo de orden de servicio, los productos, los servicios y el trayecto solo se guardan en la creación.

Requiere los headers X-Api-Key, User-Agent y Content-Type: application/json. Límite: 1 solicitud por segundo (más información).

Solicitud​

Parámetros de ruta

idstringobligatorio

Identificador de la solicitud.

Ejemplo: YTJmYmM4ZDEtNGQ3Mi00ZmVlLTk1ZjktMjU1ZWIyNzk2YzJjOjIyOTE1.

Headers

User-Agentstringobligatorio

Identificación de su aplicación.

Ejemplo: MinhaIntegracao/1.0.

Cuerpo de la solicitud

JSON, enviado con el header Content-Type: application/json.

namestringobligatorio

Nombre de quien pidió la atención.

Mínimo de 5 caracteres.

messagestringobligatorio

Mensaje de la solicitud.

subjectstring

Asunto. Si es igual al nombre de un tipo de orden de servicio, permite reconocer solicitudes de clientes corporativos.

identifierstring

Número de la solicitud. El carácter # está reservado.

expiredAtstring

Fecha de validez de la solicitud.

externalobject
Campos de external
idstring

Identificador de la solicitud en su sistema.

Hasta 100 caracteres.Acepta: null.

contactobject

Contacto de quien pidió la atención.

Campos de contact
emailstring
phonestring
customerobject

Cliente vinculado. Solo se guarda en la creación.

Campos de customer
idstring
serviceobject

Tipo de orden de servicio vinculado. Solo se guarda en la creación.

Campos de service
idstring
locationobject

Ubicación del cliente, que debe ser del cliente informado.

Campos de location
idstring
productslista de objetos

Productos pedidos. Solo se considera en la creación.

Campos de products
quantitynumberobligatorio
productobjectobligatorio
Campos de product
idstringobligatorio
serviceslista de objetos

Servicios pedidos. Solo se considera en la creación.

Campos de services
quantitynumberobligatorio
serviceobjectobligatorio
Campos de service
idstringobligatorio
scheduleSuggestionslista de objetos

Sugerencias de fecha y horario para la atención. Solo se considera en la creación.

Campos de scheduleSuggestions
datestring

Fecha (AAAA-MM-DD).

timestring

Horario (HH:MM:SS).

contractorobject

Empresa contratante, para solicitudes abiertas en nombre de terceros. Solo se considera en la creación.

Campos de contractor
namestringobligatorio
logoUrlstringobligatorio
sourcestringobligatorio
waypointslista de objetos

Puntos del trayecto, con kmTotal, para solicitudes de desplazamiento. Solo se considera en la creación.

Campos de waypoints
latitudenumberobligatorio
longitudenumberobligatorio
kmTotalnumber

Distancia total del trayecto, en km.

routeslista de objetos

Direcciones del trayecto, en el orden de position. Solo se considera en la creación, junto con waypoints y kmTotal.

Campos de routes
positionnumberobligatorio
postalCodestringobligatorio
streetstringobligatorio
numberstring

Acepta: null.

complementstring

Acepta: null.

neighborhoodstringobligatorio
citystringobligatorio
statestringobligatorio
formattedAddressstringobligatorio
countrystringobligatorio
placeNamestring

Acepta: null.

placePhonestring

Acepta: null.

latitudenumberobligatorio
longitudenumberobligatorio

Respuestas

  • 200

    Solicitud actualizada.

  • 401

    Clave de API ausente (Missing API Key) o inválida (Invalid API Key). Consulte Autenticación.

  • 403

    Cuenta bloqueada (Account blocked), vencida (Account expired) o con un plan que no permite integración (Account plan not allowed). Consulte Autenticación.

  • 404

    Recurso no encontrado. El cuerpo de la respuesta está vacío.

  • 422

    Cuerpo inválido (resourceValidationErr): name o message ausentes, # en el número, o ubicación que no es del cliente. Un identificador inválido o de otra cuenta en la URL también devuelve este error, con property: '@.id'.

  • 429

    Se superó el límite de 1 solicitud por segundo. Consulte Límite de solicitudes.

  • 500

    Error inesperado en el servidor.