Skip to content

Show

GET
/api/managing-entity/{managingEntityIdentifier}/extranet/property/policy/property
curl --request GET \
--url https://api.wink.travel/api/managing-entity/e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18/extranet/property/policy/property \
--header 'Authorization: Bearer <token>' \
--header 'Wink-Version: 2.0'

Returns the stored policy (e.g. children and pet rules) for the given managing entity, or a default policy when none has been set.

managingEntityIdentifier
required
string
""

Retrieve property policy for this property identifier

Example
e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Property policy including guest, pet, and internet rules

Media type application/json

Outlines basic policies for the property.

object
childrenAllowed
required

Indicates whether property allows children

boolean
childrenMinimumAge

When a property allows children, it can also indicate what the minimum age is for children to be allowed.

integer format: int32
""
internetAvailability
required

Indicates the availability of internet on the property.

string
""
Allowed values: YES NO YES_PAID
internetConnectionType

Indicates how guests can access the Internet on the property.

string
""
Allowed values: WIFI CABLE
internetConnectionLocation

Indicates where internet is available in and around the property.

string
""
Allowed values: ENTIRE_PROPERTY PUBLIC_AREAS ALL_ROOMS SOME_ROOMS BUSINESS_CENTER
parkingAvailability
required

Indicates whether parking is available at the property.

string
""
Allowed values: YES NO YES_PAID
parkingAccess

Indicates what type of parking is available at the property.

string
""
Allowed values: PRIVATE PUBLIC
petsAllowed
required

Indicates whether pets are allowed on the property. Note: There are thousand different kinds of pets. Just because the property allows small dogs does not mean the guest can bring a python. Always best to check with property.

boolean
petMaxWeightInKilos

If pets are allowed, property can further limit on weight.

integer format: int32
""
petCharge

If pets are allowed, property can tell travelers if there is a charge applicable for the pet.

object
amount
required

Monetary amount value

number
""
currency
required

ISO 4217 currency code

string
"" >= 1 characters /^[A-Z]{3}$/
checkOutTime
required

When the guest has to check out.

string
"" >= 1 characters
checkInTime
required

When the guest can check in.

string
"" >= 1 characters
key
additional properties
""
Example
{
"childrenAllowed": true,
"childrenMinimumAge": 6,
"internetAvailability": "YES",
"internetConnectionType": "WIFI",
"internetConnectionLocation": "ENTIRE_PROPERTY",
"parkingAvailability": "YES",
"parkingAccess": "PRIVATE",
"petsAllowed": true,
"petMaxWeightInKilos": 10,
"petCharge": {
"amount": 500,
"currency": "THB"
},
"checkOutTime": "10:00",
"checkInTime": "14:00"
}

Bad Request — missing or invalid request parameter or body

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Unauthorized — authentication is required or the session has expired

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Forbidden — authenticated but lacking the required permission or scope

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Not Found — the requested resource does not exist

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Method Not Allowed — the HTTP verb is not supported on this endpoint

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Unsupported Media Type — use application/json

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Internal Server Error — an unexpected failure occurred on the server

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Service Unavailable — a downstream dependency is unreachable

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example