Availability and rates APIs
Booking APIs
Property mgmt APIs
Developer Tools
Compliance
ReferenceCompliance

district query

Retrieves regulatory requirements for the specified property as defined by its jurisdiction. The query can return all regulatory information in our system for the jurisdiction, such as allowed property types, registration numbers, and minimum and maximum length-of-stay requirements.

Reading regulatory requirements in the query response

For the following request:

1query {
2  property(id: "96465844", idSource: EXPEDIA) {
3    geoLocation {
4      latitude
5      longitude
6    }
7    district(locale: "en_US") {
8      id
9      description
10      nativeLocale
11      localizedName
12      referenceUrls
13      registrationRequired
14      legalPropertyTypes {
15        type
16        subtype
17      }
18      requirements {
19        regulatoryCategory
20        regulatoryCategoryLabel
21        qualifiedPropertyTypes {
22          type
23          subtype
24        }
25        registrationNumberRequirements {
26          numberType
27          numberTypeLabel
28          localName
29          format
30          regex
31          isOptional
32          isExpirationDateRequired
33          allowPendingRegistrations
34          url
35          thirdPartyValidation {
36            required
37            attributes
38          }
39        }
40        additionalDataRequirements {
41          key
42          keyLocalized
43          type
44          typeLocalized
45          subtype
46          subtypeLocalized
47          group
48          groupLocalized
49          isOptional
50        }
51        minStayNights
52        maxNightCap {
53          annualLimit
54          isEnforced
55        }
56        exemptions {
57          category
58          description
59        }
60        isVacationRental
61      }
62    }
63  }
64}

Here is an explanation of the response:

  • Registration is required ("registrationRequired": true) for residences and hotels (legalPropertyTypes object).
  • 16 registration requirements are listed for both types of properties (under each registrationNumberRequirements array).
  • To understand how to interpret the information for each requirement, consider these examples:
    • For registration number ("numberType": "REGISTRATION_NUMBER”):
    • This is also referred to as VAT or tax ID ("localName": "VAT or Tax ID”), and it is mandatory ("isOptional": false).
    • Three examples are given for the registration number format ("format": "123456789, HR1234567890123, 123456789ABCDEFGHI") and the regular expression that describes this format is provided ("regex": "^[a-zA-Z0-9]{8,18}$").
    • No expiration date is required ("isExpirationDateRequired": false).
    • Pending registrations are not allowed ("allowPendingRegistrations": false).
  • For entity type ("numberType": "ENTITY_TYPE”):
    • This is optional ("isOptional": true).
    • In Expedia Partner Central (EPC), this is set by the "Are you a business or an individual?" question, and the acceptable values include "Individual" and "Business".
    • No expiration date is required ("isExpirationDateRequired": false).
    • Pending registrations are not allowed ("allowPendingRegistrations": false).
  • For property address ("numberType": "LEGAL_ADDRESS”):
    • This is not required as part of its regulatory information ("isOptional": true).
    • In EPC, the address is set by the "What is your legal business address or legal registered address?" question.
    • The submitted values are validated by this regular expression: ^.{1,240}$.
    • No expiration date is required ("isExpirationDateRequired": false).
    • Pending registrations are not allowed ("allowPendingRegistrations": false).

Syntax

1query { 
2  property(id: String!, idSource: IdSource) { 
3    district(locale: String): District 
4  } 
5}

Examples

Retrieving compliance and property status information

If you have implemented the property status capability, you can retrieve property status and compliance information using one query. The following query retrieves this information:

  • Expedia distributed URL
  • Whether the property is live on Expedia (BEXPropertyIsEnabledPredicate checkpoint has "fulfilled": true)
  • Whether the property is compliant with local regulations: (registration : detail : compliant : status)
  • If not compliant, a link to local regulatory laws (district : referenceUrls)
1query {
2  property(id: "34479786", idSource: EXPEDIA) {
3    name
4    coordinates {
5      latitude
6      longitude
7    }
8    district(locale: "fr_FR") {
9      id
10      referenceUrls
11    }
12    listings(domains: ["expedia.com"]) {
13      url
14    }
15    activeStatus {
16      active
17      statusCheckpoint {
18        name
19        lastEvaluated
20        resolutionStatus
21        checkpoints {
22          name
23          path
24          lastEvaluated
25          resolutionStatus
26          fulfilled
27        }
28      }
29    }
30  }
31}

Interactive example

The GraphQL explorer is provided for the example below. For more examples, refer to the Introduction.

Use this interactive explorer to get comfortable with the sample query.

  • A test property ID is passed into the explorer for use by the query; its test data is returned.
  • Click Run Query to execute the query in the explorer on the page. You can modify the query to retrieve the desired fields, and the explorer provides a list of fields when you start typing.
  • Click API Explorer to launch the full explorer in another tab/window, which provides syntax highlighting, schema introspection, real-time error highlighting, and auto-completion, among other things.

District

API Explorer Alt content

Response

Arguments
NameDescription
id
Required.
Expedia ID (EID) or supplier ID (external ID in the partner's system) of the property..
Type: String
idSource
Source system of the ID. EXPEDIA is the default value.
Type: IdSource
Types

Name
Type
AdditionalDataRequirement
Object
Additional parameters to meet onboarding requirements.
FieldDescription
group
Grouping to which the field belongs, for UI layout purposes.
Type: String
groupLocalized
Description of the group, to be localized.
Type: String
isOptional
Whether the data is optional.
Type: String
keyNot nullable.
Field name for the information to be captured.
Type: String
keyLocalized
Description of the key, to be localized.
Type: String
subtype
Subtype of data.
Type: String
subtypeLocalized
Description of the subtype, to be localized.
Type: String
type
Type of data.
Type: String
typeLocalized
Description of the type, to be localized.
Type: String
Boolean
Boolean
The Boolean scalar type represents true or false.
District
Object
District regulatory information.
FieldDescription
description
Description of the district regulation.
Type: String
idNot nullable.
District ID (such as Miami Beach).
Type: String
legalPropertyTypesNot nullable.
List of legal property types.
Type: Array of LegalPropertyType
localizedName
Localized district name that can be used for display.
Type: String
nativeLocale
Four-character locale code (language and country codes) of property's local
district (such as fr_FR for a property in France).
Type: String
referenceUrls
URL to jurisdiction regulation information.
Type: Array of String
registrationRequiredNot nullable.
Whether registration is required by the jurisdiction. This is based on the geo
code of the property’s address, not the property type (for example,
registration may be required for a hotel but not a vacation rental in a
specific area).
Type: Boolean
requirements
Jurisdiction regulations that the partner needs to meet to comply with onboarding to Expedia.
Type: Array of JurisdictionRequirement
Exemption
Object
Exemption to jurisdiction requirements.
FieldDescription
category
Exemption type.
Type: ExemptionCategory
description
Description of the exemption.
Type: String
ExemptionCategory
Enum
Exemption types.
NameDescription
MAX_NIGHT_CAP
IdSource
Enum
Source of a given ID.
NameDescription
EXPEDIA
Expedia is the source of the ID.
SUPPLIER
Connectivity provider or lodging partner is the source of the ID. This value is not supported for use in promotions.
VRBO
Unsupported.
Int
Int
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
JurisdictionRequirement
Object
Jurisdiction regulations that the partner needs to meet to comply with onboarding to Expedia.
FieldDescription
additionalDataRequirements
Additional required regulation data by jurisdiction, such as license holder name or property address.
Type: Array of AdditionalDataRequirement
exemptions
Exemptions of a requirement under certain conditions.
Type: Array of Exemption
isVacationRental
Whether this regulatory category is a vacation rental.
Type: Boolean
maxNightCap
Maximum number of nights allowed by the jurisdiction. null means no requirement.
Type: MaxNightCap
minStayNightsNot nullable.
Minimum number of stay nights for this category (default is 1).
Type: Int
qualifiedPropertyTypes
Regulation requirement that Expedia and Vrbo support.
Type: Array of LegalPropertyType
registrationNumberRequirements
List of registration number requirements.
Type: Array of non nullable RegistrationNumberRequirement
regulatoryCategory
Property regulatory category where the registration number requirements apply.
Type: RegulatoryCategory
regulatoryCategoryLabel
Localized string of the regulatory category.
Type: String
LegalPropertyType
Object
Property type for the district. This type provides what’s possible for the
district. Then, qualifiedPropertyTypes indicates the type and subtype at the
unit level. If subtype is set for the property, you should use both type and subtype. 
FieldDescription
subtype
Legal property subtype, applicable for residences, such as primary home or
secondary home. (This field provides the value that is specified in the
registration:details:regulatorySubType field of the updateUnitRegistration mutation.) 
Type: String
type
Legal property type, such as hotel, bed and breakfast, residence, etc. (This
field provides the value that is specified in the
registration:details:regulatoryType field of the updateUnitRegistration mutation.) 
Type: String
MaxNightCap
Object
Maximum night cap parameters for the jurisdiction.
FieldDescription
annualLimit
Annual night cap.
Type: Int
isEnforced
Whether the cap is enforced (or just informational).
Type: Boolean
Property
Object
Representation of a physical property, including its units, reservations, and promotions.
FieldDescription
district
Regulatory requirements and parameters that apply to the property. You can
specify the locale argument to retrieve the results in a specific language;
specify the four-letter ISO code for language. Use a four-character code that
indicates language and region, such as fr_FR for French in France. 
Type: District
Purpose
Enum
Purpose of the requirement.
NameDescription
DATA_SHARING
RegistrationNumberRequirement
Object
Registration requirement.
FieldDescription
allowPendingRegistrationsNot nullable.
Whether properties with pending registration applications are allowed to list.
Type: Boolean
format
Example(s) of the registration requirement's value.
Type: String
isExpirationDateRequiredNot nullable.
Whether an expiration date must be set for the registration requirement.
Type: Boolean
isOptionalNot nullable.
Whether the jurisdiction requires registration information. Be aware that if a
jurisdiction requires a property owner to apply for a permit but there is no
requirement for us to collect or display the permit, this field will be set to
true (indicating that registration information is optional).
Type: Boolean
localName
Localized display name of the registration requirement as shown in the Vrbo
dashboard or Expedia Partner Central (such as みんぱく for Japan Minpaku).
Type: String
numberType
Registration requirement type. (This field provides the value that must be
specified in the
registration:details:registrationRecords:registrationNumberType field of the
updateUnitRegistration mutation.)
Type: RegistrationNumberType
numberTypeLabel
Label used to describe the registration requirement in the Vrbo dashboard and Expedia Partner Central.
Type: String
purpose
Purpose of this requirement, if other than common regulatory validations.
Type: Purpose
regex
Regular expression used to validate the syntax of the registration requirement's value.
Type: String
thirdPartyValidation
Information about external validation parameters, if required for the registration requirement.
Type: ThirdPartyValidation
url
URL of a page that provides information about the registration requirement.
Type: String
RegistrationNumberType
Enum
Types of registration numbers (licenses).
NameDescription
LICENSE_NUMBER
LICENSE_ID
PARTIAL_TAX_ID
REGISTRATION_NUMBER
BUSINESS_LICENSE_NUMBER
OPERATOR_LICENCE_ID
OPERATOR_LICENSE_ID
BUSINESS_TAX_ID
RESORT_TAX_ID
SHORT_TERM_RENTAL_LICENSE
PERMIT_NUMBER
PLANNING_NUMBER
HOTEL_LICENSE
IS_IN_ZONING_PLAN
IS_PROFESSIONAL_HOST
TOURIST_DEVELOPMENT_TAX_ACCOUNT_NUMBER
HOME_SHARING_NUMBER
HOME_SHARING_PERMIT_NUMBER
CERTIFICATE_OF_USE_NUMBER
GENERAL_EXCISE_TAX_ID
TRANSIENT_ACCOMMODATIONS_TAX_ID
REGISTRATION_CERTIFICATE_NUMBER
PROPERTY_REGISTRY_NUMBER
SPECIAL_OPERATION_SIGN
TRANSIENT_REGISTRATION_NUMBER
PROVINCIAL_TOURIST_IDENTIFICATION_CODE
PARCEL_NUMBER_TAX_MAP_KEY
BUSINESS_TAX_RECEIPT_NUMBER
OPERATOR_LICENSE_NUMBER
OPERATOR_PERMIT
OWNER_PERMIT
TAX_IDENTIFICATION_NUMBER
MA_REGISTRATION_CERTIFICATE_NUMBER
BOSTON_REGISTRATION_NUMBER
OWNER_NAME
CADASTRAL_REFERENCE
OWNER_IS_CITIZEN
OWNER_ID
ZIPCODE
HOUSE_NUMBER
IS_CONDITION
ENTITY_TYPE
IS_TRADED
IS_GOVERNMENT_ENTITY
IS_ADDRESS_IN_EU
IS_RESIDENCE_IN_EU
LEGAL_ADDRESS
ISSUED_TAX_ID
PERMANENT_ESTABLISHMENT_COUNTRY
BUSINESS_REGISTRATION_NUMBER
LAND_REGISTRATION_NUMBER
BIRTH_DATE
IS_VAT_REGISTERED
VAT_ID
DATE
CITIZEN_ID
FOREIGN_ID
NEIGHBORHOOD_NAME
NATIONAL_ADDRESS_NUMBER
FLOOR_SYSTEM_NUMBER
JOURNAL_NUMBER
IS_ZONING_LAW_APPLIED
APPLICATION_NUMBER
ISSUANCE_DATE
RegulatoryCategory
Enum
Category values for regulatory categories. Most of jurisdiction districts only
allow for two categories, HOTEL and VACATION_RENTAL, though more values
GRAPHQL_VALIDATION_FAILED are provided to satisfy local government requirements.
NameDescription
HOTEL
BED_AND_BREAKFAST
HOTEL_OR_BNB
PRIMARY_HOME
PRIMARY_HOME_WITH_EXCEPTION
SECONDARY_HOME
VACATION_RENTAL
LONG_TERM_ONLY
SHORT_TERM_RENTAL
MINPAKU
SIMPLE_LODGING
EVENT
SPECIAL
NO_LICENSE
HOTEL_RYOKAN
RYOKAN
PRIMARY_OR_SECONDARY
TRANSIENT_OCCUPANCY_RESIDENTIAL_STRUCTURE
MOTEL
HOME_SHARING_NUMBER
VACATION_RENTAL_OTHER
HOSTEL
CAMPING_SITES
RURAL_LODGING
APARTMENT_HOTEL
String
String
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
ThirdPartyValidation
Object
Third-party validation information.
FieldDescription
attributes
Attributes used to validate the registration number as provided by the third-party.
Type: Array of String
requiredNot nullable.
Whether third-party validation is required.
Type: Boolean