Integrationen & API Dokumentation
      Zurück zur Startseite
      1. shyftplan Hilfebereich
      2. Integrationen & API Dokumentation

      Wie kann ich Arbeitsbereichs-Etiketten via API anlegen und zuweisen?

       

      1. Arbeitsbereichs-Etikett anlegen

      Rufen Sie locations_positions_tags in unserer API-Dokumentation auf. Wählen Sie hier hier den POST-Befehl aus. 
      In der Eingabemaske füllen Sie die Pflichtfelder aus und klicken rechts auf den Button "Try it!".

      Wo?
      POST an:

      https://shyftplan.com/api/v1/locations_positions_tags

      Pflichtangaben (müssen ausgefüllt werden):

      • company_id → Ihre Unternehmens-ID in shyftplanner.

      • user_email → Ihre E-Mail-Adresse (API-Nutzer).

      • authentication_token → Ihr API-Zugangstoken.

      • name → Name des Etiketts (zum Beispiel „Prio 1“).

      Wichtig:

      • Jedes Etikett einzeln anlegen.

      • Die ID des Etiketts aus der Antwort notieren (brauchen Sie später).

      2. Arbeitsbereiche abrufen

      Rufen Sie locations_positions auf und wählen Sie den Befehl GET. Füllen Sie die Pflichtfelder aus und schicken Sie Ihren Befehl über den "Try It"- Button ab. Sie erhalten nun die IDs der Arbeitsbereiche an jedem Standort, diese können Sie sich abspeichern. 

      Wo?
      GET an:

      https://shyftplan.com/api/v1/locations_positions

      Wichtig:

      • Notieren Sie sich die IDs der Arbeitsbereiche, denen Sie Etiketten zuweisen möchten.

      3. Arbeitsbereichs-Etiketten zu Arbeitsbereichen hinzufügen

      Rufen Sie erneut locations_positions auf und wählen Sie den PUT-Befehl. Anschließend geben Sie im Feld "id" die ID des gewünschten Arbeitsbereichs ein. Unter tag_ids wählen Sie die ID des gewünschten Etiketts aus und senden Sie den Befehl ab. 

      Wo?
      PUT an:

      https://shyftplan.com/api/v1/locations_positions/{id}

      Was muss rein?

      • company_id

      • user_email

      • authentication_token

      • tag_ids → Hier die ID(s) der Etiketten als Liste einfügen.
        Beispiel:

        {
          "tag_ids": [123, 456]
        }

      Achtung:
      Immer alle gewünschten Etiketten angeben – vorhandene werden sonst überschrieben.


      Die Arbeitsbereichs-Etiketten stehen Ihnen nun in Ihrem shyftplanner-Account zur Verfügung und können bei der Zuweisungspriorisierung verwendet werden.