API Documentation
Holidays ¶
GET /api/v2/holidays
Requests
GET /api/v2/holidays
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [
{
"id": "4",
"type": "holidays",
"attributes": {
"name": "International Goof Off Day",
"date": "2024-04-20"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "532"
}
},
"holiday_calendar": {
"meta": {
"included": false
}
}
}
},
{
"id": "5",
"type": "holidays",
"attributes": {
"name": "International Goof Off Day",
"date": "2024-04-20"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "532"
}
},
"holiday_calendar": {
"meta": {
"included": false
}
}
}
},
{
"id": "6",
"type": "holidays",
"attributes": {
"name": "International Goof Off Day",
"date": "2024-04-20"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "532"
}
},
"holiday_calendar": {
"meta": {
"included": false
}
}
}
}
],
"links": {
"first": "http://api-test.productive.io/api/v2/holidays?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://api-test.productive.io/api/v2/holidays?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 3,
"page_size": 30,
"max_page_size": 200
}
}
Get all holidaysGET/api/v2/holidays
GET /api/v2/holidays/1
Requests
GET /api/v2/holidays/7
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "7",
"type": "holidays",
"attributes": {
"name": "International Goof Off Day",
"date": "2024-04-20"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "533"
}
},
"holiday_calendar": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/holidays
Requests
POST /api/v2/holidays
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "holidays",
"attributes": {
"name": "Dont Cry over Spilled Milk Day",
"date": "2017-02-11",
"holiday_calendar_id": 115
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "13",
"type": "holidays",
"attributes": {
"name": "Dont Cry over Spilled Milk Day",
"date": "2017-02-11"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "534"
}
},
"holiday_calendar": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/holidays
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "holidays",
"attributes": {}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/date"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/holiday_calendar"
}
}
]
}
Create a holidayPOST/api/v2/holidays
URI Parameters
- name
string
(required) Example: Namename
- date
date
(required) Example: 2018-01-01date
PATCH /api/v2/holidays/1
Requests
PATCH /api/v2/holidays/17
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "holidays",
"attributes": {
"name": "Lame Duck Day",
"date": "2017-02-06",
"holiday_calendar_id": 117
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "17",
"type": "holidays",
"attributes": {
"name": "Lame Duck Day",
"date": "2017-02-06"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "536"
}
},
"holiday_calendar": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/holidays/20
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "holidays",
"attributes": {
"name": null
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
}
]
}
DELETE /api/v2/holidays/1
Requests
DELETE /api/v2/holidays/23
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
This response has no content.
Generated by aglio on 20 Apr 2024