For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Métodos API
      • POSTLogin
      • POSTLanguages
      • POSTCreate Appointment
      • POSTCreate Appointment Representation
      • POSTCreate Appointment Representation Guests
      • POSTCancel Appointment
      • POSTCouncil evidence summary
      • POSTCouncil Info
      • POSTCouncils
      • POSTAssign Appointment to Operator
      • POSTAppointment Documentation
      • POSTCouncil Documentation
      • POSTCompany Month Schedule
      • POSTDay slots
      • POSTShare appointment
      • POSTUpload council Act
      • POSTCompany Procedures
      • POSTReschedule Appointment
      • POSTOrganization companies
      • POSTOrganization Users
      • POSTCreate Appointment_External
      • POSTCreate Appointment Representation_External
      • POSTCreate Appointment Representation Guests_External
      • POSTCouncils_External
      • POSTCouncil Info_External
      • POSTCancel Appointment_External
      • POSTCouncil evidence summary_External
      • POSTAssign Appointment to Operator_External
LogoLogo
Métodos APIOvac

Assign Appointment to Operator_External

|View as Markdown|Open in Claude|
POST
/graphql/assigncounciltouser-2
POST
/graphql/assigncounciltouser-2
$curl -X POST https://api.ovac.pre.councilbox.com/graphql/assigncounciltouser-2 \
> -H "x-jwt-token: <apiKey>" \
> -H "Content-Type: application/json" \
> -d '{
> "query": "mutation AssignCouncilToUser($councilId: Int!, \r\n$userExternalId: String!, \r\n$companyExternalId: String!) \r\n {\r\n assignCouncilToUser(councilId: $councilId, \r\n userExternalId: $userExterna",
> "variables": {
> "councilId": 98765,
> "userExternalId": "USR_2024_001",
> "companyExternalId": "COMP_ABC_123"
> }
>}'
200Assign Appointment to Operator_External
1{
2 "data": {
3 "assignCouncilToUser": {
4 "success": true,
5 "message": null
6 }
7 }
8}
# 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`.
Was this page helpful?
Previous

Council evidence summary_External

Built with

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ámetroDescripciónRequeridoTipo
councilIdIdentificador numérico único de la cita en la plataforma.SIInteger
userExternalIdIdentificador único del usuario en el sistema de origen del cliente.SIString
companyExternalIdIdentificador único de la entidad u organización en el sistema de origen del cliente.SIString

Campos de Respuesta (Payload)

La mutación devuelve un objeto assignCouncilToUser con el resultado de la asignación de personal:

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

1mutation AssignCouncilToUser(
2 $councilId: Int!,
3 $userId: Int,
4 $userExternalId: String,
5 $companyExternalId: String
6) {
7 assignCouncilToUser(
8 councilId: $councilId,
9 userId: $userId,
10 userExternalId: $userExternalId,
11 companyExternalId: $companyExternalId
12 ) {
13 success
14 message
15 }
16}

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

1{
2 "councilId": 64886,
3 "userExternalId": "TEST001",
4 "companyExternalId": "API_TEST"
5}

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, $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)

1{
2 "data": {
3 "assignCouncilToUser": {
4 "success": true,
5 "message": null
6 }
7 }
8}

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.