Assign Appointment to Operator_External

View as Markdown
# Assign Appointment to Operator (External ID Variant) (`assignCouncilToUser`) Este método permite asignar una cita (consejo) existente a un operador utilizando el identificador externo del usuario (`userExternalId`) y el identificador externo de la organización o entidad (`companyExternalId`). Esta variante es ideal para integraciones con CRMs o sistemas legados del cliente, ya que permite realizar la asignación sin necesidad de conocer los identificadores numéricos internos de la base de datos de OVAC. ### 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ámetro | Descripción | Requerido | Tipo | | --- | --- | --- | --- | | councilId | Identificador numérico único de la cita en la plataforma. | SI | Integer | | userExternalId | Identificador único del usuario en el sistema de origen del cliente. | SI | String | | companyExternalId | Identificador único de la entidad u organización en el sistema de origen del cliente. | SI | String | ### Campos de Respuesta (Payload) La mutación devuelve un objeto `assignCouncilToUser` con el resultado de la asignación de personal: | Parámetro | Descripción | Tipo | | --- | --- | --- | | data | Objeto dato | Object | | data.assignCouncilToUser | Objeto del usuario | Object | | data.assignCouncilToUser.success | Valor booleano de verificación de asignación. | Boolean | | data.assignCouncilToUser.message | Error que devuelve, por defecto _null_ | String | ## Ejemplos de Código y Peticiones ### 1\. Mutación GraphQL ``` graphql mutation AssignCouncilToUser( $councilId: Int!, $userId: Int, $userExternalId: String, $companyExternalId: String ) { assignCouncilToUser( councilId: $councilId, userId: $userId, userExternalId: $userExternalId, companyExternalId: $companyExternalId ) { success message } } ``` ### 2\. Variables de la Petición (JSON Payload) ``` json { "councilId": 64886, "userExternalId": "TEST001", "companyExternalId": "API_TEST" } ``` ### 3\. Ejemplo de comando cURL ``` bash 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, $userExternalId: String, $companyExternalId: String) { assignCouncilToUser(councilId: $councilId, userId: $userId, userExternalId: $userExternalId, companyExternalId: $companyExternalId) { success message } }","variables":{"councilId":64886,"userExternalId":"TEST001","companyExternalId":"API_TEST"}}' ``` ### 4\. Respuesta Esperada (200 OK) ``` json { "data": { "assignCouncilToUser": { "success": true, "message": null } } } ``` > **Nota OpenAPI/Fern:** esta operación GraphQL se documenta como `/graphql/assigncounciltouser-2` 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.