This is an open BETA version of the software and is intended only for experienced users of EquipCalendar.

 Rental Blocks

Rental blocks are the standard set of pricing windows (or blocks) you may rent your equipment for.

HTTP Methods and URLs

This endpoint uses the following HTTP methods and urls:

GET Used for retrieving all rental blocks https://api.equipcalendar.com/v2/rentalblocks
GET Used for retrieving a single rental block https://api.equipcalendar.com/v2/rentalblocks/{id:int}

All requests to this endpoint must contain an access_token (encoded using base64) in the Authorization HTTP Header. See the Authentication endpoint for more details.

Request Header (Example)
GET /v2/rentalblocks HTTP/1.1
Host: https://api.equipcalendar.com
Connection: keep-alive
User-Agent: Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 Chrome/43.0.2357.124 Safari/537.36
Content-Type: application/json
Accept: */*
Accept-Encoding: gzip, deflate
Accept-Language: en-US,en;q=0.8
Authorization: bearer MmViNDg0OGEtNDk1ZS00NDQ2LWE0MjEtYjBiOTYwM2E1Mno5Omd1aWQ=

Retrieving all rental blocks

GET https://api.equipcalendar.com/v2/rentalblocks

Request Body

NONE

Response

{
    "data": [
        {
            "id": 3,
            "pricingType": "1 Hour",
            "active": 1,
            "Links": [
                {
                    "rel": "self",
                    "method": "GET",
                    "href": "https://api.equipcalendar.com/v2/rentalblocks/3"
                }
            ]
        },
        {
            "id": 8,
            "pricingType": "2 Hour",
            "active": 0,
            "Links": [
                {
                    "rel": "self",
                    "method": "GET",
                    "href": "https://api.equipcalendar.com/v2/rentalblocks/8"
                }
            ]
        },
        {
            "id": 9,
            "pricingType": "3 Hour",
            "active": false</snipped for brevity>
                                            

Retrieve a single rental block

GET https://api.equipcalendar.com/v2/rentalblocks/{id:int}

Parameter(s)

Field Description Data Type Comments
id the identifier of the object to address integer 2^31-1 (2,147,483,647) Required

Request Body

NONE

Response

{
    "data": [
        {
            "id": 3,
            "pricingType": "1 Hour",
            "active": 1,
            "Links": [
                {
                    "rel": "self",
                    "method": "GET",
                    "href": "https://api.equipcalendar.com/v2/rentalblocks/3"
                }
            ]
        }
    ]
}
                                            

© 2024 EQPD, LLC