Public

Availabilities

Get weekdays availabilities

post/v1/public/availabilities/weekdays/get

Request

Base URL
https://api.evolia.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/evolia/apis/public-evolia/docs/v1/public/availabilities/weekdays/get/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

sortobject

Sort field. Use 0 for ASC and -1 for DESC.

qstring

Search field, search trough fName, lName, email, phone or code member fields

forMemberIdsstring[]

If specified, use this array of member UIDs to only get availabilities linked to those members

forTeamIdsstring[]

If specified, use this array of team UIDs to only get member availabilities linked to those teams

forLocationIdsstring[]

If specified, use this array of location UIDs to only get member availabilities linked to those locations

forSkillIdsstring[]

If specified, use this array of skill UIDs to only get member availabilities linked to those skills

skipnumber

Skips over the specified number of items.

takenumber

Limits the number of items.

fromnumber

Timestamp, Get all availabilities from the specified date.

tonumber

Timestamp, Get all availabilities to the specified date.

approvalStatus'needs_approval' | 'approved' | 'refused'

Filter by availability approval status.

includeRelationshipsboolean

Example request

{
  "sort": {
    "approval.status": -1
  },
  "q": "johndoe@",
  "forMemberIds": [
    "memberId"
  ],
  "forTeamIds": [
    "teamId"
  ],
  "forLocationIds": [
    "locationId"
  ],
  "forSkillIds": [
    "skillId"
  ],
  "take": 25,
  "from": 1788580800000,
  "to": 1789012800000,
  "approvalStatus": "approved"
}

Response

uidstring required

Availability UID.

allowReplacementsOutsideAvailabilitiesboolean

Allow replacements outside availability.

createdAtnumber required

Availability creation date.

createdByMemberIdstring required

Member uid who created the availability

createdByMemberCodestring required

Member code who created the availability

fromDatenumber

Effective date from. Format: unix timestamp in milliseconds.

groupIdstring required

The group UID linked to this availability.

memberIdstring required

The member UID linked to this availability.

memberCodestring required

The member code linked to this availability.

notestring required

Note linked to this availability.

preferredLocationIdsstring[]

Array of member's preferred location ids.

preferredLocationCodesstring[]

Array of member's preferred location codes.

preferredMaxHoursPerPayPeriodnumber

Maximum number of hours per pay period. Max: 168.

preferredMaxHoursPerWeeknumber

Maximum number of hours per week. Max: 168.

preferredMaxRestingHoursnumber

Maximum hours between shifts.

preferredMaxShiftsPerDaynumber

Maximum number of shifts per day.

preferredMaxShiftsPerWeeknumber

Maximum number of shifts per week.

preferredMaxWeekDaysnumber

Maximum number of weekdays. Max: 5.

preferredMaxWeekendDaysnumber

Maximum number of weekend days. Max: 2.

preferredMinHoursPerWeeknumber

Minimum number of hours per week. Max: 168.

preferredSkillIdsstring[]

Array of member's preferred skill ids.

preferredSkillCodesstring[]

Array of member's preferred skill codes.

preferredTeamIdsstring[]

Array of member's preferred team ids.

preferredTeamCodesstring[]

Array of member's preferred team codes.

toDatenumber

Effective date to. Format: unix timestamp in milliseconds.

daysDayAvailabilityDetail[]

Array of DayAvailabilityDetail

Changes

No recorded changes to this operation across all 8 revisions of this API.