Tenant Calendar

Get Tenant Calendar for the currently signed in user

GET /v1/tenant/calendar

Returns

  • the calendar object for the currently signed in user.

Create a tenant calendar for the currently signed in user

POST /v1/tenant/calendar

body

  • a Calendar Object of open hours

Update the tenant calendar for the currently signed in user

PUT /v1/tenant/calendar

body

  • a Calendar Object of open hours

Get the hours for the currently signed in user for a range of days

GET /v1/tenant/calendar/range
Parameters
  • startTime:  ISO8601 String representing the start time for the range
  • endTime: ISO8601 String representing the end time for the range

Returns 

  • a calendar range object for the specified date range.

B2C End Points

Get a tenant's open hours

GET /v1/b2c/tenant/calendar

Parameters

  • tenantId
    • Required
    • x-acme-tenant header value

Returns

  • The calendar for the specified tenant

Get the hours for the currently signed in user for a range of days

GET /v1/b2c/tenant/calendar

Parameters

  • tenantId
    • Required
    • x-acme-tenant header value

Returns

  • A calendar range object for the specified tenant

Calendar JSON Objects

Calendar Object

  • standard:  List of standard hours
    • weekdays: List of weekdays names, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.  (Required)
    • hours: List of time ranges for this list of weekdays in the form HH:MM-HH:MM  like "09:00 - 17:30", "closed" if they are closed that day (Required)
  • exceptions
    • date: Date for this exception, in the form of YYYY-MM-DD like "2014-01-01" (Required)
    • hours:  List of hours in the form HH:MM-HH:MM  like "09:00 - 17:30", "closed" if they are closed that day (Required)
    • name:  The name of the day, like Christmas.  (Optional)

Calendar Range Object

  • days: List of hours for each day in the range
    • date: Date for this exception, in the form of YYYY-MM-DD like "2014-01-01"
    • hours:  List of hours in the form HH:MM-HH:MM  like "09:00 - 17:30", "closed" if they are closed that day

 

Example JSON for Calendar Object

Sample Open Hours
{
   "standard": [
        {
            "hours": [
                "10:00-23:30"
            ],
            "weekdays": [
                "Saturday"
            ]
        },
        {
            "hours": [
                "09:00-22:00"
            ],
            "weekdays": [
                "Monday",
                "Tuesday",
                "Wednesday",
                "Thursday",
                "Friday"
            ]
        },
        {
            "hours": [
                "11:00-21:00"
            ],
            "weekdays": [
                "Sunday"
            ]
        }
    ],
    "exceptions": [
        {
            "date""2014-11-27",
            "hours": [
                "closed"
            ], 
            "name" "Thanksgiving"
        },
        {
            "date""2014-01-01",
            "hours": [
                "closed"
            ],
            "name" "New Years"
        },
        {
            "date""2014-02-14",
            "hours": [
                "09:00-14:00"
            ],
            "name""Valentine's Day"
        },
        {
            "date""2014-01-20",
            "hours": [
                "closed"
            ],
            "name" "Martin Luther King's Birthday"
        },
        {
            "date""2014-04-18",
            "hours": [
                "09:00-14:00"
            ],
            "name" "Company Birthday"
        },
        {
            "date""2014-04-20",
            "hours": [
                "closed"
            ],
            "name" "Earth Day"
        },
        {
            "date""2014-05-11",
            "hours": [
                "09:00-14:00"
            ]
        },
        {
            "date""2014-05-26",
            "hours": [
                "closed"
            ], 
            "name" "Memorial Day"
        },
        {
            "date""2014-07-04",
            "hours": [
                "closed"
            ],
            "name" "Independence Day"
        },
        {
            "date""2014-07-14",
            "hours": [
                "closed"
            ],
            "name" "Bastille Day"
        },
        {
            "date""2014-02-17",
            "hours": [
                "closed"
            ]
        },
        {
            "date""2014-09-01",
            "hours": [
                "closed"
            ],
            "name" "Labor Day"
        },
        {
            "date""2014-10-13",
            "hours": [
                "closed"
            ],
            "name" "Columbus Day"
        },
        {
            "date""2014-11-11",
            "hours": [
                "closed"
            ],
            "name" "Remembrance Day"
        },
        {
            "date""2014-12-25",
            "hours": [
                "closed"
            ], 
            "name" "Christmas"
        }
    ]
}