ProZ.com global directory of translation services
The translation workplace
Ideas

GET: /availability/:uuid

Get a list of daily availability information (a list of day availability) for the given user.

Parameters

Query parameters:
  • :uuid: (uuid) The UUID of the user to get availability for. Use the special value me to refer to the currently authenticated user.
Filter criteria:
  • from_date: (date) The earliest date for which to check availability. Defaults to the current day.
  • to_date: (date) The latest date for which to check availability. Defaults to the current day.

Example request

curl -H "Authorization: Bearer {OAUTH2_ACCESS_TOKEN}" https://api.proz.com/v2/availability/32a9a4d0-cb6e-463f-a0ab-63d0a0418bc7?from_date=2016-04-14&to_date=2016-04-28

Response

Returns a collection of day availability objects, along with a general working hours object. Objects are only returned for dates within the given range where availability is set (not null).

{
  "working_hours": {
    "self_link": "https://api.proz.com/v2/availability/349b7739-c5d7-4d9c-86ea-d9bfec9ccd45",
    "user": "https://api.proz.com/v2/users/349b7739-c5d7-4d9c-86ea-d9bfec9ccd45",
    "workday_start": "09:00:00",
    "workday_end": "20:00:00",
    "opted_out": false,
    "available_off_hours": true,
    "available_weekends ": false
  },
  "days_availability": [
    {
      "self_link": "https://api.proz.com/v2/availability/349b7739-c5d7-4d9c-86ea-d9bfec9ccd45/2016-04-14",
      "user": "https://api.proz.com/v2/users/349b7739-c5d7-4d9c-86ea-d9bfec9ccd45",
      "date": "2016-04-14",
      "availability": 25
    },
    {
      "self_link": "https://api.proz.com/v2/availability/349b7739-c5d7-4d9c-86ea-d9bfec9ccd45/2016-04-15",
      "user": "https://api.proz.com/v2/users/349b7739-c5d7-4d9c-86ea-d9bfec9ccd45",
      "date": "2016-04-15",
      "availability": 25
    },
    {
      "self_link": "https://api.proz.com/v2/availability/349b7739-c5d7-4d9c-86ea-d9bfec9ccd45/2016-04-18",
      "user": "https://api.proz.com/v2/users/349b7739-c5d7-4d9c-86ea-d9bfec9ccd45",
      "date": "2016-04-18",
      "availability": 100
    },
    {
      "self_link": "https://api.proz.com/v2/availability/349b7739-c5d7-4d9c-86ea-d9bfec9ccd45/2016-04-19",
      "user": "https://api.proz.com/v2/users/349b7739-c5d7-4d9c-86ea-d9bfec9ccd45",
      "date": "2016-04-19",
      "availability": 75
    },
    {
      "self_link": "https://api.proz.com/v2/availability/349b7739-c5d7-4d9c-86ea-d9bfec9ccd45/2016-04-20",
      "user": "https://api.proz.com/v2/users/349b7739-c5d7-4d9c-86ea-d9bfec9ccd45",
      "date": "2016-04-20",
      "availability": 0
    },
    {
      "self_link": "https://api.proz.com/v2/availability/349b7739-c5d7-4d9c-86ea-d9bfec9ccd45/2016-04-22",
      "user": "https://api.proz.com/v2/users/349b7739-c5d7-4d9c-86ea-d9bfec9ccd45",
      "date": "2016-04-22",
      "availability": 25
    },
    {
      "self_link": "https://api.proz.com/v2/availability/349b7739-c5d7-4d9c-86ea-d9bfec9ccd45/2016-04-23",
      "user": "https://api.proz.com/v2/users/349b7739-c5d7-4d9c-86ea-d9bfec9ccd45",
      "date": "2016-04-23",
      "availability": 100
    },
    {
      "self_link": "https://api.proz.com/v2/availability/349b7739-c5d7-4d9c-86ea-d9bfec9ccd45/2016-04-28",
      "user": "https://api.proz.com/v2/users/349b7739-c5d7-4d9c-86ea-d9bfec9ccd45",
      "date": "2016-04-28",
      "availability": 0
    }
  ]
}