Rooms

Shows a list of all rooms.

https://api.clerk.im/rooms.{format}

Format

jSON

https://api.clerk.im/rooms.json

XML

https://api.clerk.im/rooms.xml
Parameters
api_key Required Your Clerk API Key

Example

URL

https://api.clerk.im/rooms.json?api_key=xxx

Response

{

    -
    rsp: {
        -
        status: {
            msg: "OK"
            code: 200
        }
        -
        total: {
            actives: 2
            inactives: 1
        }
        -
        rooms: [
            -
            {
                -
                room: {
                    name: "Room 1"
                    updated_at: "2010-01-01T00:00:00Z"
                    id: 1
                    rooms_type_id: 1
                    active: true
                }
            }
            -
            {
                -
                room: {
                    name: "Room 2"
                    updated_at: "2010-01-01T00:00:00Z"
                    id: 2
                    rooms_type_id: 1
                    active: true
                }
            }
            -
            {
                -
                room: {
                    name: "Room 3"
                    updated_at: "2010-01-01T00:00:00Z"
                    id: 3
                    rooms_type_id: 1
                    active: false
                }
            }           
        ]
    }

}

Room

Shows an specific room.

https://api.clerk.im/rooms/{id}.{format}

Format

jSON

https://api.clerk.im/rooms/{id}.json

XML

https://api.clerk.im/rooms/{id}.xml
Parameters
api_key Required Your Clerk API Key

Example

URL

https://api.clerk.im/rooms/1.json?api_key=xxx

Response

{
    -
    status: {
        msg: "OK"
        code: 200
    }
    -
    rsp: {
        -
        room: {
            name: "Room 1"
            updated_at: "2010-12-13T15:00:53Z"
            id: 1
            -
            rooms_type: {
                name: "Room Type"
                updated_at: "2010-01-01T00:00:00Z"
                id: 1
                created_at: "2010-01-01T00:00:00Z"
            }
            rooms_type_id: 1
            active: true
        }
    }

}

Rooms Types

Shows a list of all rooms by room type.

https://api.clerk.im/rooms/room_type/{id}.{format}

Format

jSON

https://api.clerk.im/rooms/room_type/{id}.json

XML

https://api.clerk.im/rooms/room_type/{id}.xml
Parameters
api_key Required Your Clerk API Key

Example

URL

https://api.clerk.im/rooms/room_type/1.json?api_key=xxx

Response

{

    -
    rsp: {
        -
        status: {
            msg: "OK"
            code: 200
        }
        -
        total: {
            actives: 1
            inactives: 1
        }
        -
        rooms: [
            -
            {
                -
                room: {
                    name: "11"
                    updated_at: "2010-12-13T15:00:53Z"
                    id: 7
                    active: true
                }
            }
            -
            {
                -
                room: {
                    name: "Room 1"
                    updated_at: "2010-01-01T00:00:00Z"
                    id: 1
                    active: true
                }
            }
            -
            {
                -
                room: {
                    name: "Room 2"
                    updated_at: "2010-01-01T00:00:00Z"
                    id: 2
                    active: false
                }
            }           
        ]
    }

}

Habitaciones

Muestra un listado de todas las habitaciones en un hotel.

https://api.clerk.im/rooms.{formato}

Formato

jSON

https://api.clerk.im/rooms.json

XML

https://api.clerk.im/rooms.xml
Parametros
api_key Necesario Su API Key en Clerk

Ejemplo

URL

https://api.clerk.im/rooms.json?api_key=xxx

Respuesta

{

    -
    rsp: {
        -
        status: {
            msg: "OK"
            code: 200
        }
        -
        total: {
            actives: 2
            inactives: 1
        }
        -
        rooms: [
            -
            {
                -
                room: {
                    name: "Room 1"
                    updated_at: "2010-01-01T00:00:00Z"
                    id: 1
                    rooms_type_id: 1
                    active: true
                }
            }
            -
            {
                -
                room: {
                    name: "Room 2"
                    updated_at: "2010-01-01T00:00:00Z"
                    id: 2
                    rooms_type_id: 1
                    active: true
                }
            }
            -
            {
                -
                room: {
                    name: "Room 3"
                    updated_at: "2010-01-01T00:00:00Z"
                    id: 3
                    rooms_type_id: 1
                    active: false
                }
            }           
        ]
    }

}

Habitación

Muestra una habitación específica.

https://api.clerk.im/rooms/{id}.{format}

Formato

jSON

https://api.clerk.im/rooms/{id}.json

XML

https://api.clerk.im/rooms/{id}.xml
Parametros
api_key Necesario Su API Key en Clerk

Ejemplo

URL

https://api.clerk.im/rooms/1.json?api_key=xxx

Respuesta

{
    -
    status: {
        msg: "OK"
        code: 200
    }
    -
    rsp: {
        -
        room: {
            name: "Room 1"
            updated_at: "2010-12-13T15:00:53Z"
            id: 1
            -
            rooms_type: {
                name: "Room Type"
                updated_at: "2010-01-01T00:00:00Z"
                id: 1
                created_at: "2010-01-01T00:00:00Z"
            }
            rooms_type_id: 1
            active: true
        }
    }

}

Tipo de habitación

Muestra un listado de todas las habitaciones por tipo en un hotel.

https://api.clerk.im/rooms/room_type/{id}.{format}

Formato

jSON

https://api.clerk.im/rooms/room_type/{id}.json

XML

https://api.clerk.im/rooms/room_type/{id}.xml
Parametros
api_key Necesario Su API Key en Clerk

Ejemplo

URL

https://api.clerk.im/rooms/room_type/1.json?api_key=xxx

Respuesta

{

    -
    rsp: {
        -
        status: {
            msg: "OK"
            code: 200
        }
        -
        total: {
            actives: 1
            inactives: 1
        }
        -
        rooms: [
            -
            {
                -
                room: {
                    name: "11"
                    updated_at: "2010-12-13T15:00:53Z"
                    id: 7
                    active: true
                }
            }
            -
            {
                -
                room: {
                    name: "Room 1"
                    updated_at: "2010-01-01T00:00:00Z"
                    id: 1
                    active: true
                }
            }
            -
            {
                -
                room: {
                    name: "Room 2"
                    updated_at: "2010-01-01T00:00:00Z"
                    id: 2
                    active: false
                }
            }           
        ]
    }

}