Planung

Attribute

Die Repräsentation eines Planungseintrags enthält neben den wichtigsten Eigenschaften ausserdem:
  • Zuweisung Projekt oder Abwesenheit (Assignment)
  • Zugewiesener Mitarbeiter (User)
{
    "id": 123,
    "date": "2017-06-14",
    "comment": "Halber Tag Urlaub",
    "am": true,
    "pm": true,
    "assignment": {
        "id": 789,
        "name": "Urlaub",
        "customer_name": "hundertzehn GmbH",
        "color": "#BBB",
        "type": "Absence"
    },
    "user": {
        "id": 567,
        "firstname": "Sabine",
        "lastname": "Schäuble"
    }
}


GET schedules

Abruf aller Planungseinträge (seitenweise):

curl -X GET \
  https://{domain}.mocoapp.com/api/v1/schedules \
  -H 'authorization: Token token={api-key}'
  -d 'from=2017-06-01&to=2017-06-10'

Die Antwort liefert ein Array mit vollständigen Projektinformationen (siehe Attribute).

Zusätzlich sind folgende Parameter möglich:
  • from – "2017-05-01"
  • to – "2017-05-31"
  • user_id – 123
  • project_id – 345 oder absence_code – 1, 2, 3, 4 (Abwesenheit, Feiertag, Krankheit, Urlaub)


GET schedules/{id}

Abruf eines einzelnen Planungseintrags:

curl -X GET \
  https://{domain}.mocoapp.com/api/v1/schedules/{123} \
  -H 'Authorization: Token token={api-key}'

Die Antwort ist die Repräsentation eines einzelnen Planungseintrags.


POST schedules

Erstellen eines Planungseintrags:

Der Eintrag wird immer für den User mit dem zugehörigen Authorization-Token erstellt falls die user_id nicht mitgegeben wird.

curl -X POST \
  https://{domain}.mocoapp.com/api/v1/schedules \
  -H 'authorization: Token token={api-key}' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'date=2017-06-11&project_id=123456'

Pflichtfelder sind mit Stern (*) markiert:
  • date* – "2017-06-11"
  • project_id* – 123456 oder absence_code* – 1, 2, 3, 4 (Abwesenheit, Feiertag, Krankheit, Urlaub)
  • user_id – 234567 (ID einer aktiven Person)
  • am – true, false (Vormittag ja/nein)
  • pm – true, false (Nachmittag ja/nein)
  • comment – "Ein Kommentar..."


PUT schedules/{id}

Aktualisieren eines Planungseintrags:

curl -X PUT \
  https://{domain}.mocoapp.com/api/v1/schedules/{123} \
  -H 'authorization: Token token={api-key}' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'comment=Ein Kommentar'

Felder sind analog zur Erstellung.


DELETE schedules/{id}

curl -X DELETE \
  https://{domain}.mocoapp.com/api/v1/schedules/{123} \
  -H 'authorization: Token token={api-key}'


Mehr zu API...
30 Tage gratis

Account sofort startbereit. Voller Funktionsumfang. Ohne Zahlungsangaben.