API Reference

Get Property Status

4.3. Get Property Status

POST /cm/property-status

Description

Fetch property overall status either by list of property ids or with pagination. Please check the example of requests in the Example HTTP request section below.

Body parameter

HotelStatusRQ

Name : body
Flags : required
Type : AG_HotelStatusRQ

Responses

HTTP Code Description Schema

200

The successful response containing overall status of properties.

AG_HotelStatusRS

400

The request content was malformed

AG_HotelStatusRS

401

The supplier was unauthorized

AG_HotelStatusRS

Consumes

  • application/xml

Produces

  • application/xml

Tags

  • PropertyOverallStatus

Security

Type Name

apiKey

apiKey

Example HTTP request

Request path
/cm/property-status
Request to get overall property status by property lists
<AG_HotelStatusRQ>
    <Criterion>
        <HotelRefs>
            <HotelRef HotelCode="12345"/>
            <HotelRef HotelCode="98765"/>
        </HotelRefs>
    </Criterion>
</AG_HotelStatusRQ>
Request to get overall property status with pagination
<AG_HotelStatusRQ>
    <Criterion Page="1" PageSize="100"/>
</AG_HotelStatusRQ>

Example HTTP response

Response 200
<AG_HotelStatusRS CorrelationID="325d8000-48cf-11ea-9337-8950898f7d75">
    <Properties>
        <Property
                Code="12345"
                Name="The Best Hotel"
                CurrencyCode="EUR">
            <PropertyStatus
                    Created="2023-11-19 07:13:06"
                    LastChange="2024-02-01 16:41:53"
                    StatusType="Active">
                <ReprocessRequired>No</ReprocessRequired>
                <ContractSigned>Yes</ContractSigned>
                <PhotosIngested>Yes</PhotosIngested>
                <FraudCheckPassed>Yes</FraudCheckPassed>
                <PropertyLived>Yes</PropertyLived>
                <PropertyReady>Yes</PropertyReady>
                <RoomsAvailable>Yes</RoomsAvailable>
                <RatePlansAvailable>Yes</RatePlansAvailable>
            </PropertyStatus>
        </Property>
    </Properties>
</AG_HotelStatusRS>
Response 400
<AG_HotelStatusRS CorrelationID="325d8000-48cf-11ea-9337-8950898f7d75">
    <Errors>
        <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
    </Errors>
</AG_HotelStatusRS>
Response 401
<AG_HotelStatusRS CorrelationID="325d8000-48cf-11ea-9337-8950898f7d75">
    <Errors>
        <Error Code="321" ShortText="Authorization error" Status="NotProcessed"/>
    </Errors>
</AG_HotelStatusRS>