{"swagger":"2.0","info":{"version":"10","title":"homeaway-hsapi-swagger-definition"},"host":"hsapi.escapia.com","basePath":"/dragomanadapter","schemes":["https"],"paths":{"/hsapi/ListAddOns":{"get":{"tags":["AddOns"],"summary":"Gets all the {HomeAway.DragomanAPI.Contract.Models.AddOn}s currently available for a single Property Management Company","operationId":"ListAddOns","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/AddOn"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetAddOnById":{"get":{"tags":["AddOns"],"summary":"Gets a single {HomeAway.DragomanAPI.Contract.Models.AddOn} by its unique ID","operationId":"GetAddOnById","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"id","in":"query","description":"native ID of the AddOn to fetch","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AddOn"}},"404":{"description":"AddOn not found."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/SearchAddOns":{"post":{"tags":["AddOns"],"summary":"Gets available {HomeAway.DragomanAPI.Contract.Models.AddOn}s based on details within the search specification.\r\nThis can be used to see what AddOns are available for a new quote\r\nthe traveler is constructing.","operationId":"SearchAddOns","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"addOnSearchSpecification","in":"body","description":"A paged {HomeAway.DragomanAPI.Contract.Models.CustomizationSearchSpecification}, including book and stay dates and unit","required":true,"schema":{"$ref":"#/definitions/PagedSearchSpecification_AddOnSearchSpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PagedSearchResults_AddOn"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetCompanyInfo":{"get":{"tags":["Configuration"],"summary":"Returns the company information for a given PMCID","operationId":"GetCompanyInfo","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CompanyInfo"}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/ListEventTypes":{"get":{"tags":["Events"],"summary":"Lists the available external event types for Reservations within a specific Property Management Company, \r\nwhich is specified in the x-homeaway-hasp-api-endsystem and x-homeaway-hasp-api-pmcid headers.","operationId":"ListEventTypes","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"enum":["Email","ESignature","Print"],"type":"string"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/ListEventsByReservationId":{"post":{"tags":["Events"],"summary":"Lists the External Event history for a Reservation within a Property Management Company based on a PagedSearchSpecification object \r\ncontaining only a string that is the NativePMSID of the desired Reservation. Any matching ReservationEvent entries are returned in a paged format \r\nbased on the incoming paging information on the search specification.","operationId":"ListEventsByReservationId","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"id","in":"query","description":"","required":true,"type":"string"},{"name":"searchSpecification","in":"body","description":"An object specifying the criteria with which to search Extras.","required":true,"schema":{"$ref":"#/definitions/PagedSearchSpecification_String"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PagedSearchResults_ReservationEvent"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/ListEventsByReservationNumber":{"post":{"tags":["Events"],"summary":"Lists the External Event history for a Reservation within a Property Management Company based on a PagedSearchSpecification object containing \r\nonly a string that is the friendly ReservationNumber of the desired Reservation. Any matching ReservationEvent entries are returned in a paged format \r\nbased on the incoming paging information on the search specification.","operationId":"ListEventsByReservationNumber","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"reservationNumber","in":"query","description":"","required":true,"type":"string"},{"name":"searchSpecification","in":"body","description":"An object specifying the criteria with which to search Extras.","required":true,"schema":{"$ref":"#/definitions/PagedSearchSpecification_String"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PagedSearchResults_ReservationEvent"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/AddReservationEventByReservationId":{"post":{"tags":["Events"],"summary":"Adds the specified ReservationEvent to a Reservation within a Property Management Company.","operationId":"AddReservationEventByReservationId","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"id","in":"query","description":"The native endsystem reservation identifier of the reservation.","required":true,"type":"string"},{"name":"reservationEvent","in":"body","description":"The reservation event to add to the specified reservation.","required":true,"schema":{"$ref":"#/definitions/ReservationEvent"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ReservationEvent"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/AddReservationEventByReservationNumber":{"post":{"tags":["Events"],"summary":"Adds the specified ReservationEvent to a Reservation within a Property Management Company.","operationId":"AddReservationEventByReservationNumber","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"reservationNumber","in":"query","description":"The friendly reservation number provided to the Guest.","required":true,"type":"string"},{"name":"reservationEvent","in":"body","description":"The reservation event to add to the specified reservation.","required":true,"schema":{"$ref":"#/definitions/ReservationEvent"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ReservationEvent"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/ListExtras":{"get":{"tags":["Extras"],"summary":"Lists the definitions of all available Extra(s) for a specific Property Management Company, which is specified in the x-homeaway-hasp-api-endsystem \r\nand x-homeaway-hasp-api-pmcid headers.","operationId":"ListExtras","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Extra"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/ListExtrasByUnit":{"get":{"tags":["Extras"],"summary":"Lists available Extra(s) for a single unit, specified by unitNativePMSID. This will return the definitions \r\nof the available Extras, not a booked instances of them.","operationId":"ListExtrasByUnit","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"unitId","in":"query","description":"ID for the property, in the end system","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Extra"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetExtraById":{"get":{"tags":["Extras"],"summary":"Get the details for a single Extra, specified by extraNativePMSID. This will return the definition of the specified Extra, not a booked instance of that Extra.","operationId":"GetExtraById","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"id","in":"query","description":"The native endsystem identifier of the extra.","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Extra"}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/SearchExtras":{"post":{"tags":["Extras"],"summary":"Search for Extra(s) within a Property Management Company based on an ExtraSearchSpecification object allowing faceting by optional stay date ranges, \r\nreservation types, unit NativePMSIDs, and a search term. Any matching Extras are returned in a paged format based on the incoming paging information on the search specification.","operationId":"SearchExtras","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"extraSearchSpecification","in":"body","description":"An object specifying the criteria with which to search Extra(s).","required":true,"schema":{"$ref":"#/definitions/PagedSearchSpecification_CustomizationSearchSpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PagedSearchResults_Extra"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/ListUnitFeatureGroups":{"get":{"tags":["FeatureGroups"],"summary":"Lists all defined unit feature groups for a specific Property Management Company, which is specified in the x-homeaway-hasp-api-endsystem and x-homeaway-hasp-api-pmcid headers.","operationId":"ListUnitFeatureGroups","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/FeatureGroup"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/SearchGuests":{"post":{"tags":["Guests"],"summary":"Searches for Guest(s) in the Property Management Company based on the search string provided. The search string will be matched against various Guest data fields.","operationId":"SearchGuests","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"searchString","in":"query","description":"A search term used to find Guest(s). Searches span name, phone number, email address.","required":true,"type":"string"},{"name":"maxResults","in":"query","description":"The maximum number of matching Guest(s) to return.","required":true,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Guest"}}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/ListEmailContactTypes":{"get":{"tags":["Guests"],"summary":"Lists email types for a specific Property Management Company, which is specified in the x-homeaway-hasp-api-endsystem and x-homeaway-hasp-api-pmcid headers.","operationId":"ListEmailContactTypes","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/EmailContactType"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/ListAddressContactTypes":{"get":{"tags":["Guests"],"summary":"Lists address types for a specific Property Management Company, which is specified in the x-homeaway-hasp-api-endsystem and x-homeaway-hasp-api-pmcid headers.","operationId":"ListAddressContactTypes","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/AddressContactType"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/ListPhoneContactTypes":{"get":{"tags":["Guests"],"summary":"Fetches the queryable of {HomeAway.DragomanAPI.Contract.Models.PhoneContactType}s for the current context.","operationId":"ListPhoneContactTypes","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PhoneContactType"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetGuestById":{"get":{"tags":["Guests"],"summary":"Gets a Guest in the Property Management Company based on the Guest NativePMSID provided.","operationId":"GetGuestById","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"id","in":"query","description":"The NativePMSID of a Guest to retrieve details for.","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Guest"}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/CreateGuest":{"put":{"tags":["Guests"],"summary":"","operationId":"CreateGuest","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"guest","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/Guest"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Guest"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/CreateHousekeepingTask":{"post":{"tags":["Housekeeping"],"summary":"Creates new housekeeping task","operationId":"CreateHousekeepingTask","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"housekeepingTask","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/HousekeepingTask"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/HousekeepingTask"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/DeleteHousekeepingTask":{"delete":{"tags":["Housekeeping"],"summary":"Allows to delete housekeeping task","operationId":"DeleteHousekeepingTask","consumes":[],"produces":[],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"taskId","in":"query","description":"","required":true,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetHousekeepingAssigneeList":{"get":{"tags":["Housekeeping"],"summary":"List of housekeeping activity assignees","operationId":"GetHousekeepingAssigneeList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MaintenanceAssignee"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetHousekeepingStatusList":{"get":{"tags":["Housekeeping"],"summary":"List of housekeeping activity statuses that can be used to set the status of an activity","operationId":"GetHousekeepingStatusList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/HousekeepingStatus"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetUnitHousekeepingStatuses":{"get":{"tags":["Housekeeping"],"summary":"Get Unit clean status projections for the native unit ids passed in.","operationId":"GetUnitHousekeepingStatuses","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"PMCID","in":"query","description":"","required":true,"type":"string"},{"name":"nativeUnitIds","in":"query","description":"","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BatchGetResponse_UnitHousekeepingStatus,String"}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/SaveUnitHousekeepingStatus":{"put":{"tags":["Housekeeping"],"summary":"Saves the unit housekeeping status","operationId":"SaveUnitHousekeepingStatus","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"housekeepingStatus","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/UnitHousekeepingStatusType"}},{"name":"nativeUnitId","in":"query","description":"","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/SearchHousekeepingTasks":{"post":{"tags":["Housekeeping"],"summary":"Gets a page of housekeeping tasks for specific search specification","operationId":"SearchHousekeepingTasks","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"housekeepingTaskSearchSpecification","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/PagedSearchSpecification_HousekeepingTaskSearchSpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PagedSearchResults_HousekeepingTaskCustom"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/UpdateHousekeepingTask":{"put":{"tags":["Housekeeping"],"summary":"Allows to update housekeeping task","operationId":"UpdateHousekeepingTask","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"housekeepingTask","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/HousekeepingTask"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/ListMarketingCategories":{"get":{"tags":["Marketing"],"summary":"Lists marketing categories for a specific PM, which is specified in the x-homeaway-hasp-api-endsystem and x-homeaway-hasp-api-pmcid headers.\r\nRefer MarketingCategory for more details","operationId":"ListMarketingCategories","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MarketingCategory"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetUnitNonAvailability":{"post":{"tags":["NonAvailability"],"summary":"Gets all the non-availability information for a single Unit within a Property Management Company.","operationId":"GetUnitNonAvailability","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"nonAvailabilitySpecification","in":"body","description":"An object specifying the criteria with which to search Availability.","required":true,"schema":{"$ref":"#/definitions/NonAvailabilitySpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/NonAvailability"}}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/SearchOwners":{"post":{"tags":["Owners"],"summary":"Lists the owners that match the search criteria for a specific Property Management Company, which is specified in the x-homeaway-hasp-api-endsystem and x-homeaway-hasp-api-pmcid headers.\r\nA contains search is performed for each field and any matching results are returned.\r\nIf an empty search criteria is specified, then all owners are returned.\r\nThe returned owners are sorted alphabetically by last name then first name.","operationId":"SearchOwners","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"specification","in":"body","description":"A {HomeAway.DragomanAPI.Contract.PagedSearchSpecification`1} containing the search criteria","required":true,"schema":{"$ref":"#/definitions/PagedSearchSpecification_OwnerSearchSpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PagedSearchResults_Owner"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetOwnerById":{"get":{"tags":["Owners"],"summary":"Gets a single {HomeAway.DragomanAPI.Contract.Models.Owner}, specified by its native endsystem identifier.","operationId":"GetOwnerById","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"ownerNativePMSID","in":"query","description":"The native endsystem identifier of the {HomeAway.DragomanAPI.Contract.Models.Owner}.","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Owner"}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/ListPackages":{"get":{"tags":["Packages"],"summary":"Lists the definitions of available Packages for a specific Property Management Company, which is specified in the x-homeaway-hasp-api-endsystem \r\nand x-homeaway-hasp-api-pmcid headers.","operationId":"ListPackages","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Package"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/ListPackagesByUnit":{"get":{"tags":["Packages"],"summary":"Lists packages for a single unit, specified by unitNativePMSID. This will return definitions of the available Packages, not booked instances of them.","operationId":"ListPackagesByUnit","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"unitId","in":"query","description":"The native identifier of the Unit within the HomeAway EndSystem.","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Package"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetPackageById":{"get":{"tags":["Packages"],"summary":"Get the details for a single Package, specified by packageNativePMSID. This will return the definition of the Package, not a booked instance of it.","operationId":"GetPackageById","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"id","in":"query","description":"The native identifier of the Package within the HomeAway EndSystem.","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Package"}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/SearchPackages":{"post":{"tags":["Packages"],"summary":"Search for Packages within a Property Management Company based on a PackageSearchSpecification object allowing faceting by optional \r\nstay date ranges, reservation types, unit NativePMSIDs, and a search term. Any matching Packages are returned in a paged format based on \r\nthe incoming paging information on the search specification.","operationId":"SearchPackages","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"packageSearchSpecification","in":"body","description":"An object specifying the criteria with which to search Packages.","required":true,"schema":{"$ref":"#/definitions/PagedSearchSpecification_CustomizationSearchSpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PagedSearchResults_Package"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetGuestPaymentMethods":{"get":{"tags":["Payments"],"summary":"Lists payment methods for a given guest.","operationId":"GetGuestPaymentMethods","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"guestNativePMSID","in":"query","description":"The native PMSID of the guest whose payment methods should be viewed.","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PaymentMethod"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetPaymentMethod":{"get":{"tags":["Payments"],"summary":"Gets a payment method with the given identifier.","operationId":"GetPaymentMethod","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"id","in":"query","description":"","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PaymentMethod"}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/CreatePaymentMethod":{"post":{"tags":["Payments"],"summary":"Creates a new payment method for the given guest. eChecks for V12 are not supported.","operationId":"CreatePaymentMethod","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"paymentMethod","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/PaymentMethod"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PaymentMethod"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/UpdatePaymentMethod":{"put":{"tags":["Payments"],"summary":"Updates an existing payment method for the given guest.","operationId":"UpdatePaymentMethod","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":[],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"paymentMethod","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/PaymentMethod"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetReservationPayments":{"get":{"tags":["Payments"],"summary":"Retrieves the payment history for a given reservation.","operationId":"GetReservationPayments","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"reservationId","in":"query","description":"","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ReservationPayment"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/ListPricingPlans":{"get":{"tags":["PromoCodes"],"summary":"Lists the pricing plans available for a given reservation type within a PMC","operationId":"ListPricingPlans","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"reservationTypeId","in":"query","description":"Which reservation type the pricing plans will apply to","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PricingPlan"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/ListPromoCodes":{"get":{"tags":["PromoCodes"],"summary":"Gets all the {HomeAway.DragomanAPI.Contract.Models.PromoCode}s currently available for the property","operationId":"ListPromoCodes","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"id","in":"query","description":"reservationTypeNativePMSID","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PromoCode"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GenerateQuote":{"post":{"tags":["Quotes"],"summary":"Generates a Quote in the HomeAway EndSystem based on the information supplied in the QuoteSpecification.","operationId":"GenerateQuote","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"quoteSpecification","in":"body","description":"An object specifying the criteria with which to generate a Quote.","required":true,"schema":{"$ref":"#/definitions/QuoteSpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Quote"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GenerateMultiQuote":{"post":{"tags":["Quotes"],"summary":"Generates multiple quotes in the end system for different units for the same date ranges","operationId":"GenerateMultiQuote","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"multiQuoteSpecification","in":"body","description":"Specification for generating quotes. The difference between the normal QuoteSpecification is the 'UnitNativePMSIDs' property\r\n            that should be filled with a list of unit native pmsids to quote.","required":true,"schema":{"$ref":"#/definitions/MultiQuoteSpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Quote"}}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GenerateReservationPackagesQuote":{"post":{"tags":["Quotes"],"summary":"Generates a Quote in the end system based on the incoming reservation Id and the incoming customization specification.","operationId":"GenerateReservationPackagesQuote","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"specification","in":"body","description":"The {HomeAway.DragomanAPI.Contract.Models.CustomizeReservationSpecification} describing the desired state of \r\nthe {HomeAway.DragomanAPI.Contract.Models.Reservation}'s {HomeAway.DragomanAPI.Contract.Models.AddOn}s, {HomeAway.DragomanAPI.Contract.Models.Package}s, and {HomeAway.DragomanAPI.Contract.Models.Extra}s","required":true,"schema":{"$ref":"#/definitions/CustomizeReservationSpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Quote"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/RunReport":{"post":{"tags":["Reports"],"summary":"Method that allows running reports on the end system.","operationId":"RunReport","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"reportSpecification","in":"body","description":"Specifies the report to be run","required":true,"schema":{"$ref":"#/definitions/ReportSpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ReportOutput"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/CreateReservation":{"put":{"tags":["Reservations"],"summary":"Creates a Reservation in the HomeAway EndSystem based on the information supplied in the ReservationSpecification. This endpoint may \r\nreturn PreconditionFailed (412) in cases of booking rule errors requiring explicit acknowledgement.","operationId":"CreateReservation","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"reservationSpecification","in":"body","description":"An object specifying the criteria with which to create a Reservation. Refer ReservationSpecification for more details.","required":true,"schema":{"$ref":"#/definitions/ReservationSpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Reservation"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/CancelReservation":{"post":{"tags":["Reservations"],"summary":"Cancels a Reservation in the HomeAway EndSystem based on the information supplied in the ReservationCancellationSpecification. If successful, \r\nreturns the cancelled Reservation, else returns the Reservation containing a Diagnosis on failure.","operationId":"CancelReservation","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"id","in":"query","description":"","required":true,"type":"string"},{"name":"specification","in":"body","description":"An object specifying the criteria with which to cancel a Reservation. Refer ReservationCancellationSpecification for more details.","required":true,"schema":{"$ref":"#/definitions/ReservationCancellationSpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Reservation"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/UpdateReservation":{"put":{"tags":["Reservations"],"summary":"Updates a Reservation in the end system based on the information supplied in the ReservationChangeSpecification. Returns the updated Reservation \r\nif successful, else the unaltered Reservation containing a Diagnosis on failure.","operationId":"UpdateReservation","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"id","in":"query","description":"","required":true,"type":"string"},{"name":"specification","in":"body","description":"An object specifying the criteria with which to update a Reservation. Refer ReservationChangeSpecification for more details.","required":true,"schema":{"$ref":"#/definitions/ReservationChangeSpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Reservation"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/UpdateReservationMetadata":{"put":{"tags":["Reservations"],"summary":"Updates the reservation metadata for a given reservation","operationId":"UpdateReservationMetadata","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"reservationMetadataUpdateSpecification","in":"body","description":"Describes the updates to make","required":true,"schema":{"$ref":"#/definitions/ReservationMetadataUpdateSpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Reservation"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetReservationByNumber":{"get":{"tags":["Reservations"],"summary":"Get the details for a single Reservation, specified by the reservationNumber provided to the customer.","operationId":"GetReservationByNumber","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"reservationNumber","in":"query","description":"The friendly reservation number provided to the Guest.","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Reservation"}},"404":{"description":"Not Found. This can result from a non-existent reservationNumber."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetReservationById":{"get":{"tags":["Reservations"],"summary":"Get the details for a single Reservation, specified by the reservation's NativePMSID.","operationId":"GetReservationById","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"id","in":"query","description":"The native endsystem reservation identifier of the reservation.","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Reservation"}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/SearchReservationSummaries":{"post":{"tags":["Reservations"],"summary":"Fetches the requested page of ReservationSummary objects matching the criteria contained on incoming ReservationSearchSpecification. \r\nReservationSummary objects provide overview information for Reservations; use the getReservationBy* endpoints to retrieve details on a specific Reservation.","operationId":"SearchReservationSummaries","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"specification","in":"body","description":"A {HomeAway.DragomanAPI.Contract.PagedSearchSpecification`1} containing the search criteria. Refer ReservationSearchSpecification for more details.","required":true,"schema":{"$ref":"#/definitions/PagedSearchSpecification_ReservationSearchSpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PagedSearchResults_ReservationSummary"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/CustomizeReservation":{"put":{"tags":["Reservations"],"summary":"Customizes a Reservation in the HomeAway EndSystem by applying the indicated state of AddOns, Packages, and Extras supplied in the incoming \r\nspecification. Returns the updated Reservation with the customized items if successful, else the unaltered Reservation containing a Diagnosis on failure.","operationId":"CustomizeReservation","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"specification","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/CustomizeReservationSpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Reservation"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/ListReservationTypes":{"get":{"tags":["Reservations"],"summary":"Returns the list of available reservation types for the given PMC.","operationId":"ListReservationTypes","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ReservationType"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/UpdateReservationOccupancyStatus":{"post":{"tags":["Reservations"],"summary":"Updates the reservation occupancy, such as checking in","operationId":"UpdateReservationOccupancyStatus","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"reservationId","in":"query","description":"","required":true,"type":"string"},{"name":"occupancyStateChange","in":"query","description":"","required":true,"type":"string","enum":["CheckIn","CheckOut","UndoCheckIn","UndoCheckOut"]},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Diagnosis"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/AddReservationCharge":{"post":{"tags":["Reservations"],"summary":"Adds a reservation charge based on the ReservationChargeSpecification and returns a Diagnosis if it fails.\r\nFor V12, the PM will need to map the Category to an existing Cost Code in V12.  Available only to specially approved partner integrations, contact HomeAway Software Customer Support if you have more questions.","operationId":"AddReservationCharge","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"reservationChargeSpecification","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/ReservationChargeSpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Diagnosis"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetReservationChanges":{"get":{"tags":["Reservations"],"summary":"Gets the reservations that have changed since the given version.","description":"<para>When calling the method for the first time, a start version of 0 is suggested.  This will return changes since the end system has started tracking changes until the endVersion.</para>\r\n<para>Each method call returns both a change list and an endVersion, which represents the version of the last item included in the response. The change list will only include items with a version higher than the provided startVersion.</para>\r\n<para>For subsequent calls, use the endVersion from the previous response as the new startVersion to continue retrieving changes incrementally</para>\r\n<para>Note that the method does not guarantee returning all changes up to the current moment. It is the caller’s responsibility to make additional calls to ensure all changes are retrieved.</para>\r\n<para>Additionally, the method may collapse multiple changes to the same element into a single, most recent update. For example, if an element has undergone 50 modifications, only the latest change will be included in the results.</para>","operationId":"GetReservationChanges","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"startVersion","in":"query","description":"The starting version for the search.  \r\n            \t<para>The initial call to this method should use a start version of 0.</para><para>Subsequent calls to the method should use the returned endVersion.</para>","required":true,"type":"integer","format":"int64"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ChangeList"}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GenerateSeasonalRateSchedules":{"post":{"tags":["Units"],"summary":"Generates a seasonal rate schedule for units passed in, based on the values in the seasonalRateScheduleSpecification passed in. Method is not supported for EscapiaVRS","operationId":"GenerateSeasonalRateSchedules","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"seasonalRateScheduleSpecification","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/SeasonalRateScheduleSpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SeasonalRateScheduleBatch"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/SearchUnitSummaries":{"post":{"tags":["Units"],"summary":"Search for Unit(s) within a Property Management Company based on a UnitSearchSpecification object allowing faceting by \r\noptional stay date ranges, unit types, unit names or codes, and a variety of other optional search criteria. Any matching \r\nUnits are returned in a paged format based on the incoming paging information on the search specification.","operationId":"SearchUnitSummaries","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"specification","in":"body","description":"An object specifying the criteria with which to search Unit(s).","required":true,"schema":{"$ref":"#/definitions/PagedSearchSpecification_UnitSearchSpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PagedSearchResults_UnitSummary"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetUnitById":{"get":{"tags":["Units"],"summary":"Get the details for a single Unit, specified by unitNativePMSID. This will return all details for the Unit.","operationId":"GetUnitById","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"id","in":"query","description":"The native ID in the PMC/EndSystem providing context.","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Unit"}},"404":{"description":"Not Found. This can result from a non-existent unit id."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetUnitsById":{"post":{"tags":["Units"],"summary":"Get the details for a set of Units, specified by their unitNativePMSIDs. This will return all details for the Units.","operationId":"GetUnitsById","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"ids","in":"body","description":"","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Unit"}}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/ListUnitTypes":{"get":{"tags":["Units"],"summary":"Lists unit types for a specific Property Management Company, which is specified in the x-homeaway-hasp-api-endsystem and x-homeaway-hasp-api-pmcid headers.","operationId":"ListUnitTypes","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/UnitType"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/ListUnitLocations":{"get":{"tags":["Units"],"summary":"Lists all defined unit locations for a specific Property Management Company, which is specified in the x-homeaway-hasp-api-endsystem and x-homeaway-hasp-api-pmcid headers.","operationId":"ListUnitLocations","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Location"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/UpdateUnitMetadata":{"put":{"tags":["Units"],"summary":"Updates details about an unit.","operationId":"UpdateUnitMetadata","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"unitMetadataUpdateSpecification","in":"body","description":"An object specifying properties that need to be changed. If a property doesn't need to be updated it can be omitted from the request.","required":true,"schema":{"$ref":"#/definitions/UnitMetadataUpdateSpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Unit"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/auth/token":{"get":{"tags":["Utility"],"summary":"This operation provides partners a way to create oauth bearer tokens using their credentials so they can use\r\nthem to authenticate when executing hsapi operations","operationId":"GenerateToken","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"Authorization","in":"header","description":"Basic Authorization header. The value should be \"Basic < client credentials >\". The client creditials should be in the following format clientId:secret and then base64 encoded.","required":true,"type":"string","default":"Basic <base64 encoded clientId:secret>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TokenCreationResult"}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."}}}},"/hsapi/IsHascEnabled":{"get":{"tags":["Utility"],"summary":"Check if Company is HASC-enabled by userUuid (takes precedense) or inquiryUuid","operationId":"IsHascEnabled","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"userUuid","in":"query","description":"","required":false,"type":"string"},{"name":"inquiryUuid","in":"query","description":"","required":false,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/ListPmcs":{"get":{"tags":["Utility"],"summary":"Lists the Property Management Companies that have granted access to the authenticated HomeAway Partner within context. \r\nFiltered by EndSystem header provided.","operationId":"ListPmcs","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Company"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."}}}},"/hsapi/SearchWorkOrders":{"post":{"tags":["WorkOrders"],"summary":"This should search through work orders in the system, and return work orders that match the search parameters","operationId":"SearchWorkOrders","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"pagedWorkOrderSearchSpecification","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/PagedWorkOrderSearchSpecification"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PagedSearchResults_WorkOrder"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetWorkOrder":{"get":{"tags":["WorkOrders"],"summary":"Returns single work order that match based on native work order id.","operationId":"GetWorkOrder","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"nativeWorkOrderId","in":"query","description":"","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/WorkOrder"}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetWorkOrders":{"post":{"tags":["WorkOrders"],"summary":"Returns all the work orders that match based on native work order ids","operationId":"GetWorkOrders","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"nativeWorkOrderIds","in":"body","description":"","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BatchGetResponse_WorkOrder,String"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/SaveWorkOrder":{"put":{"tags":["WorkOrders"],"summary":"Saves all the details of the `WorkOrder` in the end system.","operationId":"SaveWorkOrder","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"workOrder","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/WorkOrder"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/WorkOrder"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetWorkoOrderMaterialsInventory":{"get":{"tags":["WorkOrders"],"summary":"Get list of all available materials","operationId":"GetWorkoOrderMaterialsInventory","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/WorkOrderMeterial"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetWorkOrderInternalAssigneeList":{"get":{"tags":["WorkOrders"],"summary":"Get list of available emlpoyees","operationId":"GetWorkOrderInternalAssigneeList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MaintenanceAssignee"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetWorkOrderVendorList":{"get":{"tags":["WorkOrders"],"summary":"Get list of available vendors","operationId":"GetWorkOrderVendorList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MaintenanceAssignee"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetChargeTemplateList":{"get":{"tags":["WorkOrders"],"summary":"Gets all available charge templates to use in escapia work order tasks","operationId":"GetChargeTemplateList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ChargeTemplate"}}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/GetWorkOrderTask":{"get":{"tags":["WorkOrders"],"summary":"Returns single work order task that match based on native work order id and assignment number","operationId":"GetWorkOrderTask","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"nativeWorkOrderId","in":"query","description":"The work order Id","required":true,"type":"string"},{"name":"assignmentNumber","in":"query","description":"Number of assignment or task","required":true,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/WorkOrderTask"}},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}},"/hsapi/SaveWorkOrderTask":{"put":{"tags":["WorkOrders"],"summary":"Saves the work order task","operationId":"SaveWorkOrderTask","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"x-homeaway-hasp-api-version","in":"header","required":true,"type":"string","default":"10"},{"name":"x-homeaway-hasp-api-endsystem","in":"header","required":true,"type":"string","default":"EscapiaVRS"},{"name":"x-homeaway-hasp-api-pmcid","in":"header","required":true,"type":"string","default":"1020"},{"name":"workOrderTask","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/WorkOrderTask"}},{"name":"Authorization","in":"header","description":"Bearer Authorization header. The value should be \"Bearer < bearer token >\". The bearer token is obtained from the auth/token endpoint. The bearer token must be base64 encoded. Use the above <a href='#oauthTokenGeneratorContainer'>form</a> to request and populate OAuth Bearer Token and Client Id.","required":true,"type":"string","default":"Bearer <base64 encoded bearer token>"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/WorkOrderTask"}},"400":{"description":"Bad Request. This can result from a malformed request body."},"401":{"description":"Unauthorized. This can result from a missing, expired or malformed Authorization header."},"403":{"description":"Forbidden. This can result from insufficient permissions to access a method."}}}}},"definitions":{"AdditionalProperty":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"AddOn":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"format":"int32","type":"integer"},"description":{"type":"string"},"inRent":{"type":"boolean"},"chargeType":{"enum":["Standard","TravelInsurance","RefundableDeposit"],"type":"string"},"appliesToReservationTypes":{"type":"array","items":{"type":"string"}},"appliesTo":{"$ref":"#/definitions/UnitApplicationScope"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"AddOnPricingSummary":{"type":"object","properties":{"definition":{"$ref":"#/definitions/AddOn"},"price":{"format":"double","type":"number"},"quantity":{"format":"int32","type":"integer"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"AddOnSearchSpecification":{"type":"object","properties":{"returnOnlyTravelInsurance":{"type":"boolean"},"marketingSourceNativePMSID":{"type":"string"},"pmcid":{"type":"string"},"searchTerm":{"type":"string"},"stayDateRange":{"$ref":"#/definitions/DateRange"},"unitNativePMSID":{"type":"string"},"reservationTypeNativePMSID":{"type":"string"},"rateAdjustmentCategoryNativePMSID":{"type":"string"},"promoCodeNativePMSID":{"type":"string"},"stayDateSearchType":{"enum":["ExplicitDateRange","TodayAndFutureDates"],"type":"string"}}},"AddOnSpecification":{"required":["addOnTypeNativePMSID"],"type":"object","properties":{"addOnTypeNativePMSID":{"type":"string"},"name":{"type":"string"},"quantity":{"format":"int32","type":"integer"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"Address":{"type":"object","properties":{"street1":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"province":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"},"addressContactTypeId":{"type":"string"},"isPrimary":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"AddressContactType":{"type":"object","properties":{"addressContactTypeName":{"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"BaseRate":{"type":"object","properties":{"rate":{"format":"double","type":"number"},"adjustedRate":{"format":"double","type":"number"}}},"BaseRateSeason":{"type":"object","properties":{"dateRange":{"$ref":"#/definitions/DateRange"},"monthlyRate":{"$ref":"#/definitions/BaseRate"},"weeklyRate":{"$ref":"#/definitions/BaseRate"},"dailyRate":{"$ref":"#/definitions/BaseRate"}}},"BatchGetResponse_UnitHousekeepingStatus,String":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/UnitHousekeepingStatus"}},"missingItemKeys":{"type":"array","items":{"type":"string"}}}},"BatchGetResponse_WorkOrder,String":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/WorkOrder"}},"missingItemKeys":{"type":"array","items":{"type":"string"}}}},"BedGroup":{"type":"object","properties":{"bedType":{"$ref":"#/definitions/BedType"},"bedQuantity":{"format":"int32","type":"integer"}}},"BedType":{"type":"object","properties":{"name":{"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"BookingChannel":{"type":"object","properties":{"displayName":{"type":"string"},"value":{"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"CancellationPolicy":{"type":"object","properties":{"name":{"type":"string"},"policy":{"type":"string"}}},"ChangeList":{"type":"object","properties":{"startVersion":{"format":"int64","type":"integer"},"endVersion":{"format":"int64","type":"integer"},"changes":{"type":"array","items":{"$ref":"#/definitions/EntityChange"}}}},"ChargeTemplate":{"type":"object","properties":{"templateId":{"format":"int32","type":"integer"},"name":{"type":"string"}}},"ColumnMetadata":{"type":"object","properties":{"name":{"type":"string"},"type":{"enum":["String","Boolean","Decimal","Double","DateTime"],"type":"string"}}},"Company":{"type":"object","properties":{"endSystem":{"enum":["EscapiaVRS","V12","Overview","PropertyPlus","Entech","AvMain","MockEndSystemService"],"type":"string"},"pmcid":{"type":"string"},"name":{"type":"string"},"address":{"$ref":"#/definitions/Address"},"email":{"$ref":"#/definitions/Email"},"logoURL":{"type":"string"},"phone":{"$ref":"#/definitions/Phone"},"url":{"type":"string"}}},"CompanyInfo":{"type":"object","properties":{"name":{"type":"string"},"email":{"$ref":"#/definitions/Email"},"phone":{"$ref":"#/definitions/Phone"},"address":{"$ref":"#/definitions/Address"},"url":{"type":"string"},"logoURL":{"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"CreditCard":{"type":"object","properties":{"hapiTokenId":{"type":"string"},"name":{"type":"string"},"creditCardType":{"enum":["Visa","Mastercard","Discover","AmericanExpress","DinersClub","JapaneseCreditBureau","EnRoute"],"type":"string"},"expiryMonth":{"format":"int32","type":"integer"},"expiryYear":{"format":"int32","type":"integer"},"maskedAccountNumber":{"type":"string"},"email":{"type":"string"},"billingAddress":{"$ref":"#/definitions/Address"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"CustomizationSearchSpecification":{"type":"object","properties":{"pmcid":{"type":"string"},"searchTerm":{"type":"string"},"stayDateRange":{"$ref":"#/definitions/DateRange"},"unitNativePMSID":{"type":"string"},"reservationTypeNativePMSID":{"type":"string"},"rateAdjustmentCategoryNativePMSID":{"type":"string"},"promoCodeNativePMSID":{"type":"string"},"stayDateSearchType":{"enum":["ExplicitDateRange","TodayAndFutureDates"],"type":"string"}}},"CustomizeReservationSpecification":{"required":["reservationNativePMSID"],"type":"object","properties":{"reservationNativePMSID":{"type":"string"},"addOns":{"type":"array","items":{"$ref":"#/definitions/AddOnSpecification"}},"packages":{"type":"array","items":{"$ref":"#/definitions/PackageSpecification"}},"extras":{"type":"array","items":{"$ref":"#/definitions/ExtraSpecification"}}}},"DateRange":{"required":["startDate","endDate"],"type":"object","properties":{"startDate":{"format":"date","type":"string"},"endDate":{"format":"date","type":"string"}}},"DateRangeSearchSpecification":{"required":["dateRange"],"type":"object","properties":{"dateRange":{"$ref":"#/definitions/DateRange"},"dateRangeSearchMethod":{"enum":["Overlap","StartDate","EndDate"],"type":"string"}}},"Diagnosis":{"type":"object","properties":{"displayMessage":{"type":"string"},"internalMessage":{"type":"string"}}},"ElectronicCheck":{"type":"object","properties":{"hapiTokenId":{"type":"string"},"maskedAccountNumber":{"type":"string"},"accountName":{"type":"string"},"routingNumber":{"type":"string"},"accountHolderName":{"type":"string"},"email":{"type":"string"},"billingAddress":{"$ref":"#/definitions/Address"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"Email":{"type":"object","properties":{"address":{"type":"string"},"emailContactTypeId":{"type":"string"},"isPrimary":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"EmailContactType":{"type":"object","properties":{"emailContactTypeName":{"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"EntityChange":{"type":"object","properties":{"nativePMSID":{"type":"string"},"changeType":{"enum":["Create","Update","Delete"],"type":"string"},"changeTime":{"format":"ISO-8601","type":"string"}}},"EventEntity":{"type":"object","properties":{"eventEntityTypePMSID":{"type":"string"},"name":{"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"Extra":{"type":"object","properties":{"name":{"type":"string"},"categoryName":{"type":"string"},"quantity":{"format":"int32","type":"integer"},"description":{"type":"string"},"price":{"format":"double","type":"number"},"appliesTo":{"$ref":"#/definitions/UnitApplicationScope"},"bookDateRange":{"$ref":"#/definitions/DateRange"},"stayDateRange":{"$ref":"#/definitions/DateRange"},"quantityAvailable":{"format":"int32","type":"integer"},"isDateRequired":{"type":"boolean"},"minNights":{"format":"int32","type":"integer"},"maxNights":{"format":"int32","type":"integer"},"minimumQuantity":{"format":"int32","type":"integer"},"maximumQuantity":{"format":"int32","type":"integer"},"appliesToReservationTypes":{"type":"array","items":{"type":"string"}},"scaledImages":{"type":"array","items":{"$ref":"#/definitions/ScaledImage"}},"isInternal":{"type":"boolean"},"duration":{"format":"int32","type":"integer"},"durationType":{"enum":["Hours","Days","Nights","Weeks","Months","Items","Bookings"],"type":"string","nullable":true,"x-ms-enum":{"name":"DurationType","modelAsString":false}},"calculationType":{"enum":["ByQuantity","ByDuration","ByQuantityAndDuration"],"type":"string","nullable":true,"x-ms-enum":{"name":"PriceCalculationType","modelAsString":false}},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"ExtraPricingSummary":{"type":"object","properties":{"definition":{"$ref":"#/definitions/Extra"},"price":{"format":"double","type":"number"},"quantity":{"format":"int32","type":"integer"},"duration":{"format":"int32","type":"integer"},"calculationType":{"enum":["ByQuantity","ByDuration","ByQuantityAndDuration"],"type":"string"},"date":{"format":"date","type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"ExtraSpecification":{"required":["extraTypeNativePMSID"],"type":"object","properties":{"extraTypeNativePMSID":{"type":"string"},"name":{"type":"string"},"categoryName":{"type":"string"},"quantity":{"format":"int32","type":"integer"},"duration":{"format":"int32","type":"integer"},"calculationType":{"enum":["ByQuantity","ByDuration","ByQuantityAndDuration"],"type":"string"},"date":{"format":"date","type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"Feature":{"type":"object","properties":{"name":{"type":"string"},"displayOrder":{"format":"int32","type":"integer"},"group":{"$ref":"#/definitions/FeatureGroup"},"value":{"type":"string"},"orMore":{"type":"boolean"},"type":{"enum":["Boolean","Integer","Decimal","String"],"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"FeatureGroup":{"type":"object","properties":{"name":{"type":"string"},"displayOrder":{"format":"int32","type":"integer"},"mutuallyExclusiveFeatures":{"type":"boolean"},"allowOrMore":{"type":"boolean"},"features":{"type":"array","items":{"$ref":"#/definitions/Feature"}},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"FeatureValueUpdate":{"required":["featureGroupId"],"type":"object","properties":{"featureGroupId":{"type":"string"},"featureValueIds":{"type":"array","items":{"type":"string"}}}},"Guest":{"type":"object","properties":{"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"},"addresses":{"type":"array","items":{"$ref":"#/definitions/Address"}},"phones":{"type":"array","items":{"$ref":"#/definitions/Phone"}},"emails":{"type":"array","items":{"$ref":"#/definitions/Email"}},"isPrimaryGuest":{"type":"boolean"},"isVIP":{"type":"boolean"},"isWarn":{"type":"boolean"},"notes":{"type":"string"},"fullNameLastCommaFirst":{"type":"string"},"fullNameFirstMiddleLast":{"type":"string"},"fullNameFirstLast":{"type":"string"},"detailURL":{"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"HousekeepingStatus":{"type":"object","properties":{"name":{"type":"string"},"nativeStatusId":{"format":"int32","type":"integer"},"abbreviation":{"type":"string"},"isDefaultOnCheckIn":{"type":"boolean"},"isDefaultOnCheckOut":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"HousekeepingTask":{"type":"object","properties":{"nativePMSUnitID":{"format":"int32","type":"integer"},"reservationNumber":{"format":"int32","type":"integer"},"cleaningTypeCode":{"type":"string"},"assignedToId":{"format":"int32","type":"integer"},"dayOfWeek":{"type":"string"},"laborHours":{"format":"double","type":"number"},"scheduledDate":{"format":"date","type":"string"},"cleanStatusID":{"format":"int32","type":"integer"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"HousekeepingTaskCustom":{"type":"object","properties":{"cleaningTypeName":{"type":"string"},"assignedToName":{"type":"string"},"nativePMSUnitID":{"format":"int32","type":"integer"},"reservationNumber":{"format":"int32","type":"integer"},"cleaningTypeCode":{"type":"string"},"assignedToId":{"format":"int32","type":"integer"},"dayOfWeek":{"type":"string"},"laborHours":{"format":"double","type":"number"},"scheduledDate":{"format":"date","type":"string"},"cleanStatusID":{"format":"int32","type":"integer"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"HousekeepingTaskSearchSpecification":{"type":"object","properties":{"unitCodes":{"type":"array","items":{"type":"string"}},"serviceType":{"type":"string"},"dateRange":{"$ref":"#/definitions/DateRange"}}},"Location":{"type":"object","properties":{"name":{"type":"string"},"locationCategories":{"type":"array","items":{"$ref":"#/definitions/LocationCategory"}},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"LocationCategory":{"type":"object","properties":{"name":{"type":"string"},"locationOptions":{"type":"array","items":{"$ref":"#/definitions/LocationOption"}},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"LocationOption":{"type":"object","properties":{"name":{"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"MaintenanceAssignee":{"type":"object","properties":{"name":{"type":"string"},"nativeAssigneeId":{"format":"int32","type":"integer"},"type":{"enum":["Employee","Vendor","Crew"],"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"MaintenanceUnitSummary":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"headline":{"type":"string"},"sleeps":{"format":"double","type":"number"},"bedrooms":{"format":"double","type":"number"},"bathrooms":{"format":"double","type":"number"},"latitude":{"format":"double","type":"number"},"longitude":{"format":"double","type":"number"},"detailURL":{"type":"string"},"thumbnailImageURL":{"type":"string"},"occupied":{"type":"boolean"},"address":{"$ref":"#/definitions/Address"},"proximity":{"format":"double","type":"number"},"proximityUnitOfMeasure":{"enum":["Miles","Feet","Kilometers","Meters"],"type":"string"},"vacantUntil":{"format":"date","type":"string"},"occupiedUntil":{"format":"date","type":"string"},"nextArrival":{"format":"date","type":"string"},"unitVacancyStatus":{"enum":["Occupied","Turnover","Vacant","Arrival","Departure"],"type":"string","nullable":true,"x-ms-enum":{"name":"UnitVacancyStatus","modelAsString":false}},"unitHousekeepingStatusType":{"$ref":"#/definitions/UnitHousekeepingStatusType"},"ownerNativePMSIDs":{"type":"array","items":{"type":"string"}},"secondaryDescription":{"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"MarketingCategory":{"type":"object","properties":{"category":{"type":"string"},"correspondingInquirySource":{"enum":["HomeAway","EscapiaNET","ISILink"],"type":"string","nullable":true,"x-ms-enum":{"name":"InquirySource","modelAsString":false}},"marketingSources":{"type":"array","items":{"$ref":"#/definitions/MarketingSource"}},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"MarketingSource":{"type":"object","properties":{"source":{"type":"string"},"correspondingInquirySource":{"enum":["HomeAway","EscapiaNET","ISILink"],"type":"string","nullable":true,"x-ms-enum":{"name":"InquirySource","modelAsString":false}},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"MultiQuoteSpecification":{"required":["stayDateRange","unitNativePMSIDs"],"type":"object","properties":{"stayDateRange":{"$ref":"#/definitions/DateRange"},"unitNativePMSIDs":{"type":"array","items":{"type":"string"}},"promoCodeNativePMSID":{"type":"string"},"includeDefaultAddOns":{"type":"boolean"},"includeDefaultTravelInsurance":{"type":"boolean"},"includeDefaultRefundableDeposits":{"type":"boolean"},"adults":{"format":"int32","type":"integer"},"children":{"format":"int32","type":"integer"},"freeGuests":{"format":"int32","type":"integer"},"pets":{"format":"int32","type":"integer"},"reservationTypeNativePMSID":{"type":"string"},"discount":{"format":"double","type":"number"},"discountType":{"enum":["Dollar","Percentage"],"type":"string"},"pricingPlanNativePMSID":{"type":"string"},"marketingCategoryNativePMSID":{"type":"string"},"marketingSourceNativePMSID":{"type":"string"},"ignoreBookingRules":{"type":"boolean"},"addOns":{"type":"array","items":{"$ref":"#/definitions/AddOnSpecification"}},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"NonAvailability":{"type":"object","properties":{"dateRange":{"$ref":"#/definitions/DateRange"}}},"NonAvailabilitySpecification":{"required":["dateRange"],"type":"object","properties":{"dateRange":{"$ref":"#/definitions/DateRange"},"nativePMSUnitID":{"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"Note":{"type":"object","properties":{"text":{"type":"string"},"modifiedOn":{"format":"date-time","type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"OptionalUpdate_Boolean":{"type":"object","properties":{"value":{"type":"boolean"}}},"OptionalUpdate_String":{"type":"object","properties":{"value":{"type":"string"}}},"Owner":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"phones":{"type":"array","items":{"$ref":"#/definitions/Phone"}},"emails":{"type":"array","items":{"$ref":"#/definitions/Email"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/Address"}},"ownsUnitNativePMSIDs":{"type":"array","items":{"type":"string"}},"ownedUnits":{"type":"array","items":{"$ref":"#/definitions/UnitBlurb"}},"notes":{"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"OwnerSearchSpecification":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"emailAddress":{"type":"string"}}},"Package":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"price":{"format":"double","type":"number"},"discountCalculationDescription":{"type":"string"},"appliesTo":{"$ref":"#/definitions/UnitApplicationScope"},"bookDateRange":{"$ref":"#/definitions/DateRange"},"stayDates":{"type":"array","items":{"$ref":"#/definitions/DateRange"}},"minNights":{"format":"int32","type":"integer"},"maxNights":{"format":"int32","type":"integer"},"extras":{"type":"array","items":{"$ref":"#/definitions/PackageExtra"}},"appliesToReservationTypes":{"type":"array","items":{"type":"string"}},"scaledImages":{"type":"array","items":{"$ref":"#/definitions/ScaledImage"}},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"PackageExtra":{"type":"object","properties":{"name":{"type":"string"},"categoryName":{"type":"string"},"description":{"type":"string"},"quantity":{"format":"int32","type":"integer"},"duration":{"format":"int32","type":"integer"},"calculationType":{"enum":["ByQuantity","ByDuration","ByQuantityAndDuration"],"type":"string"},"isDateRequired":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"PackagePricingSummary":{"type":"object","properties":{"definition":{"$ref":"#/definitions/Package"},"note":{"type":"string"},"extras":{"type":"array","items":{"$ref":"#/definitions/ExtraPricingSummary"}},"price":{"format":"double","type":"number"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"PackageSpecification":{"required":["packageTypeNativePMSID"],"type":"object","properties":{"packageTypeNativePMSID":{"type":"string"},"name":{"type":"string"},"note":{"type":"string"},"extras":{"type":"array","items":{"$ref":"#/definitions/ExtraSpecification"}},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"PagedSearchResults_AddOn":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/AddOn"}},"totalCount":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageNumber":{"format":"int32","type":"integer"},"fromIndex":{"format":"int32","type":"integer"},"toIndex":{"format":"int32","type":"integer"}}},"PagedSearchResults_Extra":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/Extra"}},"totalCount":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageNumber":{"format":"int32","type":"integer"},"fromIndex":{"format":"int32","type":"integer"},"toIndex":{"format":"int32","type":"integer"}}},"PagedSearchResults_HousekeepingTaskCustom":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/HousekeepingTaskCustom"}},"totalCount":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageNumber":{"format":"int32","type":"integer"},"fromIndex":{"format":"int32","type":"integer"},"toIndex":{"format":"int32","type":"integer"}}},"PagedSearchResults_Owner":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/Owner"}},"totalCount":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageNumber":{"format":"int32","type":"integer"},"fromIndex":{"format":"int32","type":"integer"},"toIndex":{"format":"int32","type":"integer"}}},"PagedSearchResults_Package":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/Package"}},"totalCount":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageNumber":{"format":"int32","type":"integer"},"fromIndex":{"format":"int32","type":"integer"},"toIndex":{"format":"int32","type":"integer"}}},"PagedSearchResults_ReservationEvent":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/ReservationEvent"}},"totalCount":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageNumber":{"format":"int32","type":"integer"},"fromIndex":{"format":"int32","type":"integer"},"toIndex":{"format":"int32","type":"integer"}}},"PagedSearchResults_ReservationSummary":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/ReservationSummary"}},"totalCount":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageNumber":{"format":"int32","type":"integer"},"fromIndex":{"format":"int32","type":"integer"},"toIndex":{"format":"int32","type":"integer"}}},"PagedSearchResults_UnitSummary":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/UnitSummary"}},"totalCount":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageNumber":{"format":"int32","type":"integer"},"fromIndex":{"format":"int32","type":"integer"},"toIndex":{"format":"int32","type":"integer"}}},"PagedSearchResults_WorkOrder":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/WorkOrder"}},"totalCount":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageNumber":{"format":"int32","type":"integer"},"fromIndex":{"format":"int32","type":"integer"},"toIndex":{"format":"int32","type":"integer"}}},"PagedSearchSpecification_AddOnSearchSpecification":{"type":"object","properties":{"specification":{"$ref":"#/definitions/AddOnSearchSpecification"},"pageSize":{"format":"int32","type":"integer"},"pageNumber":{"format":"int32","type":"integer"}}},"PagedSearchSpecification_CustomizationSearchSpecification":{"type":"object","properties":{"specification":{"$ref":"#/definitions/CustomizationSearchSpecification"},"pageSize":{"format":"int32","type":"integer"},"pageNumber":{"format":"int32","type":"integer"}}},"PagedSearchSpecification_HousekeepingTaskSearchSpecification":{"type":"object","properties":{"specification":{"$ref":"#/definitions/HousekeepingTaskSearchSpecification"},"pageSize":{"format":"int32","type":"integer"},"pageNumber":{"format":"int32","type":"integer"}}},"PagedSearchSpecification_OwnerSearchSpecification":{"type":"object","properties":{"specification":{"$ref":"#/definitions/OwnerSearchSpecification"},"pageSize":{"format":"int32","type":"integer"},"pageNumber":{"format":"int32","type":"integer"}}},"PagedSearchSpecification_ReservationSearchSpecification":{"type":"object","properties":{"specification":{"$ref":"#/definitions/ReservationSearchSpecification"},"pageSize":{"format":"int32","type":"integer"},"pageNumber":{"format":"int32","type":"integer"}}},"PagedSearchSpecification_String":{"type":"object","properties":{"specification":{"type":"string"},"pageSize":{"format":"int32","type":"integer"},"pageNumber":{"format":"int32","type":"integer"}}},"PagedSearchSpecification_UnitSearchSpecification":{"type":"object","properties":{"specification":{"$ref":"#/definitions/UnitSearchSpecification"},"pageSize":{"format":"int32","type":"integer"},"pageNumber":{"format":"int32","type":"integer"}}},"PagedWorkOrderSearchSpecification":{"type":"object","properties":{"pageSize":{"format":"int32","type":"integer"},"pageNumber":{"format":"int32","type":"integer"},"keywords":{"type":"array","items":{"type":"string"}},"nativeUnitID":{"type":"string"},"nativeUnitCode":{"type":"string"},"assignee":{"type":"string"},"nativeAssigneeID":{"type":"string"},"maxResults":{"format":"int32","type":"integer"},"statuses":{"type":"array","items":{"enum":["Pending","Started","Completed","Assigned","Entered","Approved","Scheduled","Posted"],"type":"string"}},"startDateRange":{"$ref":"#/definitions/DateRange"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"PaymentMethod":{"type":"object","properties":{"guestNativePMSID":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"preferred":{"type":"boolean"},"type":{"enum":["CreditCard","ElectronicCheck","Check","Cash"],"type":"string"},"creditCard":{"$ref":"#/definitions/CreditCard"},"electronicCheck":{"$ref":"#/definitions/ElectronicCheck"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"PaymentScheduleItem":{"type":"object","properties":{"orderNumber":{"format":"int32","type":"integer"},"name":{"type":"string"},"amount":{"format":"double","type":"number"},"paymentTotal":{"format":"double","type":"number"},"dueDate":{"format":"date","type":"string"},"paymentStatus":{"enum":["Unpaid","PartiallyPaid","FullyPaid"],"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"Phone":{"type":"object","properties":{"countryCode":{"type":"string"},"areaCode":{"type":"string"},"number":{"type":"string"},"extension":{"type":"string"},"phoneContactTypeId":{"type":"string"},"isPrimary":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"PhoneContactType":{"type":"object","properties":{"phoneContactTypeName":{"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"PricingComponent":{"type":"object","properties":{"componentType":{"enum":["Labor","Material","MaterialOffList","SubContract","Other"],"type":"string"},"quantity":{"format":"double","type":"number"},"rate":{"format":"double","type":"number"},"markupAmount":{"format":"double","type":"number"},"markupAmountType":{"enum":["Dollar","Percentage"],"type":"string"},"taxable":{"type":"boolean"},"markupTaxable":{"type":"boolean"},"taxValue":{"format":"double","type":"number"},"total":{"format":"double","type":"number"},"invoiceNo":{"type":"string"},"useMaterialsSalePrice":{"type":"boolean"},"materialsOnList":{"type":"array","items":{"$ref":"#/definitions/WorkOrderTaskMaterial"}},"chargeTemplate":{"$ref":"#/definitions/ChargeTemplate"},"resource":{"enum":["Business","Vendor"],"type":"string"},"nativeVendorId":{"format":"int32","type":"integer"},"vendorName":{"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"PricingPlan":{"type":"object","properties":{"plan":{"type":"string"},"isPrimary":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"PromoCode":{"type":"object","properties":{"code":{"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"Quote":{"type":"object","properties":{"quoteSpecification":{"$ref":"#/definitions/QuoteSpecification"},"failureDiagnosis":{"$ref":"#/definitions/Diagnosis"},"rent":{"format":"double","type":"number"},"tax":{"format":"double","type":"number"},"discounts":{"type":"array","items":{"$ref":"#/definitions/ReservationDiscount"}},"discount":{"format":"double","type":"number"},"total":{"format":"double","type":"number"},"paymentSchedule":{"type":"array","items":{"$ref":"#/definitions/PaymentScheduleItem"}},"isUnitAvailable":{"type":"boolean"},"packages":{"type":"array","items":{"$ref":"#/definitions/PackagePricingSummary"}},"extras":{"type":"array","items":{"$ref":"#/definitions/ExtraPricingSummary"}},"addOns":{"type":"array","items":{"$ref":"#/definitions/AddOnPricingSummary"}}}},"QuoteSpecification":{"required":["stayDateRange"],"type":"object","properties":{"stayDateRange":{"$ref":"#/definitions/DateRange"},"unitNativePMSID":{"type":"string"},"promoCodeNativePMSID":{"type":"string"},"includeDefaultTravelInsurance":{"type":"boolean"},"includeDefaultRefundableDeposits":{"type":"boolean"},"includeDefaultAddOns":{"type":"boolean"},"adults":{"format":"int32","maximum":2147483647,"minimum":1,"type":"integer"},"children":{"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"freeGuests":{"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"pets":{"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"reservationTypeNativePMSID":{"type":"string"},"discount":{"format":"double","type":"number"},"discountType":{"enum":["Dollar","Percentage"],"type":"string"},"pricingPlanNativePMSID":{"type":"string"},"marketingCategoryNativePMSID":{"type":"string"},"marketingSourceNativePMSID":{"type":"string"},"ignoreBookingRules":{"type":"boolean"},"packages":{"type":"array","items":{"$ref":"#/definitions/PackageSpecification"}},"extras":{"type":"array","items":{"$ref":"#/definitions/ExtraSpecification"}},"addOns":{"type":"array","items":{"$ref":"#/definitions/AddOnSpecification"}},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"ReportOutput":{"type":"object","properties":{"specification":{"$ref":"#/definitions/ReportSpecification"},"resultSets":{"type":"array","items":{"$ref":"#/definitions/ResultSet"}}}},"ReportSpecification":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}}}},"Reservation":{"type":"object","properties":{"failureDiagnosis":{"$ref":"#/definitions/Diagnosis"},"reservationNumber":{"type":"string"},"stayDateRange":{"$ref":"#/definitions/DateRange"},"unitNativePMSID":{"type":"string"},"guests":{"type":"array","items":{"$ref":"#/definitions/Guest"}},"doorCode":{"type":"string"},"adults":{"format":"int32","type":"integer"},"children":{"format":"int32","type":"integer"},"reservationGroup":{"$ref":"#/definitions/ReservationGroup"},"rent":{"format":"double","type":"number"},"tax":{"format":"double","type":"number"},"discounts":{"type":"array","items":{"$ref":"#/definitions/ReservationDiscount"}},"discount":{"format":"double","type":"number"},"total":{"format":"double","type":"number"},"paymentTotal":{"format":"double","type":"number"},"serviceFee":{"format":"double","type":"number"},"paymentSchedule":{"type":"array","items":{"$ref":"#/definitions/PaymentScheduleItem"}},"rates":{"type":"array","items":{"$ref":"#/definitions/ReservationRate"}},"reservationDetailURL":{"type":"string"},"paymentURL":{"type":"string"},"checkInCheckOutURL":{"type":"string"},"moveURL":{"type":"string"},"chargeDetailURL":{"type":"string"},"notes":{"type":"array","items":{"$ref":"#/definitions/Note"}},"holdType":{"enum":["None","Owner","Maintenance","SoftBlock","GroupSoftBlock","GuestOfOwner","Unavailable"],"type":"string"},"reservationTypeNativePMSID":{"type":"string"},"pricingPlanNativePMSID":{"type":"string"},"kabaLockCode":{"type":"string"},"immovable":{"type":"boolean"},"status":{"enum":["Unconfirmed","Confirmed","Cancelled"],"type":"string"},"paymentStatus":{"enum":["Unpaid","PartiallyPaid","FullyPaid"],"type":"string"},"occupancyStatus":{"enum":["AwaitingCheckIn","CheckedIn","CheckedOut"],"type":"string"},"depositStatus":{"enum":["Paid","NotPaid","Overdue"],"type":"string"},"marketingCategoryNativePMSID":{"type":"string"},"bookingChannel":{"$ref":"#/definitions/BookingChannel"},"marketingSourceNativePMSID":{"type":"string"},"bookedByTravelAgent":{"type":"boolean"},"createdBy":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"isLockOff":{"type":"boolean"},"packages":{"type":"array","items":{"$ref":"#/definitions/PackagePricingSummary"}},"extras":{"type":"array","items":{"$ref":"#/definitions/ExtraPricingSummary"}},"addOns":{"type":"array","items":{"$ref":"#/definitions/AddOnPricingSummary"}},"additionalProperties":{"type":"array","items":{"$ref":"#/definitions/AdditionalProperty"}},"partnerID":{"type":"string"},"partnerName":{"type":"string"},"preferredPaymentMethod":{"$ref":"#/definitions/PaymentMethod"},"iataNumber":{"type":"string"},"checkInTime":{"format":"ISO-8601 time (HH':'mm':'ss.FFFFFFF)","type":"string"},"checkOutTime":{"format":"ISO-8601 time (HH':'mm':'ss.FFFFFFF)","type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"ReservationCancellationSpecification":{"type":"object","properties":{"partnerID":{"type":"string"},"partnerName":{"type":"string"},"userNativePMSID":{"type":"string"},"reason":{"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"ReservationChangeSpecification":{"type":"object","properties":{"unitNativePMSID":{"type":"string"},"stayDateRange":{"$ref":"#/definitions/DateRange"},"shouldReprice":{"type":"boolean"},"partnerID":{"type":"string"},"partnerName":{"type":"string"},"userNativePMSID":{"type":"string"},"reason":{"type":"string"},"notes":{"type":"array","items":{"$ref":"#/definitions/Note"}},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"ReservationChargeSpecification":{"type":"object","properties":{"reservationIdentifier":{"$ref":"#/definitions/ReservationIdentifier"},"currentReservationLookupKey":{"type":"string"},"amount":{"format":"double","type":"number"},"createdAt":{"format":"date-time","type":"string"},"transactionId":{"type":"string"},"description":{"type":"string"},"internalNotes":{"type":"string"},"category":{"type":"string"}}},"ReservationDiscount":{"type":"object","properties":{"name":{"type":"string"},"amount":{"format":"double","type":"number"},"discountType":{"enum":["Dollar","Percentage"],"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"ReservationEvent":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string"},"to":{"type":"string"},"from":{"type":"string"},"system":{"type":"string"},"eventType":{"enum":["Email","ESignature","Print"],"type":"string"},"description":{"type":"string"},"reservationNumber":{"type":"string"},"url":{"type":"string"},"targetEntity":{"$ref":"#/definitions/EventEntity"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"ReservationGroup":{"type":"object","properties":{"nativePMSID":{"type":"string"},"name":{"type":"string"},"detailURL":{"type":"string"}}},"ReservationIdentifier":{"type":"object","properties":{"identifier":{"type":"string"},"type":{"enum":["NativePMSID","ReservationNumber"],"type":"string"}}},"ReservationMetadataUpdateSpecification":{"required":["reservationId"],"type":"object","properties":{"reservationId":{"type":"string"},"doorCode":{"$ref":"#/definitions/OptionalUpdate_String"},"checkInTime":{"$ref":"#/definitions/OptionalUpdate_String"}}},"ReservationPayment":{"type":"object","properties":{"reservationNativePMSID":{"type":"string"},"paymentDate":{"format":"date","type":"string"},"paymentAmount":{"format":"double","type":"number"},"paymentType":{"enum":["CreditCard","ElectronicCheck","Check","Cash"],"type":"string"},"maskedAccountNumber":{"type":"string"},"paymentMethodNativePMSID":{"type":"string"}}},"ReservationRate":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"description":{"type":"string"},"averageRateText":{"type":"string"}}},"ReservationSearchSpecification":{"type":"object","properties":{"pmcid":{"type":"string"},"stayDateRangeSearchSpecification":{"$ref":"#/definitions/DateRangeSearchSpecification"},"bookedOnDateRange":{"$ref":"#/definitions/DateRange"},"unitNativePMSIDs":{"type":"array","items":{"type":"string"}},"reservationTypeNativePMSIDs":{"type":"array","items":{"type":"string"}},"guestNativePMSIDs":{"type":"array","items":{"type":"string"}},"holdTypes":{"type":"array","items":{"enum":["None","Owner","Maintenance","SoftBlock","GroupSoftBlock","GuestOfOwner","Unavailable"],"type":"string"}},"bookingMethod":{"enum":["Offline","Online"],"type":"string","nullable":true,"x-ms-enum":{"name":"BookingMethod","modelAsString":false}},"sortingMethod":{"enum":["CheckInChronological","CheckOutChronological","BookedChronological"],"type":"string","nullable":true,"x-ms-enum":{"name":"ReservationSortingMethod","modelAsString":false}}}},"ReservationSpecification":{"required":["quoteSpecification"],"type":"object","properties":{"guests":{"type":"array","items":{"$ref":"#/definitions/Guest"}},"note":{"type":"string"},"marketingCategory":{"$ref":"#/definitions/MarketingCategory"},"marketingSource":{"$ref":"#/definitions/MarketingSource"},"quoteSpecification":{"$ref":"#/definitions/QuoteSpecification"},"nativePMSUserID":{"type":"string"},"agreedToWarning":{"type":"boolean"},"partnerID":{"type":"string"},"iataNumber":{"type":"string"},"willOwnerCleanUnit":{"type":"boolean"},"setUnconfirmed":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"ReservationSummary":{"type":"object","properties":{"reservationNumber":{"type":"string"},"stayDateRange":{"$ref":"#/definitions/DateRange"},"unitNativePMSID":{"type":"string"},"primaryGuest":{"$ref":"#/definitions/Guest"},"guestCount":{"format":"int32","type":"integer"},"reservationGroup":{"$ref":"#/definitions/ReservationGroup"},"rent":{"format":"double","type":"number"},"total":{"format":"double","type":"number"},"paymentTotal":{"format":"double","type":"number"},"holdType":{"enum":["None","Owner","Maintenance","SoftBlock","GroupSoftBlock","GuestOfOwner","Unavailable"],"type":"string"},"confirmed":{"type":"boolean"},"paymentStatus":{"enum":["Unpaid","PartiallyPaid","FullyPaid"],"type":"string"},"depositStatus":{"enum":["Paid","NotPaid","Overdue"],"type":"string"},"marketingCategoryNativePMSID":{"type":"string"},"reservationTypeNativePMSID":{"type":"string"},"bookedByTravelAgent":{"type":"boolean"},"isLockOff":{"type":"boolean"},"netRentToOwner":{"format":"double","type":"number"},"ownerNativePMSIDs":{"type":"array","items":{"type":"string"}},"housekeepingNotes":{"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"ReservationType":{"type":"object","properties":{"type":{"type":"string"},"isDefaultStay":{"type":"boolean"},"ownerStayType":{"enum":["None","Owner","GuestOfOwner"],"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"ResultRow":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}}}},"ResultSet":{"type":"object","properties":{"metadata":{"$ref":"#/definitions/ResultSetMetadata"},"rows":{"type":"array","items":{"$ref":"#/definitions/ResultRow"}}}},"ResultSetMetadata":{"type":"object","properties":{"columnInfo":{"type":"array","items":{"$ref":"#/definitions/ColumnMetadata"}}}},"ScaledImage":{"type":"object","properties":{"caption":{"type":"string"},"displayOrder":{"format":"int32","type":"integer"},"options":{"type":"array","items":{"$ref":"#/definitions/ScaledImageOption"}},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"ScaledImageOption":{"type":"object","properties":{"url":{"type":"string"},"scale":{"enum":["SmallThumbnail","LargeThumbnail","Detail","Original"],"type":"string"},"height":{"format":"int32","type":"integer"},"width":{"format":"int32","type":"integer"}}},"SeasonalRateSchedule":{"type":"object","properties":{"unitId":{"type":"string"},"baseRateSeasons":{"type":"array","items":{"$ref":"#/definitions/BaseRateSeason"}}}},"SeasonalRateScheduleBatch":{"type":"object","properties":{"unitSeasonalRateSchedules":{"type":"array","items":{"$ref":"#/definitions/SeasonalRateSchedule"}}}},"SeasonalRateScheduleSpecification":{"required":["dateRange"],"type":"object","properties":{"dateRange":{"$ref":"#/definitions/DateRange"},"unitIds":{"type":"array","items":{"type":"string"}},"promoCodeId":{"type":"string"},"pricingPlanId":{"type":"string"}}},"TokenCreationResult":{"type":"object","properties":{"expiration":{"format":"date-time","type":"string","readOnly":true},"id":{"type":"string"},"encodedId":{"type":"string"},"authorizationHeaderValue":{"type":"string"}}},"Unit":{"type":"object","properties":{"unitName":{"type":"string"},"unitCode":{"type":"string"},"unitComplex":{"type":"string"},"unitHeadline":{"type":"string"},"address":{"$ref":"#/definitions/Address"},"headline":{"type":"string"},"latitude":{"format":"double","type":"number"},"longitude":{"format":"double","type":"number"},"bedrooms":{"format":"double","type":"number"},"bathrooms":{"format":"double","type":"number"},"bedGroups":{"type":"array","items":{"$ref":"#/definitions/BedGroup"}},"sleeps":{"format":"double","type":"number"},"internalDescription":{"type":"string"},"webDescription":{"type":"string"},"shortDescription":{"type":"string"},"guestGuidance":{"type":"string"},"featureGroups":{"type":"array","items":{"$ref":"#/definitions/FeatureGroup"}},"unitType":{"$ref":"#/definitions/UnitType"},"thumbnailImageURL":{"type":"string"},"available":{"type":"boolean"},"notes":{"type":"string"},"keycode":{"type":"string"},"kabaDoorName":{"type":"string"},"detailURL":{"type":"string"},"owners":{"type":"array","items":{"$ref":"#/definitions/Owner"}},"scaledImages":{"type":"array","items":{"$ref":"#/definitions/ScaledImage"}},"occupied":{"type":"boolean"},"proximity":{"format":"double","type":"number"},"proximityUnitOfMeasure":{"enum":["Miles","Feet","Kilometers","Meters"],"type":"string"},"vacantUntil":{"format":"date","type":"string"},"occupiedUntil":{"format":"date","type":"string"},"nextArrival":{"format":"date","type":"string"},"phones":{"type":"array","items":{"$ref":"#/definitions/Phone"}},"maintenanceNotes":{"type":"string"},"unitVacancyStatus":{"enum":["Occupied","Turnover","Vacant","Arrival","Departure"],"type":"string","nullable":true,"x-ms-enum":{"name":"UnitVacancyStatus","modelAsString":false}},"unitHousekeepingStatusType":{"$ref":"#/definitions/UnitHousekeepingStatusType"},"instantArea":{"type":"string"},"instantType":{"type":"string"},"instantLocation":{"type":"string"},"location":{"$ref":"#/definitions/Location"},"option1":{"$ref":"#/definitions/LocationOption"},"option2":{"$ref":"#/definitions/LocationOption"},"option3":{"$ref":"#/definitions/LocationOption"},"additionalProperties":{"type":"array","items":{"$ref":"#/definitions/AdditionalProperty"}},"isActive":{"type":"boolean"},"housekeepingNotes":{"type":"string"},"totalComplimentaryNights":{"format":"int32","type":"integer"},"availableComplimentaryNights":{"format":"int32","type":"integer"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"UnitApplicationScope":{"type":"object","properties":{"allUnits":{"type":"boolean"},"specificUnitNativePMSIDs":{"type":"array","items":{"type":"string"}},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"UnitBlurb":{"type":"object","properties":{"nativePMSID":{"type":"string"},"name":{"type":"string"},"code":{"type":"string"},"isActive":{"type":"boolean"},"share":{"format":"double","type":"number"}}},"UnitHousekeepingStatus":{"type":"object","properties":{"unitName":{"type":"string"},"unitCode":{"type":"string"},"assignee":{"type":"string"},"nextArrival":{"format":"date","type":"string"},"unitHousekeepingStatusType":{"$ref":"#/definitions/UnitHousekeepingStatusType"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"UnitHousekeepingStatusType":{"type":"object","properties":{"name":{"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"UnitMetadataUpdateSpecification":{"required":["unitNativePMSID"],"type":"object","properties":{"unitNativePMSID":{"type":"string"},"isActive":{"$ref":"#/definitions/OptionalUpdate_Boolean"},"unitHeadline":{"$ref":"#/definitions/OptionalUpdate_String"},"webDescription":{"$ref":"#/definitions/OptionalUpdate_String"},"shortDescription":{"$ref":"#/definitions/OptionalUpdate_String"},"notes":{"$ref":"#/definitions/OptionalUpdate_String"},"housekeepingNotes":{"$ref":"#/definitions/OptionalUpdate_String"},"guestGuidance":{"$ref":"#/definitions/OptionalUpdate_String"},"featureValueUpdates":{"type":"array","items":{"$ref":"#/definitions/FeatureValueUpdate"}}}},"UnitSearchSpecification":{"type":"object","properties":{"unitNameOrCode":{"type":"string"},"bedrooms":{"format":"double","type":"number"},"bathrooms":{"format":"double","type":"number"},"sleeps":{"format":"double","type":"number"},"stayDateRange":{"$ref":"#/definitions/DateRange"},"numberOfNights":{"format":"int32","type":"integer"},"requiredFeatures":{"type":"array","items":{"$ref":"#/definitions/Feature"}},"minRate":{"format":"double","type":"number"},"maxRate":{"format":"double","type":"number"},"unitType":{"$ref":"#/definitions/UnitType"},"returnUnavailableUnits":{"type":"boolean"},"returnInactiveUnits":{"type":"boolean"},"ignoreBookingRules":{"type":"boolean"},"unitHousekeepingStatusType":{"$ref":"#/definitions/UnitHousekeepingStatusType"},"mustAllowPets":{"type":"boolean"},"sortingMethod":{"enum":["None","UnitCodeAlphabetical","UnitCodeReverseAlphabetical","UnitNameAlphabetical","UnitNameReverseAlphabetical","BedroomCountIncreasing","BedroomCountDecreasing","LeastBookedUnits","Random","Proximity","Occupancy"],"type":"string"},"location":{"$ref":"#/definitions/Location"},"locationOption1":{"$ref":"#/definitions/LocationOption"},"locationOption2":{"$ref":"#/definitions/LocationOption"},"locationOption3":{"$ref":"#/definitions/LocationOption"},"reservationGroupNativePMSID":{"type":"string"},"streetAddress":{"type":"string"},"state":{"type":"string"},"rateDuration":{"type":"string"},"showRateAs":{"type":"string"},"rateAdjustmentCategoryNativePMSID":{"type":"string"},"unitCode":{"type":"string"},"friendlyName":{"type":"string"}}},"UnitSummary":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"headline":{"type":"string"},"sleeps":{"format":"double","type":"number"},"bedGroups":{"type":"array","items":{"$ref":"#/definitions/BedGroup"}},"bedrooms":{"format":"double","type":"number"},"bathrooms":{"format":"double","type":"number"},"unitHousekeepingStatusType":{"$ref":"#/definitions/UnitHousekeepingStatusType"},"available":{"type":"boolean"},"detailURL":{"type":"string"},"address":{"type":"string"},"cancellationPolicy":{"$ref":"#/definitions/CancellationPolicy"},"featureGroups":{"type":"array","items":{"$ref":"#/definitions/FeatureGroup"}},"totalComplimentaryNights":{"format":"int32","type":"integer"},"availableComplimentaryNights":{"format":"int32","type":"integer"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"UnitType":{"type":"object","properties":{"name":{"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"User":{"type":"object","properties":{"userName":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"userGroupNativePMSID":{"type":"string"},"roles":{"type":"array","items":{"enum":["MobileHousekeeper","MobileMaintenance","MobileAdmin","MobileHousekeepingManager","MobileMaintenanceManager","MobileVendor","RezGridCompanyAdmin","LMSCompanyAdmin","IgnoreBookingRules","BusinessConsoleCompanyAdmin","CustomizeQuotes","CustomizeExistingReservations"],"type":"string"}},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"WorkOrder":{"type":"object","properties":{"unit":{"$ref":"#/definitions/MaintenanceUnitSummary"},"workOrderTasks":{"type":"array","items":{"$ref":"#/definitions/WorkOrderTask"}},"workOrderNumber":{"type":"string"},"description":{"type":"string"},"reservationNumber":{"type":"string"},"status":{"enum":["Pending","Started","Completed","Assigned","Entered","Approved","Scheduled","Posted"],"type":"string"},"workOrderRemovesUnitFromAvailability":{"type":"boolean"},"startDateWhenUnitIsRemovedFromAvailability":{"format":"date","type":"string"},"endDateWhenUnitIsRemovedFromAvailability":{"format":"date","type":"string"},"priority":{"enum":["Urgent","High","Medium","Low","None"],"type":"string","nullable":true,"x-ms-enum":{"name":"WorkOrderPriority","modelAsString":false}},"reportedBy":{"type":"string"},"reportedOn":{"format":"date","type":"string"},"dueDate":{"format":"date","type":"string"},"category":{"$ref":"#/definitions/WorkOrderCategory"},"notes":{"type":"string"},"detailURL":{"type":"string"},"vendorName":{"type":"string"},"assignedEmployeeName":{"type":"string"},"nativeAssigneeId":{"format":"int32","type":"integer"},"isInternal":{"type":"boolean"},"actualCost":{"format":"double","type":"number"},"startedOn":{"format":"date","type":"string"},"completedOn":{"format":"date","type":"string"},"createdOn":{"format":"date","type":"string"},"createdBy":{"type":"string"},"additionalDescription":{"type":"string"},"estimatedCost":{"format":"double","type":"number"},"tax":{"format":"double","type":"number"},"isGuestWorkOrder":{"type":"boolean"},"totalCost":{"format":"double","type":"number"},"ifZeroHideOnOwnerStatement":{"type":"boolean"},"active":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"WorkOrderCategory":{"type":"object","properties":{"name":{"type":"string"},"subCategories":{"type":"array","items":{"$ref":"#/definitions/WorkOrderSubCategory"}},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"WorkOrderMeterial":{"type":"object","properties":{"upcCode":{"type":"string"},"description":{"type":"string"},"availableQuantity":{"format":"double","type":"number"},"cost":{"format":"double","type":"number"},"salePrice":{"format":"double","type":"number"}}},"WorkOrderSubCategory":{"type":"object","properties":{"name":{"type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"WorkOrderTask":{"type":"object","properties":{"workOrderID":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"assignmentNumber":{"format":"int32","type":"integer"},"status":{"type":"string"},"assignee":{"type":"string"},"nativeAssigneeID":{"type":"string"},"isInternal":{"type":"boolean"},"assignmentNote":{"type":"string"},"startedOn":{"format":"date","type":"string"},"completedOn":{"format":"date","type":"string"},"createdOn":{"format":"date","type":"string"},"priority":{"enum":["Urgent","High","Medium","Low","None"],"type":"string","nullable":true,"x-ms-enum":{"name":"WorkOrderPriority","modelAsString":false}},"invoiceNumber":{"type":"string"},"dueDate":{"format":"date","type":"string"},"subCategory":{"$ref":"#/definitions/WorkOrderSubCategory"},"pricingComponentList":{"type":"array","items":{"$ref":"#/definitions/PricingComponent"}},"removeFromAvailability":{"type":"boolean"},"materialOffListNotes":{"type":"string"},"removeAvailabilityFromDate":{"format":"date","type":"string"},"removeAvailabilityToDate":{"format":"date","type":"string"},"id":{"format":"int32","type":"integer"},"pmcid":{"type":"string"},"nativePMSID":{"type":"string"}}},"WorkOrderTaskMaterial":{"type":"object","properties":{"upcCode":{"type":"string"},"quantity":{"format":"double","type":"number"}}}}}