Accommodation Dossiers

An Accommodation Dossier has a one-to-one relationship with an transport resource.

XML Schema:

Resource Defintion

Note

This resource can be searched, allowing to you to access a filtered set of data. See our Searching The G API documentation for details on how to query specific fields and the operators available.

Fields

Name Type Description
name required String The name of this dossier.
date_created Datetime The time when the resource was created, in the standard dates-time.
date_last_modified Datetime The time when the resource was last modified, in the standard dates-time.
details Field List of free text details for this dossier.
  • id read-only
String  
  • body required
String Informational text for this detail.
  • detail_type required
Nested Object  
    • id read-only
String  
    • label
String Contains the label for a dossier feature.
    • code required
String Contains a code for a dossier feature.
type String The type of this resource.
id read-only String  
href read-only Field  
service_code String A unique code used to identify services.
publish_state String Can be either published or unpublished.
features Field List of features
  • id read-only
String  
  • href read-only
Field  
  • label
String Contains the label for a dossier feature.
  • code required
String Contains a code for the dossier feature.
dossier_segment Nested Object The segment data associated with this dossier.
  • id read-only
String  
  • href read-only
Field  
  • code required
String A unique ASCII code to identify this segment.
  • label
String A human-readable description of this segment.
address required Nested Object The address associated with this accommodation dossier.
  • address_line_1
String First line of this accommodation’s address (required)
  • address_line_2
String Second line of this accommodation’s address (optional)
  • address_line_3
String Third and final line of this accommodation’s address (optional)
  • postal_code
String The postal or zip code for this accommodation
  • country
Reference Object The country where this accommodation is located.
  • city required
Reference Object The city where this accommodation is located.
property_type required Nested Object The property type of this accommodation dossier.
  • code required
String Contains the unique ASCII code for this category.
  • label
String Contains the label for this category.
website Url The URL of the website associated with this accommodation dossier.
location Reference Object The Place resource associated with this accommodation dossier.
primary_country required Reference Object The country associated to this accommodation
rooms Field The rooms associated with this accommodation.
  • id read-only
String  
  • features
Field List of Room features.
    • id read-only
String  
    • href read-only
Field  
    • label
String Contains the label for a dossier feature.
    • code required
String Contains a code for the dossier feature.
  • room_type
Nested Object The type of this room.
    • code required
String Contains the unique ASCII code for this category.
    • label
String Contains the label for this category.
  • service_level required
Nested Object  
    • code required
String Contains the unique ASCII code for this category.
    • label
String Contains the label for this category.
  • sharing_level required
Nested Object  
    • code required
String Contains the unique ASCII code for this category.
    • label
String Contains the label for this category.
  • quantity
Integer The quantity of this room available in the accommodation
  • traveller_occupancy
Integer The occupancy of traveller’s allowed by this room.
  • max_occupancy
Integer The maximum allowable occupancy of this room.
phone_numbers Field The phone numbers for this accommodation dossier.
  • id read-only
String  
  • phone required
String The phone number for this phone
  • phone_type required
Nested Object  
    • code required
String The unique ASCII code for this type.
emails Field The email addresses for this accommodation dossier.
  • id read-only
String  
  • email required
String The email address for this contact
  • email_type required
Nested Object  
    • code required
String The unique ASCII code for this type.
categories Field List of categories this activity falls under
  • id read-only
String  
  • href read-only
Field  
  • name required
String  
  • category_type read-only
Reference Object Parent category, can be null
images Field Images associated with this accommodation
videos Field Videos associated with this accommodation
costs Field List of costs associated with this service.
  • id read-only
String  
  • href read-only
Field  
  • type
String The type of this resource.
service_time Time The start time of the service
is_prepaid Boolean Used by Finance to determine whether or not a service is partially or fully paid beforehand
show_on_reservation_sheet Boolean Used by Local Operations to determine whether or not a service shows up on the reservation sheet sent to Suppliers.
flags List List of generic flags applied to this dossier
suggested_dossiers Field List of suggested dossiers for when this dossier is used on an itinerary
visited_countries Field List of countries visited in this dossier
visited_cities Field List of cities visited in this dossier
has_costs read-only Boolean Shows if the accommodation service has any related costs
has_summary read-only Boolean Shows if the accommodation service has a summary

Get an Activity Dossier

GET /accommodation_dossiers/(string: accommodation_dossier_id)