Skip to navigation

Assign Appointment to Operator

View as Markdown

Este método permite asignar una cita existente a un agente específico dentro del sistema, utilizando el identificador único de la cita y el identificador del usuario. Al completarse la mutación, el operador seleccionado asumirá el control y la gestión de la sesión de atención.

Detalles de la Solicitud

  • Método HTTP: POST

  • URL PRE: https://api.ovac.pre.councilbox.com/graphql

  • URL PRO: https://api.ovac.councilbox.com/graphql

Autenticación

Tipo: API Key**
Header:** x-jwt-token
Ubicación: Header HTTP_
Ejemplo:_ x-jwt-token: eyJhbGciOiJIUzI1NiIsInR5cCI6...

Referencia de la API

Parámetros de Entrada (Variables)

ParámetroDescripciónRequeridoTipo
councilIdIdentificador numérico único de la cita en la plataforma.SIInteger
userIdIdentificador numérico único del usuario (operador/agente) al que se le va a asignar la cita.SI

Campos de Respuesta (Payload)

La mutación devuelve un objeto assignCouncilToUser con el resultado funcional de la operación:

ParámetroDescripciónTipo
dataObjeto datoObject
data.assignCouncilToUserObjeto del usuarioObject
data.assignCouncilToUser.successValor booleano de verificación de asignación.Boolean
data.assignCouncilToUser.messageError que devuelve, por defecto nullString

Ejemplos de Código y Peticiones

1. Mutación GraphQL

mutation AssignCouncilToUser($councilId: Int!, $userId: Int!)
{
assignCouncilToUser(
councilId: $councilId,
userId: $userId)
{
success
message
}
}

2. Variables de la Petición (JSON Payload)

{
"councilId": 64719,
"userId": 3477
}

3. Ejemplo de comando cURL

curl --location "https://api.ovac.pre.councilbox.com/graphql" \
--header "Content-Type: application/json" \
--header "x-jwt-token: {{token}}" \
--data '{"query":"mutation AssignCouncilToUser($councilId: Int!, $userId: Int!){ assignCouncilToUser(councilId: $councilId, userId: $userId){ success message } }","variables":{"councilId":64719,"userId":3477}}'

4. Respuesta Esperada (200 OK)

{
"data": {
"assignCouncilToUser": {
"success": true,
"message": null
}
}
}

Nota OpenAPI/Fern: esta operación GraphQL se documenta como /graphql/assigncounciltouser para que Fern pueda mostrarla como operación independiente. La ruta técnica real de ejecución es POST /graphql.

Authentication

x-jwt-tokenstring
JWT token obtained from Login.

Request

This endpoint expects an object.
querystringRequired
GraphQL operation
variablesobjectOptional
GraphQL variables

Response

Successful response. GraphQL business errors may be returned inside the JSON errors field while transport status remains HTTP 200.