Company Procedures

# Company Statutes (`query`) Esta operación permite consultar el catálogo de trámites configurados y vinculados a una entidad determinada. Ofrece un parámetro de filtrado opcional para segmentar de forma directa los resultados según el canal o tipo de atención requerido. ### 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 | | --- | --- | --- | --- | | companyId | Identificador único de la entidad en OVAC donde se busca la disponibilidad. | SI | Integer | | councilType | Filtro por tipo de canal. Admite los siguientes valores: <br>`null` -> Muestra todos los trámites (por defecto). <br>`5` -> Videoatención. <br>`6` -> Gestión desatendida. <br>`7` -> Presencial. | NO | Integer | ### Campos de Respuesta (Payload) La consulta devuelve una colección directa de objetos bajo el campo raíz `companyStatutes`: | Parámetro | Descripción | Tipo | | --- | --- | --- | | companyStatutes | Array con el listado de trámites vinculados que cumplen los filtros. | Array | | companyStatutes.**id** | Identificador interno único del trámite en la plataforma OVAC. | Integer | | companyStatutes.**externalId** | Código o identificador del trámite en el sistema del cliente de origen. | String | | companyStatutes.**title** | Nombre o denominación oficial del trámite (ej. "TEST"). | String | | companyStatutes.**councilType** | Código numérico que representa el canal de atención asignado a ese trámite. | Integer | | companyStatutes.**notificationType** | Método de notificación por defecto: <br>`0` -> email <br>`1` -> SMS <br>`2` -> WhatsApp | Integer | | companyStatutes.**notificationsAvailable** | Métodos de envío de notificación permitidos, es un array separado por comas: "`0`,`1`,`2`", en el ejemplo indica que todos están permitidos. | Array | ## Ejemplos de Código y Peticiones ### 1\. Consulta GraphQL ``` graphql query Statutes($companyId: Int!, $councilType: Int) { companyStatutes(companyId: $companyId, councilType: $councilType) { id externalId title councilType notificationType notificationsAvailable } } ``` ### 2\. Variables de la Petición (JSON Payload) ``` json { "companyId": 2191, "councilType": null } ``` ### 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":"query statutes($companyId: Int!, $councilType: Int) { companyStatutes(companyId: $companyId, councilType: $councilType) { id externalId title councilType } }","variables":{"companyId":2191,"councilType":null}}' ``` ### 4\. Respuesta Esperada (200 OK) ``` json { "data": { "companyStatutes": [ { "id": 4685, "externalId": null, "title": "TEST", "councilType": 5 "notificationType": 0, "notificationsAvailable": "0,1,2" } ] } } ``` > **Nota OpenAPI/Fern:** esta operación GraphQL se documenta como `/graphql/statutes` para que Fern pueda mostrarla como operación independiente. La ruta técnica real de ejecución es `POST /graphql`.