GCXONEDocumentación

Horario

En esta página
  1. GET /schedule
  2. Parámetros
  3. Respuestas
  4. PATCH /schedule
  5. Parámetros
  6. Cuerpo de la solicitud
  7. Respuestas

Operaciones sobre recursos de horario. 2 puntos finales, cada uno relativo a https://api.nxgen.cloud/api/v1 y autenticado según lo descrito en Autenticación.

GET /schedule

Obtenga la lista de horarios asociados a un identificador de nivel jerárquico como Sitio, Cliente o ID del proveedor de servicios.

Parámetros

Nombre

En

Tipo

Obligatorio

Descripción

entityId

query

cadena

Identificador de nivel jerárquico como Sitio, Cliente o ID del proveedor de servicios.

Respuestas

Estado

Descripción

Cuerpo

200

Éxito

objeto

400

Entrada inválida

403

Prohibido

Ejemplo 200 respuesta:

json
{
  "errorCode": 0,
  "errorMessage": "Details on error if any.",
  "message": {
    "schedules": [
      {
        "id": "8a81fdd581cf1102820521f1bb08c5",
        "entries": [
          {
            "id": "8a81fdd581cf1102018205251908c6",
            "entryType": "DAY_OF_WEEK",
            "startDate": 1730116540,
            "endDate": 1730116540,
            "dayOfWeek": "MONDAY",
            "startTime": "09:00",
            "endTime": "17:00",
            "autoDelete": false,
            "autoDeleteAt": 1730116540,
            "specialDayId": "",
            "notes": "",
            "_links": {
              "schedule": {
                "href": "http://talos.evalink.io/api/schedule-service/schedules/8a81fdd581cf110201820521bb08c5"
              }
            }
          }
        ],
        "timeZone": "Europe/Berlin",
        "name": "TEST",
        "updatedAt": 1657943696144
      }
    ],
    "specialDays": [
      {
        "id": "8a809592716fa50171cb419a2e016c",
        "name": "Weihnachten",
        "month": "12",
        "date": "25"
      }
    ]
  }
}

Ejemplo 400 respuesta:

json
{
  "errorCode": "ERR001",
  "errorDesc": "Invalid Request"
}

PATCH /schedule

Parchear horario por ID de horario

Parámetros

Nombre

En

Tipo

Obligatorio

Descripción

scheduleId

query

string

Identificador de programación para PATCH.

hierarchyId

consulta

cadena

Identificador de nivel jerárquico como Site, Cliente o ID del Proveedor de servicio.

Cuerpo de la solicitud

Carga útil del programa

json
{
  "entries": [
    {
      "id": "string",
      "entryType": "DATE | DAY_OF_WEEK | SPECIAL_DAY | DATE_MULTIPLE | DATE_RANGE",
      "startDate": "string",
      "endDate": "string",
      "dayOfWeek": "MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY",
      "startTime": "string",
      "endTime": "string",
      "autoDelete": "boolean",
      "autoDeleteAt": "number",
      "specialDayId": "string",
      "notes": "string"
    }
  ],
  "name": "string"
}

Respuestas

Estado

Descripción

Cuerpo

200

Éxito

400

Entrada inválida

403

Prohibido

Ejemplo 200 respuesta:

json
{
  "errorCode": 0,
  "errorMessage": "Success"
}

Ejemplo 400 respuesta:

json
{
  "errorCode": "ERR001",
  "errorDesc": "Invalid Request"
}
¿Le ha resultado útil esta página?

Gracias — sus comentarios llegan al equipo responsable de esta página.