Clerk API

Clerk data API allows a program to perform many of the operations offered in a Clerk hotel account.

Bookings

All bookings

Shows a list of the hotel bookings by check-in and check-out date.

https://api.clerk.im/bookings/all.{format}

Format

jSON

https://api.clerk.im/bookings/all.json

XML

https://api.clerk.im/bookings/all.xml
Parameters
api_key Required Your Clerk API Key
date_checkin Required Check-IN date (YYYY-MM-DD)
date_checkout Required Check-OUT date (YYYY-MM-DD)

Example

URL

https://api.clerk.im/bookings/all.json?api_key=xxx&date_checkin=2011-01-01&date_checkout=2011-01-01

Response

{

    -
    rsp: {
        -
        status: {
            msg: "OK"
            code: 200
        }
        -
        bookings: [
            -
            {
                -
                booking_info: {
                    status: "Checked-out"
                    id: 3313
                    checkin: "2011-01-01"
                    checkout: "2011-01-02"
                }
                -
                client: {
                    passport: "DNI"
                    name: "Fabian"
                    country: "CL"
                    lastname: "Ramirez"
                }
                -
                rooms: [
                    -
                    {
                        -
                        room: {
                            name: "331"
                            -
                            room_type: {
                                name: "Room Type"
                                id: 441
                            }
                            date_checkout: "2011-01-01"
                            id: 86
                            date_checkin: "2011-01-02"
                        }
                    }     
              ]                      
        ]
    }

Room

Shows a list of the hotel bookings by room.

https://api.clerk.im/bookings/room.{format}

Format

jSON

https://api.clerk.im/bookings/room.json

XML

https://api.clerk.im/bookings/room.xml
Parameters
api_key Required Your Clerk API Key
room_id Required Your Clerk Room ID
date_checkin Required Check-IN date (YYYY-MM-DD)
date_checkout Required Check-OUT date (YYYY-MM-DD)

Example

URL

https://api.clerk.im/bookings/room.json?api_key=xxx&&room_id=331&date_checkin=2011-01-01&date_checkout=2011-01-01

Response

{

    -
    rsp: {
        -
        status: {
            msg: "OK"
            code: 200
        }
        -
        bookings: [
            -
            {
                -
                booking_info: {
                    status: "Checked-out"
                    id: 3313
                    checkin: "2011-01-01"
                    checkout: "2011-01-02"
                }
                -
                client: {
                    passport: "DNI"
                    name: "Fabian"
                    country: "CL"
                    lastname: "Ramirez"
                }
                -
                rooms: [
                    -
                    {
                        -
                        room: {
                            name: "331"
                            -
                            room_type: {
                                name: "Room Type"
                                id: 441
                            }
                            date_checkout: "2011-01-01"
                            id: 86
                            date_checkin: "2011-01-02"
                        }
                    } 
              ]                          
        ]
    }

Room Type

Shows a list of the hotel bookings by room type.

https://api.clerk.im/bookings/room_type.{format}

Format

jSON

https://api.clerk.im/bookings/room_type.json

XML

https://api.clerk.im/bookings/room_type.xml
Parameters
api_key Required Your Clerk API Key
room_type Required Your Clerk Room Type ID
date_checkin Required Check-IN date (YYYY-MM-DD)
date_checkout Required Check-OUT date (YYYY-MM-DD)

Example

URL

https://api.clerk.im/bookings/room.json?api_key=xxx&&room_type=441&date_checkin=2011-01-01&date_checkout=2011-01-01

Response

{

    -
    rsp: {
        -
        status: {
            msg: "OK"
            code: 200
        }
        -
        bookings: [
            -
            {
                -
                booking_info: {
                    status: "Checked-out"
                    id: 3313
                    checkin: "2011-01-01"
                    checkout: "2011-01-02"
                }
                -
                client: {
                    passport: "DNI"
                    name: "Fabian"
                    country: "CL"
                    lastname: "Ramirez"
                }
                -
                rooms: [
                    -
                    {
                        -
                        room: {
                            name: "331"
                            -
                            room_type: {
                                name: "Room Type"
                                id: 441
                            }
                            date_checkout: "2011-01-01"
                            id: 86
                            date_checkin: "2011-01-02"
                        }
                    }
              ]                           
        ]
    }