Create an event (assigned shift and open shift)
Request body
the start date and time of the event. In ISO-8601 format.
the end date and time of the event. In ISO-8601 format. The total event duration is 24 hours max.
if true the event has an undetermined end time. endsAt is still initialised but represent a suggested end time
the event skill(position) UID. Can use the skillCode or the skillId (skillId will take precedence over skillCode if set)
the event skill(position) code. Can use the skillCode or the skillId (skillId will take precedence over skillCode if set)
the event team UID. Can use the teamCode or the teamId (teamId will take precedence over teamCode if set)
the event team code. Can use the teamCode or the teamId (teamId will take precedence over teamCode if set)
the event location UID. Can use the locationCode or the locationId (locationId will take precedence over locationCode if set)
the event location code. Can use the locationCode or the locationId (locationId will take precedence over locationCode if set)
the event sub-location UID. Can use the subLocationCode or the subLocationId (subLocationId will take precedence over subLocationCode if set)
the event sub-location code. Can use the subLocationCode or the subLocationId (subLocationId will take precedence over subLocationCode if set)
This note is visible to the assigned employee and to shift team managers
The internalNote field is a private property restricted to shift team managers. This information is never visible to the assigned employee.
if true this event is in stand-by
Use to specified the number of places available for this open shift. If memberCode AND memberId are null or undefined, this value must be greater then 0. If memberCode OR memberId is specified, this value is ignored.
The member (employee) uid assigned to this shift. Can use the memberCode or the memberId (memberId will take precedence over memberCode if set).If memberCode AND memberId are null or undefined, openShiftCount must be greater then 0. If memberCode OR memberId is specified, openShiftCount is ignored.
The member (employee) code assigned to this shift. Can use the memberCode or the memberId (memberId will take precedence over memberCode if set). If memberCode is null or undefined, openShiftCount must be greater then 0. if memberCode is specified, openShiftCount is ignored.
if true this event is draft
The externalId is an optional, user-defined string that allows you to map objects in our system to records within your own external database or third-party application. This value is not validated or used by our internal application logic. It serves strictly as a metadata bridge for your integration. This is a searchable field but since our system does not enforce uniqueness on this field, we recommend using unique values to ensure your integration can reliably find records using your own identifiers
Array of premium codes to apply on the event. If set, premiumIds will take precedence over premiumCodes.
Array of premium ids to apply on the event. If set, premiumIds will take precedence over premiumCodes.
Example request
{
"premiumCodes": [
"premiumCode1",
"premiumCode2"
],
"premiumIds": [
"premiumId1",
"premiumId2"
]
}Response
unique event id
The unique event externalId. The externalId is often used as a mapping value between Evolia and an external system
date and time of the start of the event. In ISO-8601 format.
date and time of the end of the event. In ISO-8601 format.
if true the event has an undetermined end time. endsAt is still initialised but represent more a suggested end time
event time zone, ex: America/New_York
when assigned, contains the member (employee) first name
when assigned, contains the member (employee) first name
when assigned, contains the member (employee) UID
when assigned, contains the member (employee) code
when assigned, contains the member hourly wage specific to the skill of the shift
a shift is considered open when memberId is undefined. When a shift is open, openShiftCount indicates the number of places available
the event skill UID (position)
the event skill name (position)
the event skill code (position)
the event location UID
the event location name
the event location code
the event sub-location UID
the event sub-location name
the event sub-location code
the event division UID
the event team UID
the event team code
the event team name
if true this event is in stand-by
if true this event is cancelled
the reason of the cancellation
if true this event is draft
This note is visible to the assigned employee and to shift team managers
The internalNote field is a private property restricted to shift team managers. This information is never visible to the assigned employee.
The paid preparation time in minutes.
when assigned, member (employee) UID that assigned the event.
when assigned, date and time of the assignment of the event. In ISO-8601 format.
when event is split from another event, contains the source event UID
Example response
{
"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"
}
]
}Changes
No recorded changes to this endpoint across all 2 revisions of this API.