GET POLICIES



GET POLICIES

GetPolicies()

GetPolicies() provides the policies a business has set in Availability Exchange. If the business has not set any policies, this endpoint will return a response with an empty value for policies. The business must have connected to you for you to retrieve policies.

Request

Endpoint   

https://www.availabilityexchange.com/gateway/getpolicies
Parameters
   
business_id (64-bit integer) - the identifier of the business to retrieve policies for

Request Example

>curl --user username:accesskey "https://www.availabilityexchange.com/gateway/getpolicies?business_id=16609"

Response

response_errors (See Response Errors)
policies (object)

    ArrivalTimes (string)

        the business's arrival time policies, if set

    AdditionalPolicies (string)

        the business's additional policies, if set

    ChildrenAndPetPolicies (string)

        the business's children and pet policies, if set

    CreditCardSecurity (string)

        the business's credit card security policies, if set

    GeneralPolicies (string)

        the business's general policies, if set

    InitialDepositPolicies (string)

        the business's initial deposit policies, if set

    ScheduledDepositPolicies (string)

        the business's scheduled deposit policies, if set
   

Response Example

{

  "policies": {

  "GeneralPolicies": "Booking a Room:\r\n\r\nAnyone reserving a room must be at least 21 years of age and have a current

form of photo ID available upon check-in. Guests who are under 21 years of age must be accompanied by a parent or legal ...",

  "AdditionalPolicies": "Special Cancellation Policy for Packer Games /Covid-19 Policy - Due to the high demand for

lodging in Green Bay on or around Packer games, all rooms reserved within 2 days of a Packer game are

non-refundable.\n\n** If games are cancelled due to Covid-19, guests will receive a refund of their deposit or

reservation payment. ",

  "ArrivalTimes": "CAMP START 4:00 PM - 5:00 PM If arriving outside of check-in times, please call to make arrangements.",

  "InitialDepositPolicies": "AUTO-COLLECT At the time of booking, 50% of the reservation balance will be collected.

Payment for all retail items and gift certificates will also be collected. Applies to: all reservations.",

  "ScheduledDepositPolicies": "SCHEDULED DEPOSIT 7 days before arrival, 20% of the reservation balance will be collected.

If a reservation is booked \"last-minute\" (within the scheduled time frame), the initial deposit will be collected in

addition to the scheduled amount. Applies to: all reservations.",

  "ChildrenAndPetPolicies": "CHILDREN & PETS Children are welcome with an accompanying adult. Pets are welcome. Pets must

weigh under 150 pounds. nope",

  "CreditCardSecurity": "Credit Card Security Your credit card information is stored and processed securely."

  },

  "response_errors": []

}


Response Errors

400

    business_id is required

401
    The credentials supplied are incorrect or you do not have access to this resource
500
   
Something went wrong (Internal Server Error)
503
    Server in maintenance mode

Response Error Example

>curl --user aBadUserName:SomePasskey "https://www.availabilityexchange/gateway/getpolicies"

Authorization Failed

Return to API Endpoints

Share by: