Holidays - API Requests

Holidays - API Requests

This document provides information about the PurePro public API endpoints associated with holiday operations and their objects.
Common operations;

https://slite.com/api/files/BxQDRhTdgrHVe1/imported-image?apiToken=eyJhbGciOiJIUzI1NiIsImtpZCI6IjIwMjMtMDUtMDQifQ.eyJzY29wZSI6Im5vdGUtZXhwb3J0IiwibmlkIjoiN3BfVW1VUEtRRERDZF8iLCJpYXQiOjE3ODIwMTk0NTksImlzcyI6Imh0dHBzOi8vc2xpdGUuY29tIiwianRpIjoidTUyWXpHVEhLT3JVTXQiLCJleHAiOjE3ODQ2MTE0NTl9.AmwXUyUyAga6_HSSqtcW6tglAVJbNMW9cJhrRpxpLx4
APIs are Business Unit-specific and do not follow the Parent–Child Business Unit hierarchy.
The Worker must belong to the same Business Unit as the API request.
Please select one of the options below: -

SummaryByWorker

Method: 
BaseURL: //{{publicApiUrl}}/Holiday/{{accountReference}}/SummaryByWorker/{periodID}?workerreference=worker_ref&size=20&page=2
To retrieve summary of a worker's holiday data via public API you need to pass the account and business unit reference along with the worker reference and period id to the base URL as the required parameters
The key dependencies and validations are:
Property
Acceptable Format
Validations
Account
String
  • Cannot be Null
  • Cannot be left blank
Business Unit
String
  • Cannot be Null
  • Cannot be left blank
PeriodID
String
  • Cannot be Null
  • You must input the period for which you want to view the document for
  • Must be provided in the following format 20231001000
WorkerReference
String
  • Cannot be Null
  • You must enter the worker reference for which you want to view the document
  • Must be a reference of a worker in the system
page
Decimals
  • Can be Left Blank
Size
Decimals
  • Can be Left Blank

Summary

Method: 
BaseURL: //{{publicApiUrl}}/Holiday/{{accountReference}}/SummaryByWorker/{periodID}?size=20&page=2
To retrieve summary of holiday data for all the active workers in the account via public API you need to pass the account and business unit reference along with the period id to the base URL as the required parameters
Property
Acceptable Format
Validations
Account
String
  • Cannot be Null
  • Cannot be left blank
Business Unit
String
  • Cannot be Null
  • Cannot be left blank
PeriodID
String
  • Cannot be Null
  • You must input the period for which you want to view the document for
  • Must be provided in the following format 20231001000
page
Decimals
  • Can be Left Blank
Size
Decimals
  • Can be Left Blank

The contents of this document, along with any associated documents, are the property of PurePro Solutions Ltd. and are shared in strict confidence with the intended recipient. These materials may not be reproduced, shared, or used in any manner without prior written consent from PurePro Solutions Ltd. Unauthorized use or distribution is prohibited.