API Documentation

Modules

Calendar

Event

Certificates

CompanyCertificate UserCertificate UserCompanyCertificate

CollectiveAgreements

CollectiveAgreement

Company Forms

CompanyForm CompanyFormAcknowledgement CompanyFormRecurring FormMarketplaceCategory FormMarketplaceTemplate FormShareGroup

Company Forms Management

FormChildTemplate FormTemplate FormTemplateCategory

Contacts

Contact ContactFile ContactLocation

Contracts

ServiceContract ServiceContractFile ServiceContractProduct ServiceContractTask ServiceProduct

Customer Assets

CustomerAsset CustomerAssetCategory CustomerAssetFile CustomerAssetTemplate CustomerAssetTemplateCategory UserAsset UserAssetCategory

Equipment

Equipment EquipmentCategory EquipmentFile EquipmentFormAlert EquipmentMaintenanceEventReminder EquipmentMaintenanceEventType EquipmentMaintenanceLog EquipmentType

Expenses

Expense ReceiptImage

Job Invoices

JobInvoice JobInvoiceTask

Jobs

Job JobActualCostDatapoint JobBid JobBidComponent JobBidComponentObject JobChangeQuote JobChangeQuoteObject JobContact JobEstimate JobFile JobNote JobReport JobTask JobUser

Labour Actions

LabourAction LabourActionCategory

Library

LibraryFile

Locates

Locate LocateTicket

Materials

AssemblyTag Material MaterialAssembly MaterialAssemblyItem MaterialCategory

Messages

Message MessageThread MessageThreadUser

Purchase Orders

PurchaseOrder PurchaseOrderFile

Safety

SafetyControl SafetyForm SafetyFormTemplate SafetyHazard SafetyHazardCategory SafetyJobTask

Schedule

Service Quotes/Invoices

ServiceInvoice ServiceInvoiceObject ServiceQuoteTemplate ServiceQuoteTemplateObject

Service Requests

ServiceRequest

Services

Service ServiceChecklist ServiceContact ServiceFile ServiceSnapshot ServiceUser ServiceWorksheet ServiceWorksheetImage

Settings

AddonApp AddonAppInstalled Category ClassificationGroup CompanyAddress CompanySetting EmployeeClassification ExpenseCode ExpenseGroup FileTag JobFileTag PayBoost PermissionTemplate RevenueCode TimeLogSetting Union

TimeLogs

OpenTimeLog PayPeriod PayPeriodUserReport PendingOvertimeTransfer TimeLog TimeLogDetailedClaim

Users

EmployeeSetting LibraryAcknowledgement User UserLocation WorkHistory

Other

Activity BusinessType CertificateUpload Checklist Company CompanyCustomer CompanyLink CompanyUser DrawCanvas EmailList Engagement ErrorLog FileShareGroup ImageDrawLayer JobPersonnelRole JobSector KnowledgeBaseArticle KnowledgeBaseCategory LibraryUpload Module Notification NotificationQueue Product ProfileImage Proxy QuickbooksConnection Redirect ReleaseNote SharedDocument Subscription UploadFile UploadImage UserPermission UserToken Weather

ScheduleEvent Resource
In Schedule Module

Endpoints

Endpoints URI Access Control Description
vacation-approval POST /api/ScheduleEvent/vacation-approval Endpoint level permissions
send-notices POST /api/ScheduleEvent/send-notices Endpoint level permissions
delete POST /api/ScheduleEvent/delete Admin or Module WRITE
get GET /api/ScheduleEvent/get Admin or Module READ
get-range GET /api/ScheduleEvent/get-range Endpoint level permissions Return set of events within a date range
save POST /api/ScheduleEvent/save Allowed with an active employment connection
find GET /api/ScheduleEvent/find Admin or Module READ
compileCachedRelations GET /api/ScheduleEvent/compileCachedRelations Endpoint level permissions

Properties

Property Type Description
id number
slug string
user_id number
job_id number
service_id number
equipment_id number
start_time datetime
end_time datetime
repeat_until date
starting_location string
title string
notes string
is_vacation boolean
is_sickday boolean
is_off boolean
lead_technician_id number
approved_by number
rejected_by number
priority_index number
is_published boolean
parent_event_id number
notice_last_send datetime
delete_requested_by number
created_at datetime
updated_at datetime
updated_by number

Settings

Setting
Pagination Limit (when page parameter is set) 50 per page
Default Sort Order start_time DESC

Relationships

Related Resource Key Relationship to ScheduleEvent Property
User user_id Belongs To User
Job job_id Belongs To Job
Service service_id Belongs To Service
Equipment equipment_id Belongs To Equipment
User approved_by Belongs To ApprovedBy
User rejected_by Belongs To RejectedBy
User delete_requested_by Belongs To DeleteRequestedBy
ScheduleEvent parent_event_id Owns Many ScheduleEvent