API Documentation

1. Overview
The iVectorOne API allows customers to integrate with a large number of different suppliers via a single
API.

1.1 Content
There are two calls to support property content retrieval:

Property List
This call will return a list of all properties in the system for the requested supplier.

Property Details
This call will return the full content details for the specified properties.

1.2 Search and Book

There are four calls to support the search and book capabilities as follows:

Search
This call takes a list of property identifiers and will return all available results with a total cost.
These results will contain booking tokens that must be passed into the pre-book call

Prebook
This request accepts a booking token from the search response and will confirm the availability
and cost of a single property result. The result will include a booking token that must be passed
into the book call.

Book
This request accepts a booking token from the pre-book response and will book the requested
property result. It will return a booking reference if successful.

Cancel
This request accepts a booking reference from the book response and will cancel a property
booking.
 API Documentation

2.1 Property List

Use this request to return a list of all properties. All fields are mandatory unless marked with a question
mark.

Request

GET[Base URL]/content/property/list

Query Parameter Data Type Description

suppliers String ? Optional comma-separated list of supplier names tolist
properties for. If blank all properties will be returned.
Optional parameter to filter properties to only those
lastmodified Date ?
modified after a certain date.

Response
Node Data Type Description

PropertyListResponse

Properties List ? The list of properties.

PropertyID Integer The unique identifier of the property. This can beused in the
GetPropertyContent call to get full content.

2.2 Property Content

Use this request for the full content for specified properties. Returns the content for every third
party supplier mapped to that property. All fields are mandatory unless marked with a question mark.

Request

GET[Base URL]/content/property

Parameter Data Type Description

propertyids String Comma-separated list of property ids to return contentfor.
This is limited to 1000 property ids per request for
performance reasons.
 API Documentation

Response

Parameter Data Type Description

PropertyContentResponse

Properties List ? The list of properties.

PropertyID Integer The unique identifier of the property.

TTICode string The TTI code identifying the property

SuppliersContent List A list of supplier-specific content for the property.

SupplierContent Single

PropertyName String The name of the property.

Address Single The property Address

AddressLine1 String The first line of the address

AddressLine2 String ? The second line of the address

TownOrCity String The town or city name

CountyOrState String ? The county or state name

PostCodeOrZip String The postcode or Zip code

Telephone String The telephone number

Geography Single

Country String The name of the country the property is in.

Region String The name of the region the property is in.
 API Documentation

Resort String The name of the resort the property is in.

Latitude Decimal The latitude of the property.

Longitude Decimal The longitude of the property.

Rating String The star rating of the property.

Supplier String The name of the supplier

Description String The description of the property

Facilities List ? A list of facilities that the property provides
Facility String The name of the facility
MainImageURL String The URL of the main image
Images List ?
A list of Image URLs
ImageURL String

3.1 Search

Use this request to return property results. All fields are mandatory unless marked with a question
mark.

Request

Get [Base URL]/property/search

The will require the following query string parameters:

 API Documentation

Parameter Data Type Description

ArrivalDate Date The first stay date.
Duration Integer
The length of the stay.
Properties Integer List
CSV of unique identifiers of the properties to search.
Rooms List Pipe separated room pax combinations
- (adults, children, infants~child ages)
- adults - integer, each room must have at least one
- children - integer
- Infants - integer
- Child ages - csv of integer, total must match # of
children and infants

E.g. rooms=(1,1,1~7,2)|(2,0,0)
-
Is a 2 room search
-
Room 1 - 1 Adult, 1 child, 1 infant, aged 7 and
- 2 Room 2 - 2 Adults

Example URI
/property/search?ArrivalDate=2021-06-06&duration=1&properties=1,2,5,100&rooms=(1,2,1~5,7,2)|(1,0,0)

Response

Parameter Data Type Description

PropertySearchResponse

PropertyResults List ?
The property search results.

PropertyResult Single

String Stores information needed to book the result. Mustbe

BookingToken
passed into the pre-book request.

PropertyID Integer
Unique property identifier.

RoomTypes List List of bookable room results.

 API Documentation

RoomType Single

Integer Unique identifier of the rooms in the order they were

RoomID
specified in the request.

String Stores information needed to book the room result. Must be

RoomBookingToken
passed into the pre-book request.

String Room Token returned from the third party. Must be passed
SupplierReference1
into the pre-book request

String
SupplierReference2 Room Token returned from the third party. Must be passed
into the pre-book request
Supplier String

The name of the supplier.

MealBasisCode String

Unique identifier of the meal basis.

RoomType String

The name of the room type.

SupplierRoomType String

The supplier’s name for the room type.

CurrencyCode String

The ISO code of the currency.

Decimal

TotalCost The total cost of the room.

Boolean

NonRefundable Determines whether the room is refundable.

List ?

CancellationTerms The cancellation terms for the room, if supported at search.

Single

CancellationTerm
Date
The start date of the cancellation policy.
StartDate
Date
The end date of the cancellation policy.

EndDate
Decimal The cancellation cost.
Amount
 API Documentation

3.2 Pre-book

Use this request to confirm availability and price for search results.

Request

POST[Base URL]/property/prebook

Parameter Data Type Description

PropertyPrebookRequest
BookingToken String
Taken from a property result in the property search response.
RoomBookings List
A list of room search results to pre-book.
RoomBooking Single

RoomBookingToken String
Taken from a room result in the property search response.
SupplierReference1 String
Taken from a room result in the property search response.
SupplierReference2 String Taken from a room result in the property search response.

Response
Parameter Data Type Description

PropertyPrebookResponse

BookingToken String Stores information needed to book the result. Must be passed
into the book request.

SupplierReference1 String Property level Token returned from the third party. Must be
passed into the book request if returned at prebook.

SupplierReference2 String Property level Token returned from the third party.
Must be passed into the book request if returned at prebook.

TotalCost Decimal
The total price of the property booking.

RoomBookings List

RoomBooking Single

Supplier String
The name of the supplier

TotalCost Decimal
The total cost for the room.

String Stores information needed to book the result. Must be passed

RoomBookingToken
into the book request.

Room level Token returned from the third party. Must be

SupplierReference String
passed into the book request
 API Documentation

CancellationTerms List ? cancellation terms for the property booking.

CancellationTerm Single

StartDate Date start date of the cancellation

EndDate Date policy. end date of the cancellation

Amount Decimal policy. cancellation cost.

Errata List ?

Erratum String ny notes relevant to the customer before booking(eg.

regional taxes apply, facilities not available, etc)

3.3 Book

Use this request to finalise the booking.

Request

POST [Base URL]/property/book

 API Documentation

Parameter Data Type Description

PropertyBookRequest
BookingToken String
Taken from the property pre-book response

String Unique reference to be passed to the third party to identify

BookingReference
the booking in their system (if supported)

String Taken from the property pre-book response, must be passed

SupplierReference1
in if returned at pre-book.
String Taken from the property pre-book response, must be passed
SupplierReference2
in if returned at pre-book.
RoomBookings List
A list of room pre-book results to book
RoomBooking Single

RoomBookingToken String
Taken from a room result in the property search response

SupplierReference String
Taken from the property pre-book response

GuestDetails List
The details of all the guests on the booking

GuestDetail Single

String
Must be one of “Adult”, “Child” or “Infant”
Type
String
The guest’s title, eg. Mr, Mrs.
Title
String
The guest’s first name.
FirstName
String
The guest’s last name.
LastName
Date
The guest’s date of birth.
DateOfBirth
Single
The details of the lead customer
LeadCustomer
String

CustomerTitle
String

CustomerFirstName
String

CustomerLastName
Date

DateOfBirth
String

CustomerAddress1
String ?
CustomerAddress2 String

CustomerTownCity String
CustomerCounty
 API Documentation

CustomerPostcode
String

CustomerBookingCountryCode
String
ISO Alpha-2 code
CustomerPhone
String

CustomerMobile String

CustomerEmail String

Response

Parameter Data Type Description

PropertyBookResponse

SupplierBookingReference String The supplier’s unique identifier of the booking.

SupplierReference1 Token returned from the third party. Must be passed into the
String cancel request if returned at book.

SupplierReference2 Token returned from the third party. Must be passed into the
String
cancel request if returned at book.

BookingToken String Stores information needed to book the result. Must be passed
into the book request.

3.4. Cancel

Use this request to retrieve details of a booking.

Request

POST [Base URL]/property/cancel

 API Documentation

Parameter Data Type Description

CancelPropertyBookingRequest

SupplierBookingReference String The supplier’s booking reference returned in the property

book response

String Token returned from the third party. Must be passed into the
SupplierReference1
cancel request if returned at book.

String Token returned from the third party. Must be passed into the
SupplierReference2
cancel request if returned at book.

String Stores information needed to book the result. Must be

BookingToken
passed into the book request.

Response

Parameter Data Type Description

CancelPropertyBookingResponse

SupplierCancellationReference String The supplier’s unique reference for the cancellation.

4. API Technical Details

Each API call has its own REST path relative to the base Url, eg. [Base Url]/property/search.

A call to retrieve data, such as the property list function will use the GET method, whereas a call to
execute a function will use the POST method.

The REST paths and Http verbs required for each call are detailed in the request sections above.

The API accepts and returns content in XML or JSON. To choose between these pass the values
application/xml or application/json in the Accept and Content-Type headers in the request.

The API uses BASIC Authentication, integrators will be provided with credentials separately.

The API will return one of the following response codes:

●200 - The request was processed successfully
●400 - The request was invalid (eg. a mandatory field was not provided)
●401 - The request was not authorised
●405 - The request used the incorrect Http verb for the call
●500 - An internal error occurred during the processing of the request