Searching...
  1. Home
  2. User Guides
  3. RESTful API Documentation
  4. [v2] Set Branch Special Operating Hour API
Searching...

[v2] Set Branch Special Operating Hour API

Description Calling this endpoint by providing token of admin user to set branch special operating hour for a company.
Endpoint {DataManagerAPI}/api/v2/Site/[BranchId]/SetBranchSpecialOperatingHours
Method POST
Headers
  1. AToken: Token value return from API 'GenerateAccessToken' by providing the user name & password
Endpoint Description 1. 'BranchId' is unique key for identifying branch, do not simply modify this value
    1. 'BranchId' can be retrieve / refer from 'Sites API'
Body - JSON Example
[
            {
                "Date": "2022-06-29T00:00:00",
                "StartTime": "2022-06-29T00:00:00",
                "EndTime": "2022-06-29T00:00:00",
                "IsDayOff": true,
                "Comment": "Test special 1"
            },
            {
                "Date": "2022-07-12T00:00:00",
                "StartTime": "2022-07-12T00:00:00",
                "EndTime": "2022-07-12T00:00:00",
                "IsDayOff": true,
                "Comment": "Test special 2"
            }
]
Body Description
  1. 'Date' is the specific date that this special operating will apply to this branch
  2. 'IsDayOff' indicate whether that branch does not operate on specific day of week
  3. 'Comment' indicate the purpose of the special operating hour for. 
  4. The full list of special operating hour for the respective branches can be retrieved from API 'GetSpecialOperatingHour'

P.S. : Please pass all the special operating hour under this branch otherwise for those special operating hour that not in the JSON will considered as special operating hour that need to be deleted.   
Response - JSON Example
{
    "Status": 200,
    "Error": "",
    "Message": "Operating Hour updated",
    "Data": null
}
Updated on October 29, 2024