Modules

Calendar

Certificates

CollectiveAgreements

Company Forms

Company Forms Management

Contacts

Contracts

Customer Assets

Equipment

Expenses

Job Invoices

Jobs

Labour Actions

Library

Locates

Materials

Messages

Projects

Purchase Orders

Safety

Schedule

Service Quotes/Invoices

Service Requests

Services

Settings

TimeLogs

Users

Other

Event Resource
In Calendar Module


Endpoints

Endpoints URI Access Control Description
vacation-approval POST /api/Event/vacation-approval Endpoint level permissions

Used to trigger a vacation event as approved or rejected. Sends a notification to the user informing them of the status of their request. Sets rejected_by or approved_by fields based on value of approved parameter.

Required parameters:

  • approved: boolean
  • id: boolean. Id of the Event record
get GET /api/Event/get Allowed with an active employment connection
find GET /api/Event/find Allowed with an active employment connection
delete POST /api/Event/delete Admin or Module WRITE
save POST /api/Event/save Allowed with an active employment connection

Properties

Property Type Description
id number
slug string
user_id number
start datetime
end_time datetime
duration_hrs number
end date
title string
description string
is_vacation boolean
is_sickday boolean
approved_by number
rejected_by number
created_at datetime
updated_at datetime
updated_by number

Settings

Setting
Pagination Limit (when page parameter is set) None
Default Sort Order start DESC

Relationships

Related Resource Key Relationship to Event Property
User user_id Belongs To User
User approved_by Belongs To ApprovedBy
User rejected_by Belongs To RejectedBy