NAV

Giosg WorkForce Management API

This API is an additional feature for Giosg Live. By using this API you can make scheduled changes to team’s memberships.

Schedules

The schedule resource has the following attributes.

Attribute Type Editable Description
id ID read-only The unique identifier of this schedule
organization_id ID read-only ID of the organization who owns this schedule.
team_id ID read-only The unique identifier of the team.
created_at date/time read-only When this schedule was created.
begin_at date/time required When this schedule begins.
user_ids array of IDs required IDs of the users that the team should contain when the schedule begins.

Create new schedule for Team

POST https://workforcemanagement.giosgapps.com/api/v1/orgs/7f9e9580-095b-42c7-838c-c04e667b26f7/team/ab98bd97-872c-11e7-921d-60f81dcf1946/schedule
{
    "schedule": [
        {
            "begin_at": "2015-02-13T10:30:00.000",
            "user_ids": [
              "user_id_1",
              "user_id_2",
              "user_id_3"
            ]
        },
        {
            "begin_at": "2015-02-13T14:30:00.000",
            "user_ids": [
              "user_id_1",
              "user_id_3",
              "user_id_5"
            ]
        },
        {
            "begin_at": "2015-02-13T18:30:00.000",
            "user_ids": []
        }
    ]
}

Create a new schedule for team by making a POST request, providing the collection of schedule objects as a payload.

POST https://workforcemanagement.giosgapps.com/api/v1/orgs/<organization_id>/team/<team_id>/schedule

Get schedule

Create new schedule for Team

GET https://workforcemanagement.giosgapps.com/api/v1/orgs/7f9e9580-095b-42c7-838c-c04e667b26f7/team/ab98bd97-872c-11e7-921d-60f81dcf1946/schedule
{
    "id": "6d78c168-8688-4b79-a528-fbd3af53beef",
    "organization_id": "7f9e9580-095b-42c7-838c-c04e667b26f7",
    "team_id": "ab98bd97-872c-11e7-921d-60f81dcf1946",
    "created_at": "2015-02-13T09:30:36.042",
    "schedule": [
        {
            "begin_at": "2015-02-13T10:30:00.000",
            "user_ids": [
              "user_id_1",
              "user_id_2",
              "user_id_3"
            ]
        },
        {
            "begin_at": "2015-02-13T14:30:00.000",
            "user_ids": [
              "user_id_1",
              "user_id_3",
              "user_id_5"
            ]
        },
        {
            "begin_at": "2015-02-13T18:30:00.000",
            "user_ids": []
        }
    ]
}

Get schedule for team by making a GET request.

GET https://workforcemanagement.giosgapps.com/api/v1/orgs/<organization_id>/team/<team_id>/schedule

Delete schedule

Delete schedule for team by making a DELETE request.

DELETE https://workforcemanagement.giosgapps.com/api/v1/orgs/<organization_id>/team/<team_id>/schedule