EVevolia
Public
Events

Get events (shifts)

Changed on

Return a list of events (shifts) based on the query parameters

get/v1/public/events

Request

Query parameters

fromDatestring required
Example:2021-01-31T20:00:00.000-05:00

a date in ISO-8601 format (2021-01-31T20:00:00.000-05:00). Depending on the group "ShiftOverTwoDaysOption" setting, you will see the shift the day before, the day after or on both days. All resulting events will have an end date after this date.

toDatestring required
Example:2021-01-31T20:00:00.000-05:00

a date in ISO-8601 format (2021-01-31T20:00:00.000-05:00). Depending on the group "ShiftOverTwoDaysOption" setting, you will see the shift the day before, the day after or on both days. All resulting events will have a start date before this date.

forTeamIdsstring[]

if specified, use this array of team UIDs to only get events linked to those teams

forTeamCodesstring[]

if specified, use this array of team codes to only get events linked to those teams. (forTeamIds will take precedence over forTeamCodes if set)

forMemberIdsstring[]

if specified, use this array of member UIDs or employee ids to only get events linked to those members

forMemberCodesstring[]

if specified, use this array of member codes to only get events linked to those members. (forMemberIds will take precedence over forMemberCodes if set)

forLocationIdsstring[]

if specified, use this array of location UIDs to only get events linked to those locations

forLocationCodesstring[]

if specified, use this array of location codes to only get events linked to those locations. (forLocationIds will take precedence over forLocationCodes if set)

forSkillIdsstring[]

if specified, use this array of skill UIDs to only get events linked to those skills (positions).

forSkillCodesstring[]

if specified, use this array of skill codes to only get events linked to those skills (positions). (forSkillIds will take precedence over forSkillCodes if set)

forConditionCodesstring[]

if specified, this is array of condition code to get specific type of events

localestring

possible values are "en" or "fr". This locale is use to return multilingual data like teamName, locationName and positionName

withOpenShiftsboolean

if true, open shifts will also be returned

includeRelationshipsboolean

if true, beside returning the events, the resulting data will also includedata related to the events like, members, skills, locations and teams

Response

Example response

{
  "events": [
    {
      "premiums": [
        {
          "names": {
            "en": "night bonus",
            "fr": "prime de nuit"
          },
          "calculationType": "AMOUNT: flat amount (+ 15$), HOURS: flat amount of hours (+ 1h), HOURLY_MULTIPLIER: multiply hourly rate (x 1.5/h), HOURLY_BONUS: flat hourly bonus (+ 1$/h)",
          "code": "241"
        }
      ]
    }
  ],
  "members": [
    {
      "code": "12",
      "hourlyWageBySkillCodes": {
        "assistant": 18.25,
        "lead": 20.53
      },
      "hourlyWageBySkillIds": {
        "64f1a2b3c4d5e6f7890abcde": 18.25,
        "64f1a2b3c4d5e6f7890abcdf": 20.53
      },
      "pin": "98765",
      "email": "johndoe@email.com",
      "phone": "418-262-1123",
      "custom": {
        "key1": "value1",
        "key2": "value2"
      },
      "gender": "M",
      "birthdate": "2001-01-31",
      "homeAddress": {
        "line2": "string",
        "city": "string",
        "state": "string",
        "postalCode": "string",
        "country": "string"
      }
    }
  ],
  "locations": [
    {
      "custom": {
        "key1": "value1",
        "key2": "value2"
      }
    }
  ],
  "skills": [
    {
      "names": {
        "en": "cook",
        "fr": "cuisinier"
      },
      "custom": {
        "key1": "value1",
        "key2": "value2"
      }
    }
  ],
  "teams": [
    {
      "names": {
        "en": "customer service",
        "fr": "service client"
      },
      "custom": {
        "key1": "value1",
        "key2": "value2"
      }
    }
  ]
}

Changes

  • e42abb18d4b6Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status