{
"openapi": "3.0.1",
"info": {
"title": "Working days API v1.3",
"description": "The working days API's open API documentation",
"version": "1.3"
},
"servers": [
{
"url": "https://api.workingdays.org"
}
],
"security": [
{
"ApiKeyAuth": []
}
],
"paths": {
"/1.3/analyse": {
"get": {
"description": "Analyse a period (you provide a start_date and an end_date over a given calendar, we respond with the period analysis)",
"parameters": [
{
"name": "country_code",
"in": "query",
"description": "The ISO country code (2 letters). See available countries & configurations",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "US"
},
{
"name": "start_date",
"in": "query",
"description": "The start date (YYYY-MM-DD)",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "2013-01-01"
},
{
"name": "end_date",
"in": "query",
"description": "The end date (YYYY-MM-DD)",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "2013-12-31"
},
{
"name": "start_time",
"in": "query",
"description": "The start date's time (24 hours format, like 09:00 or 15:00, but not 3pm).If omitted, default value is 00:00",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "09:14"
},
{
"name": "end_time",
"in": "query",
"description": "The end date's time (24 hours format, like 09:00 or 15:00, but not 3pm).If omitted, default value is 23:59.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "18:15"
},
{
"name": "configuration",
"in": "query",
"description": "The name of the preset configuration to be used. See available countries & configurations",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "Federal holidays"
},
{
"name": "profile_id",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"description": "If you want to query a customized calendar, provide its profile_id (6 caracters)"
}
}
],
"responses": {
"200": {
"description": "Valid request",
"headers": {
"consumed-quota": {
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"description": "The number of days consumed by this request (removed from your monthly quota), equal to the number of days of the period analysed"
}
}
},
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/inline_response_200"
}
}
}
},
"400": {
"description": "Invalid input parameters. Refer to specific message"
},
"401": {
"description": "Invalid Key"
},
"403": {
"description": "Monthly quota exceeded. Refer to specific message"
}
}
}
},
"/1.3/add_working_days": {
"get": {
"description": "Add (or remove) any number of working days to a date.",
"parameters": [
{
"name": "country_code",
"in": "query",
"description": "The ISO country code (2 letters). See available countries & configurations",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "US"
},
{
"name": "start_date",
"in": "query",
"description": "The start date (YYYY-MM-DD)",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "2013-12-31"
},
{
"name": "increment",
"in": "query",
"description": "The number of working days you want to add to your start date (positive or negative integer but not zero)",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "integer"
},
"example": 10
},
{
"name": "include_start",
"in": "query",
"description": "Should the count include the start_date? Default value is true. If you set include_start to false (\"false\" or \"0\"), the count will start at the next working day (or previous working day, if increment is negative)",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
}
},
{
"name": "configuration",
"in": "query",
"description": "The name of the preset configuration to be used. See available countries & configurations",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "Federal holidays"
},
{
"name": "profile_id",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"description": "The ID of a customized calendar (6 caracters)."
}
}
],
"responses": {
"200": {
"description": "Valid request",
"headers": {
"consumed-quota": {
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"description": "The number of days consumed by this request (removed from your monthly quota), equal to the number of days of the period analysed"
}
}
},
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/inline_response_200_1"
}
}
}
},
"400": {
"description": "Invalid input parameters. Refer to specific message"
},
"401": {
"description": "Invalid Key"
},
"403": {
"description": "Monthly quota exceeded. Refer to specific message"
}
}
}
},
"/1.3/get_info_day": {
"get": {
"description": "Get detailed information about a specific day.",
"parameters": [
{
"name": "country_code",
"in": "query",
"description": "The ISO country code (2 letters). See available countries & configurations",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "US"
},
{
"name": "date",
"in": "query",
"description": "The date to analyze (YYYY-MM-DD)",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "2013-12-31"
},
{
"name": "configuration",
"in": "query",
"description": "The name of the preset configuration to be used. See available countries & configurations",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "Federal holidays"
},
{
"name": "profile_id",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"description": "If you created several profiles under your custom configuration, the ID of the profile to be used (6 caracters)"
}
}
],
"responses": {
"200": {
"description": "Valid request",
"headers": {
"consumed-quota": {
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"description": "The number of days consumed by this request (removed from your monthly quota), equal to 1."
}
}
},
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/inline_response_200_2"
},
"example": {
"working_day": 0,
"work_hours": 0,
"wages": 0,
"morning_start": "",
"morning_end": "",
"afternoon_start": "",
"afternoon_end": "",
"public_holiday": "1",
"public_holiday_description": "New Year's Day",
"weekend_day": 0,
"custom_date": 0,
"custom_date_description": "",
"custom_date_color": "",
"type": 2
}
}
}
},
"400": {
"description": "Invalid input parameters. Refer to specific message"
},
"401": {
"description": "Invalid Key"
},
"403": {
"description": "Monthly quota exceeded. Refer to specific message"
}
}
}
},
"/1.3/list_non_working_days": {
"get": {
"description": "List the non working days (weekend days, public holidays and custom dates) between two dates in chronlogical order.",
"parameters": [
{
"name": "country_code",
"in": "query",
"description": "The ISO country code (2 letters). See available countries & configurations",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "US"
},
{
"name": "start_date",
"in": "query",
"description": "The start date (YYYY-MM-DD)",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "2013-01-01"
},
{
"name": "end_date",
"in": "query",
"description": "The end date (YYYY-MM-DD)",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "2013-12-31"
},
{
"name": "configuration",
"in": "query",
"description": "The name of the preset configuration to be used. See available countries & configurations",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "Federal holidays"
},
{
"name": "profile_id",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"description": "If you want to query a customized calendar, provide its profile_id (6 caracters)"
}
}
],
"responses": {
"200": {
"description": "Valid request",
"headers": {
"consumed-quota": {
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"description": "The number of days consumed by this request (removed from your monthly quota), equal to the length of the period analysed"
}
}
},
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/inline_response_200_3"
}
}
}
},
"400": {
"description": "Invalid input parameters. Refer to specific message"
},
"401": {
"description": "Invalid Key"
},
"403": {
"description": "Monthly quota exceeded. Refer to specific message"
}
}
}
},
"/1.3/add_working_hours": {
"get": {
"description": "Add an amount of working time to a given start date/time",
"parameters": [
{
"name": "country_code",
"in": "query",
"description": "The ISO country code (2 letters). See available countries & configurations",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "US"
},
{
"name": "start_date",
"in": "query",
"description": "The start date (YYYY-MM-DD)",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "2013-12-31"
},
{
"name": "start_time",
"in": "query",
"description": "The start time in a 24 hours format with leading zeros.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "08:15"
},
{
"name": "increment_time",
"in": "query",
"description": "The amount of working time to be added (or removed) to the start date time. Format H:i. This amount cannot exceed 5000 hours. For example, to add one hour: 1:00. To add 30 hours and 15 minutes: 30:15. To remove 45 minutes: -0:45",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": 1815
},
{
"name": "configuration",
"in": "query",
"description": "The name of the preset configuration to be used. See available countries & configurations",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "Federal holidays"
},
{
"name": "profile_id",
"in": "query",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"description": "If you created several profiles under your custom configuration, the ID of the profile to be used (6 caracters)"
}
}
],
"responses": {
"200": {
"description": "Valid request",
"headers": {
"consumed-quota": {
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"description": "The number of days consumed by this request (removed from your monthly quota). This command will consume 1 day for every 8 hours added/removed from your monthly quota."
}
}
},
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/inline_response_200_4"
}
}
}
},
"400": {
"description": "Invalid input parameters. Refer to specific message"
},
"401": {
"description": "Invalid Key"
},
"403": {
"description": "Monthly quota exceeded. Refer to specific message"
}
}
}
},
"/1.3/add_profile": {
"get": {
"description": "Creating or removing profiles can be done in a friendly way from the working days websites, however creating new profiles programmatically can be useful in some situations (for instance interfacing the human ressources repository, adding one profile per employee with a script).\nWhen you create a new profile programmatically, it will be under the under the email of the API's subscriber account.\nWith an INITIAL plan, you can create up to 5 profiles per country. With a PRO plan, you can create up to 30 profiles per country. With a PREMIUM plan, you can create unlimited number of profiles.",
"parameters": [
{
"name": "profile_name",
"in": "query",
"description": "The name of your profile (up to 20 caracters)",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "John Doe"
},
{
"name": "country_code",
"in": "query",
"description": "The ISO country code (2 letters). See available countries & configurations",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "US"
},
{
"name": "configuration",
"in": "query",
"description": "The name of the preset configuration to be used. See available countries & configurations",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "Federal holidays"
},
{
"name": "weekend",
"in": "query",
"description": "The weekend days of the calendars. Read advanced parameters",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": 1100001
},
{
"name": "start_template",
"in": "query",
"description": "In case you are using an alternating week template. Read advanced parameters",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "week_times",
"in": "query",
"description": "The week work hours. If omitted, working days's morning will be worked from 8:00 to 12:00 and working days's afternoon from 14:00 to 18:00 Read advanced parameters",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Valid request",
"headers": {
"consumed-quota": {
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"description": "The number of days consumed by this request (removed from your monthly quota). This command will consume 1000 days from your monthly quota."
}
}
},
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/inline_response_200_5"
},
"example": {
"profile_id": "CB7EF3"
}
}
}
},
"400": {
"description": "Invalid input parameters. Refer to specific message"
},
"401": {
"description": "Invalid Key"
},
"403": {
"description": "Monthly quota exceeded. Refer to specific message"
}
}
}
},
"/1.3/delete_profile": {
"get": {
"description": "Delete a profile identified by its profile_id.",
"parameters": [
{
"name": "profile_id",
"in": "query",
"description": "The ID of the profile you want to delete (under your account)",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "CB7EF3"
},
{
"name": "country_code",
"in": "query",
"description": "The ISO country code (2 letters). See available countries & configurations",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "US"
}
],
"responses": {
"200": {
"description": "Valid request",
"headers": {
"consumed-quota": {
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"description": "The number of days consumed by this request (removed from your monthly quota). This command will consume 1 day from your monthly quota."
}
}
},
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/inline_response_200_5"
},
"example": {
"profile_id": "CB7EF3"
}
}
}
},
"400": {
"description": "Invalid input parameters. Refer to specific message"
},
"401": {
"description": "Invalid Key"
},
"403": {
"description": "Monthly quota exceeded. Refer to specific message"
}
}
}
},
"/1.3/define_custom_period": {
"get": {
"description": "Defining a custom period (typically days of vacations of an employee or days of annual closure of a company) can be done from the working days websites user interface but can also be done programmatically from the API. A typical use case would be to retrieve the vacations of the workers out of the human ressources software and insert them into a custom calendar, then being able to query available working days.",
"parameters": [
{
"name": "profile_id",
"in": "query",
"description": "The ID of the calendar we are customizing.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "CB7EF3"
},
{
"name": "start_date",
"in": "query",
"description": "The start date of the custom period (YYYY-MM-DD)",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "2013-01-01"
},
{
"name": "end_date",
"in": "query",
"description": "The end date of the custom period (YYYY-MM-DD) If omitted, end date will be equal to start date (one day custom period)",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "2013-01-07"
},
{
"name": "description",
"in": "query",
"description": "A textual description of the custom period (up to 30 caracters)",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "Vacations to Bahamas"
},
{
"name": "color",
"in": "query",
"description": "The color of custom period when displayed on the calendar. Colors can be useful in order to classify custom periods. Default value is orange.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"$ref": "#/components/schemas/Color"
}
},
{
"name": "start_morning",
"in": "query",
"description": "Does the custom period starts in the morning of the start_date? Default value is true. (This parameter can be used if you want to create half day custom periods.)",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
}
},
{
"name": "end_afternoon",
"in": "query",
"description": "Does the custom period ends in the afternoon of the end_date? Default value is true. (This parameter can be used if you want to create half day custom periods.)",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Valid request",
"headers": {
"consumed-quota": {
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"description": "The number of days consumed by this request (removed from your monthly quota), equal to the lenght of the period."
}
}
},
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/inline_response_200_6"
},
"example": {
"message": "13 custom dates successfuly saved under profile CB7EF3"
}
}
}
},
"400": {
"description": "Invalid input parameters. Refer to specific message"
},
"401": {
"description": "Invalid Key"
},
"403": {
"description": "Monthly quota exceeded or plan limit reached. API users with a premium plan can add any number of custom date to a profiles. Other users will be limited to 200 custom dates per profile."
}
}
}
},
"/1.3/delete_custom_period": {
"get": {
"description": "Removing a previously defined custom period",
"parameters": [
{
"name": "profile_id",
"in": "query",
"description": "The ID of the calendar we are customizing.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "CB7EF3"
},
{
"name": "start_date",
"in": "query",
"description": "The start date of the custom period (YYYY-MM-DD)",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "2013-01-01"
},
{
"name": "end_date",
"in": "query",
"description": "The end date of the custom period (YYYY-MM-DD) If omitted, end date will be equal to start date (one day custom period)",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "2013-01-07"
}
],
"responses": {
"200": {
"description": "Valid request",
"headers": {
"consumed-quota": {
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"description": "The number of days consumed by this request (removed from your monthly quota), equal to the lenght of the period."
}
}
},
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/inline_response_200_6"
},
"example": {
"message": "Custom dates successfully removed from profile A56D52 "
}
}
}
},
"400": {
"description": "Invalid input parameters. Refer to specific message"
},
"401": {
"description": "Invalid Key"
},
"403": {
"description": "Monthly quota exceeded."
}
}
}
},
"/1.3/quota": {
"get": {
"description": "Know your quota",
"responses": {
"200": {
"description": "Valid request",
"headers": {
"consumed-quota": {
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"description": "The number of days consumed by this request (0 as a request on command=quota does not consume any of your quota)."
}
}
},
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/inline_response_200_7"
},
"example": {
"state": 1,
"current": 41644,
"next": 50000
}
}
}
},
"400": {
"description": "Invalid input parameters. Refer to specific message"
},
"401": {
"description": "Invalid Key"
},
"403": {
"description": "Monthly quota exceeded. Refer to specific message"
}
}
}
}
},
"components": {
"schemas": {
"Public_holiday": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The date of the public holdiday (YYYY-MM-DD)"
},
"description": {
"type": "string",
"description": "The name od the public holiday"
}
}
},
"Color": {
"type": "string",
"description": "The color chosen by the user for a custom date. Colors can be useful to organise custom dates into categories.",
"enum": [
"orange",
"green",
"blue",
"pink",
"yellow"
]
},
"Custom_date": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The date of the custom date (YYYY-MM-DD)"
},
"description": {
"type": "string",
"description": "Your description of the custom date"
},
"type": {
"type": "integer",
"description": "The type of custom date (4 == custom date not worked, 8 == custom working day, 64 == custom working morning, 128 == custom working afternoon, 256 == custom morning not worked, 512 == custom afternoon not worked)"
}
}
},
"Non_working_day": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The date of the custom date (YYYY-MM-DD)",
"example": "2023-01-01"
},
"description": {
"type": "string",
"description": "The description of the non working day. If it is a public holiday you will get the name of the public holiday. If it is a weekend day you will get \"weekend day\", if it is a custom date, you will get your description of the custom date",
"example": "New year's day"
},
"type": {
"type": "integer",
"description": "The type of custom date (1== weekend day, 2 == public holiday, 4 == custom date not worked, 8 == custom working day, 64 == custom working morning, 128 == custom working afternoon, 256 == custom morning not worked, 512 == custom afternoon not worked, 1024 == week end day, morning only, 2048 == week end day, afternoon only, 4096 == public holiday, morning only, 8192 == public holiday, afternoon only). The type is a bitfield, which means type can be equals to several of this value at same time (for instance for a public holiday falling on a weekend, type will be equal to 2+1=3)",
"example": 2
}
}
},
"inline_response_200": {
"type": "object",
"properties": {
"days": {
"$ref": "#/components/schemas/inline_response_200_days"
},
"working_days": {
"$ref": "#/components/schemas/inline_response_200_working_days"
},
"weekend_days": {
"$ref": "#/components/schemas/inline_response_200_weekend_days"
},
"public_holidays": {
"$ref": "#/components/schemas/inline_response_200_public_holidays"
},
"custom_dates": {
"$ref": "#/components/schemas/inline_response_200_custom_dates"
}
}
},
"inline_response_200_1": {
"type": "object",
"properties": {
"end_date": {
"type": "string",
"description": "The end date (YYYY-MM-DD)",
"example": "2013-01-15"
},
"days": {
"$ref": "#/components/schemas/inline_response_200_days"
},
"working_days": {
"$ref": "#/components/schemas/inline_response_200_working_days"
},
"weekend_days": {
"$ref": "#/components/schemas/inline_response_200_weekend_days"
},
"public_holidays": {
"$ref": "#/components/schemas/inline_response_200_public_holidays"
},
"custom_dates": {
"$ref": "#/components/schemas/inline_response_200_custom_dates"
}
}
},
"inline_response_200_2": {
"type": "object",
"properties": {
"working_day": {
"type": "number",
"description": "0 if's not a working day / 1 if it is a working day / 0.5 in case you defined an half open day through a custom configuration",
"example": 1
},
"work_hours": {
"type": "number",
"description": "The number of working hours in this day (a float between 0 and 24)",
"example": 8
},
"wages": {
"type": "number",
"description": "The wages earned during this day this day. By default, this is equal to the number of work hours x 20, but it can be define more finely through a custom configuration",
"example": 160
},
"morning_start": {
"type": "string",
"description": "The start time of the working morning in a 24 hours format with leading zeros. If that morning is not worked, the field is empty.",
"example": "08:00"
},
"morning_end": {
"type": "string",
"description": "The end time of the working morning in a 24 hours format with leading zeros. If that morning is not worked, the field is empty.",
"example": "720"
},
"afternoon_start": {
"type": "string",
"description": "The start time of the working afternoon in a 24 hours format with leading zeros. If that afternoon is not worked, the field is empty.",
"example": "840"
},
"afternoon_end": {
"type": "string",
"description": "The end time of the working afternoon in a 24 hours format with leading zeros. If that afternoon is not worked, the field is empty.",
"example": "1080"
},
"public_holiday": {
"type": "number",
"description": "0 if's not a public holiday / 1 if it is a public holiday / 0.5 if is a public holiday only the morning or the afternoon",
"example": 0
},
"public_holiday_description": {
"type": "string",
"description": "in case that day is a public holiday, you will get it's name here.",
"example": "New year's day"
},
"weekend_day": {
"type": "number",
"description": "0 if's not a weekend day / 1 if it is a weekend day / 0.5 if you defined an half weekend day through a custom configuration",
"example": 0
},
"custom_date": {
"type": "number",
"description": "0 if you did not define any custom date on that day / 1 if you define a custom date on that day / 0.5 if you define an half custom date on that day",
"example": 0
},
"custom_date_description": {
"type": "string",
"description": "In case you defined a custom date through a custom configuration, you get the label you defined here.",
"example": "My firm is closed (annual closure)"
},
"custom_date_color": {
"$ref": "#/components/schemas/Color"
}
}
},
"inline_response_200_3": {
"type": "object",
"properties": {
"non_working_days": {
"type": "array",
"description": "The list of the non working days over the period in chronological order",
"items": {
"$ref": "#/components/schemas/Non_working_day"
}
}
}
},
"inline_response_200_4": {
"type": "object",
"properties": {
"end_date": {
"type": "string",
"description": "The end date (YYYY-MM-DD)",
"example": "2013-01-15"
},
"end_time": {
"type": "string",
"description": "The end date's time (H:i)",
"example": "1020"
}
}
},
"inline_response_200_5": {
"type": "object",
"properties": {
"profile_id": {
"type": "string",
"description": "Rhe ID of the new profile",
"example": "2013-01-15"
}
}
},
"inline_response_200_6": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A confirmation message"
}
}
},
"inline_response_200_7": {
"type": "object",
"properties": {
"state": {
"type": "number",
"description": "The state of your plan (1==active, 2==cancelled, -2==unknown key)"
},
"current": {
"type": "number",
"description": "Your current quota (days left to be analysed within this month)"
},
"next": {
"type": "number",
"description": "The quota that will be available at the begining of the next month"
}
}
},
"inline_response_200_days": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "The number of days over the period"
},
"mondays": {
"type": "number",
"description": "The number of mondays over the period"
},
"tuesdays": {
"type": "number",
"description": "The number of tuesdays over the period"
},
"wednesdays": {
"type": "number",
"description": "The number of wednesdays over the period"
},
"thursdays": {
"type": "number",
"description": "The number of thursdays over the period"
},
"fridays": {
"type": "number",
"description": "The number of fridays over the period"
},
"saturdays": {
"type": "number",
"description": "The number of saturdays over the period"
},
"sundays": {
"type": "number",
"description": "The number of sundays over the period"
},
"hours": {
"type": "number",
"description": "The number of hours & minutes (expressed in a floating number of hours) from start_date at 00:00 to end_date at 23:59"
}
},
"description": "Days information"
},
"inline_response_200_working_days": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "The number of working days over the period"
},
"mondays": {
"type": "number",
"description": "The number of working mondays over the period"
},
"tuesdays": {
"type": "number",
"description": "The number of working tuesdays over the period"
},
"wednesdays": {
"type": "number",
"description": "The number of working wednesdays over the period"
},
"thursdays": {
"type": "number",
"description": "The number of working thursdays over the period"
},
"fridays": {
"type": "number",
"description": "The number of working fridays over the period"
},
"saturdays": {
"type": "number",
"description": "The number of working saturdays over the period"
},
"sundays": {
"type": "number",
"description": "The number of working sundays over the period"
},
"work_hours": {
"type": "number",
"description": "The number of working hours over the period"
},
"wages": {
"type": "number",
"description": "The wages earned over the period"
}
},
"description": "Working Days information"
},
"inline_response_200_weekend_days": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "The number of weekend days over the period"
},
"mondays": {
"type": "number",
"description": "The number of weekend mondays over the period"
},
"tuesdays": {
"type": "number",
"description": "The number of weekend tuesdays over the period"
},
"wednesdays": {
"type": "number",
"description": "The number of weekend wednesdays over the period"
},
"thursdays": {
"type": "number",
"description": "The number of weekend thursdays over the period"
},
"fridays": {
"type": "number",
"description": "The number of weekend fridays over the period"
},
"saturdays": {
"type": "number",
"description": "The number of weekend saturdays over the period"
},
"sundays": {
"type": "number",
"description": "The number of weekend sundays over the period"
}
},
"description": "Weekend Days information"
},
"inline_response_200_public_holidays": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "The number of public holidays over the period"
},
"mondays": {
"type": "number",
"description": "The number of public holidays mondays over the period"
},
"tuesdays": {
"type": "number",
"description": "The number of public holidays tuesdays over the period"
},
"wednesdays": {
"type": "number",
"description": "The number of public holidays wednesdays over the period"
},
"thursdays": {
"type": "number",
"description": "The number of public holidays thursdays over the period"
},
"fridays": {
"type": "number",
"description": "The number of public holidays fridays over the period"
},
"saturdays": {
"type": "number",
"description": "The number of public holidays saturdays over the period"
},
"sundays": {
"type": "number",
"description": "The number of public holidays sundays over the period"
},
"list": {
"type": "array",
"description": "The list of public holidays over the period",
"items": {
"$ref": "#/components/schemas/Public_holiday"
}
}
},
"description": "Public holidays information"
},
"inline_response_200_custom_dates": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "The number of custom dates over the period"
},
"mondays": {
"type": "number",
"description": "The number of custom dates mondays over the period"
},
"tuesdays": {
"type": "number",
"description": "The number of custom dates tuesdays over the period"
},
"wednesdays": {
"type": "number",
"description": "The number of custom dates wednesdays over the period"
},
"thursdays": {
"type": "number",
"description": "The number of custom dates thursdays over the period"
},
"fridays": {
"type": "number",
"description": "The number of custom dates fridays over the period"
},
"saturdays": {
"type": "number",
"description": "The number of custom dates saturdays over the period"
},
"sundays": {
"type": "number",
"description": "The number of custom dates sundays over the period"
},
"list": {
"type": "array",
"description": "The list of custom dates over the period",
"items": {
"$ref": "#/components/schemas/Custom_date"
}
}
},
"description": "Custom dates information (user defined)"
}
},
"securitySchemes": {
"ApiKeyAuth": {
"type": "apiKey",
"name": "key",
"in": "header"
}
}
}
}