GCXONEDokumentation

Zeitplan

Auf dieser Seite
  1. GET /schedule
  2. Parameter
  3. Antworten
  4. PATCH /schedule
  5. Parameter
  6. Anfrage‑Body
  7. Antworten

Operationen an Zeitplan-Ressourcen. 2 Endpunkte, jeweils relativ zu https://api.nxgen.cloud/api/v1 und authentifiziert wie unter Authentifizierung.

GET /schedule

Liste der Schedules abrufen, die einer hierarchy level id wie Site, Customer oder Service provider ID zugeordnet sind.

Parameter

Name

In

Typ

Erforderlich

Beschreibung

entityId

query

string

ja

hierarchy level id wie Site, Customer oder Service provider ID.

Antworten

Status

Beschreibung

Body

200

Erfolg

Objekt

400

Ungültige Eingabe

403

Verboten

Beispiel 200 Antwort:

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"
      }
    ]
  }
}

Beispiel 400 Antwort:

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

PATCH /schedule

Schedule per schedule ID patchen

Parameter

Name

In

Typ

Erforderlich

Beschreibung

scheduleId

Abfrage

Zeichenkette

ja

Schedule ID für PATCH.

hierarchyId

Abfrage

Zeichenkette

ja

Hierarchie‑Ebene‑ID, z. B. Site, Kunde oder Dienstanbieter‑ID.

Anfrage‑Body

Schedule‑Nutzlast

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"
}

Antworten

Status

Beschreibung

Body

200

Erfolg

400

Ungültige Eingabe

403

Verboten

Beispiel 200 Antwort:

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

Beispiel 400 Antwort:

json
{
  "errorCode": "ERR001",
  "errorDesc": "Invalid Request"
}
War diese Seite hilfreich?

Vielen Dank — Ihr Feedback geht an das Team, das diese Seite betreut.