Interfaccia BookingFor Backend API - per la comunicazione con bookingfor.com Ver. 4.0 - NET
←
→
Trascrizione del contenuto della pagina
Se il tuo browser non visualizza correttamente la pagina, ti preghiamo di leggere il contenuto della pagina quaggiù
Interfaccia BookingFor
Backend API
per la comunicazione con bookingfor.com
Ver. 4.0
Pagina: 1
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comSommario
Sommario 2
DATI DEL PROGETTO 3
DATI DEL DOCUMENTO 3
REVISIONI 3
Premessa 5
Set up: 6
Elenco metodi disponibili: 6
GetResources ............................................................................................................................................. 6
SetResources ............................................................................................................................................. 7
DeleteResources ........................................................................................................................................ 8
GetResourceProductCategories ................................................................................................................ 8
GetGeographicZones ................................................................................................................................. 9
GetGroupingResources............................................................................................................................ 10
SetGroupingResources ............................................................................................................................ 10
DeleteGroupingResources ....................................................................................................................... 11
GetAvailableTags ..................................................................................................................................... 12
GetPolicies ............................................................................................................................................... 13
GetRateCategories................................................................................................................................... 13
GetPOICategories .................................................................................................................................... 14
GetReservations ...................................................................................................................................... 15
SetReservations ....................................................................................................................................... 16
GetReservationPayments ........................................................................................................................ 16
GetReservationRegistries ........................................................................................................................ 17
SetReservationRegistries ......................................................................................................................... 18
GetVariationPlans .................................................................................................................................... 18
SetVariationPlans..................................................................................................................................... 19
DeleteVariationPlans ............................................................................................................................... 20
GetMerchantConfiguration ..................................................................................................................... 20
Legenda campi 22
Appendice 22
Limitazione utilizzo servizi 61
Pagina: 2
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comDATI DEL PROGETTO
Sito Internet: www.bookingfor.com
Proprietario: Ipertrade srl
Mantainer:
DATI DEL DOCUMENTO
Tipo Documento BookingFor Backend API
Redatto da: Marco Slanzi
Data di approvazione 03/2016
Data di emissione 03/2016
REVISIONI
Revisione n° 01 Data Revisione 07/2017
Descrizione Bugfix vari
modifiche
Motivazioni
Revisione n° 02 Data Revisione 10/2017
Descrizione Allineamento servizio con BookingFor 7.2.2
modifiche
Motivazioni
Revisione n° 03 Data Revisione 02/2021
Descrizione Allineamento servizio con BookingFor 8.2.0
modifiche
Pagina: 3
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comMotivazioni
Pagina: 4
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comPremessa
Seguiranno delle note tecniche per l’utilizzo di BookingFor Backend API riservato alle
software house che intendono sincronizzare i dati dei propri Channel Manager o PMS con
il sistema di booking denominato BookingFor.
Il sistema è basato su comunicazioni tramite il protocollo SOAP e la struttura dati è
proprietaria.
Per qualsiasi informazione: developer@ipertrade.com
Pagina: 5
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comSet up:
Per attivare l'interfaccia BookingFor Backend API sono necessari i seguenti parametri:
• Login: identificativo dell’utente
• Password: password dell’utente
• MerchantId: codice dell’esercente
Elenco metodi disponibili:
GetResources
Il messaggio GetResources viene utilizzato per avere la lista delle risorse disponibili di un
merchant. Sarà previsto solo il recupero di codici mappatura, nome di default e categorie
tariffarie associate alla risorsa
RICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Message 1 Messaggio
Message/Authentication
Login 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del
merchant
Message/Request 1
GetOnlySelected 1 Se valorizzato a true,
recupera solo le
risorse con i
riferimenti specificati
su RefIds
Message/Request/Refids 1-n Array di stringhe
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
GetResourcesResult 1 Array di oggetti di tipo ResourceObject
(ogni nodo è definito come Result):
vedi Appendice per vedere la struttura
dell’oggetto
Success 1 Se valorizzato a true, la richiesta è
andata a buon fine
Pagina: 6
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comFailureReaso 1 Se la richiesta non è andata a buon
n fine, verrà specificato il motivo del
fallimento.
SetResources
Il messaggio SetResources viene utilizzato per aggiornare, aggiungere o inserire da zero
le risorse per il merchant. L’operazione avrà comportamenti diversi a secondi di alcuni
parametri che si possono specificare nel messaggio
RICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Message 1 Messaggio
Message/Authentication
Login 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del
merchant
Message/Request 1
InsertOnly 1 Se valorizzato a true,
effettuerà solo
l’inserimento delle
risorse e non la
modifica delle
esistenti
UpdateOnly 1 Se valorizzato a true,
effettuerà solo
l’aggiornamento delle
risorse esistenti e non
l’inserimento delle
nuove
InsertBulk 1 Se valorizzato a true,
effettua un
reinserimento totale
dei dati inoltrati e
cancella TUTTE le
risorse esistenti
Message/Request/Items 1-n Array di oggetti di tipo
ResourceObject (ogni
nodo è definito come
ResourceObject):
vedi Appendice per
vedere la struttura
dell’oggetto
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Pagina: 7
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comSetResourcesResult 1 Restituisce il numero totale di record
inseriti/aggiornati
Success 1 Se valorizzato a true, la richiesta è
andata a buon fine
FailureReaso 1 Se la richiesta non è andata a buon
n fine, verrà specificato il motivo del
fallimento.
DeleteResources
Il messaggio DeleteResources viene utilizzato per eliminare le risorse specificate per il
merchant.
RICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Message 1 Messaggio
Message/Authentication
Login 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del
merchant
Message/Request 1
Message/Request/Refids 1-n Array di stringhe
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
DeleteResourcesResult 1 Restituisce il numero totale di record
inseriti/aggiornati
Success 1 Se valorizzato a true, la richiesta è
andata a buon fine
FailureReaso 1 Se la richiesta non è andata a buon
n fine, verrà specificato il motivo del
fallimento.
GetResourceProductCategories
Recupera le categorie disponibili da utilizzare per il campo MainCategoryId della risorsa.
RICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Message 1 Messaggio
Message/Authentication
Login 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del
merchant
Pagina: 8
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comMessage/Request 1
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
GetResourceProductCategoriesResult 1 Array di oggetti di tipo CategoryObject
(ogni nodo è definito come Result):
vedi Appendice per vedere la struttura
dell’oggetto
Success 1 Se valorizzato a true, la richiesta è
andata a buon fine
FailureReaso 1 Se la richiesta non è andata a buon
n fine, verrà specificato il motivo del
fallimento.
GetGeographicZones
Recupera le categorie disponibili da utilizzare per il campo Zones di risorsa e gruppi di
risorse.
RICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Message 1 Messaggio
Message/Authentication
Login 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del
merchant
Message/Request 1
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
GetResourceProductCategoriesResult 1 Array di oggetti di tipo
GeographicZoneObject (ogni nodo è
definito come Result): vedi Appendice
per vedere la struttura dell’oggetto
Success 1 Se valorizzato a true, la richiesta è
andata a buon fine
FailureReaso 1 Se la richiesta non è andata a buon
n fine, verrà specificato il motivo del
fallimento.
Pagina: 9
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comGetGroupingResources
Il messaggio GetGroupingResources viene utilizzato per avere la lista dei gruppi di risorse
disponibili di un merchant. Sarà previsto solo il recupero di codici mappatura, nome di
default e categorie tariffarie associate alla risorsa
RICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Message 1 Messaggio
Message/Authentication
Login 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del
merchant
Message/Request 1
GetOnlySelected 1 Se valorizzato a true,
recupera solo le
risorse con i
riferimenti specificati
su RefIds
Message/Request/Refids 1-n Array di stringhe
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
GetGroupingResourcesResult 1 Array di oggetti di tipo
GroupingResourceObject (ogni nodo è
definito come Result): vedi Appendice
per vedere la struttura dell’oggetto
Success 1 Se valorizzato a true, la richiesta è
andata a buon fine
FailureReaso 1 Se la richiesta non è andata a buon
n fine, verrà specificato il motivo del
fallimento.
SetGroupingResources
Il messaggio SetGroupingResources viene utilizzato per aggiornare, aggiungere o inserire
da zero i gruppi di risorse per il merchant. L’operazione avrà comportamenti diversi a
secondi di alcuni parametri che si possono specificare nel messaggio
RICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Pagina: 10
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comMessage 1 Messaggio
Message/Authentication
Login 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del
merchant
Message/Request 1
InsertOnly 1 Se valorizzato a true,
effettuerà solo
l’inserimento delle
risorse e non la
modifica delle
esistenti
UpdateOnly 1 Se valorizzato a true,
effettuerà solo
l’aggiornamento delle
risorse esistenti e non
l’inserimento delle
nuove
InsertBulk 1 Se valorizzato a true,
effettua un
reinserimento totale
dei dati inoltrati e
cancella TUTTE le
risorse esistenti
Message/Request/Items 1-n Array di oggetti di tipo
GroupingResourceOb
ject (ogni nodo è
definito come
GroupingResourceOb
ject): vedi Appendice
per vedere la
struttura dell’oggetto
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
SetResourcesResult 1 Restituisce il numero totale di record
inseriti/aggiornati
Success 1 Se valorizzato a true, la richiesta è
andata a buon fine
FailureReaso 1 Se la richiesta non è andata a buon
n fine, verrà specificato il motivo del
fallimento.
DeleteGroupingResources
Il messaggio DeleteGroupingResources viene utilizzato per eliminare i gruppi di risorse
specificati per il merchant.
Pagina: 11
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comRICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Message 1 Messaggio
Message/Authentication
Login 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del
merchant
Message/Request 1
Message/Request/Refids 1-n Array di stringhe
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
DeleteResourcesResult 1 Restituisce il numero totale di record
inseriti/aggiornati
Success 1 Se valorizzato a true, la richiesta è
andata a buon fine
FailureReaso 1 Se la richiesta non è andata a buon
n fine, verrà specificato il motivo del
fallimento.
GetAvailableTags
Recupera i servizi descrittivi disponibili: da utilizzare per il campo Tags della risorsa.
RICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Message 1 Messaggio
Message/Authentication
Login 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del
merchant
Message/Request 1
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
GetAvailableTagsResult 1 Array di oggetti di tipo TagObject (ogni
nodo è definito come Result): vedi
Pagina: 12
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comAppendice per vedere la struttura
dell’oggetto
Success 1 Se valorizzato a true, la richiesta è
andata a buon fine
FailureReaso 1 Se la richiesta non è andata a buon
n fine, verrà specificato il motivo del
fallimento.
GetPolicies
Recupera i servizi descrittivi disponibili: da utilizzare per il campo PolicyId della risorsa.
RICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Message 1 Messaggio
Message/Authentication
Login 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del
merchant
Message/Request 1
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
GetPoliciesResult 1 Array di oggetti di tipo PolicyObject
(ogni nodo è definito come Result):
vedi Appendice per vedere la struttura
dell’oggetto
Success 1 Se valorizzato a true, la richiesta è
andata a buon fine
FailureReaso 1 Se la richiesta non è andata a buon
n fine, verrà specificato il motivo del
fallimento.
GetRateCategories
Recupera le categorie tariffarie disponibili: da utilizzare per il campo RateCategoryRefId
dei prezzi di una risorsa.
RICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Message 1 Messaggio
Message/Authentication
Pagina: 13
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comLogin 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del
merchant
Message/Request 1
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
GetPoliciesResult 1 Array di oggetti di tipo PolicyObject
(ogni nodo è definito come Result):
vedi Appendice per vedere la struttura
dell’oggetto
Success 1 Se valorizzato a true, la richiesta è
andata a buon fine
FailureReaso 1 Se la richiesta non è andata a buon
n fine, verrà specificato il motivo del
fallimento.
GetPOICategories
Recupera le categorie di Punti di interesse inserite nella sottoscrizione: da utilizzare per il
campo CategoryId sui vari punti per esperienze.
RICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Message 1 Messaggio
Message/Authentication
Login 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del
merchant
Message/Request 1
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
GetPoliciesResult 1 Array di oggetti di tipo
POICategoryObject (ogni nodo è
definito come Result): vedi Appendice
per vedere la struttura dell’oggetto
Success 1 Se valorizzato a true, la richiesta è
andata a buon fine
FailureReaso 1 Se la richiesta non è andata a buon
n fine, verrà specificato il motivo del
fallimento.
Pagina: 14
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comGetReservations
Il messaggio GetReservations viene utilizzato per avere la lista delle prenotazioni
registrate e/o create su BookingFor, comprensivo di eventuali prezzi inclusi nel preventivo
effettuato.
RICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Message 1 Messaggio
Message/Authentication
Login 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del merchant
Message/Request 1
Message/Request/StartDate 1 Data di inizio del controllo
Message/Request/EndDate 1 Data di fine del controllo
Message/Request/DateType 1 Tipologia di controllo per le date. Possibili
valori:
CreationDate: data di creazione della
prenotazione
ArrivalDate: data di inizio vacanza
DepartureDate: data di fine vacanza
LastUpdateDate: data ultimo aggiornamento
dati
Message/Request/StatusType 1 Tipologia di controllo per lo stato della
prenotazione.
Possibili valori:
All: tutte
New: solo le nuove
Canceled: solo le cancellate
Confirmed: solo le confermate
Message/Request/FlagRetrievedAsExported 1 Se non viene specificato nella richiesta o è
impostato a true, la prenotazione alla lettura
non sarà più letta nelle successive riletture in
questa richiesta.
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO ELEMENTI DESCRIZIONE
GetReservationsResult 1 Array di oggetti di tipo Reservation (ogni
nodo è definito come Result): vedi
Appendice per vedere la struttura
dell’oggetto
Success 1 Se valorizzato a true, la richiesta è andata a
buon fine
FailureReason 1 Se la richiesta non è andata a buon fine,
verrà specificato il motivo del fallimento.
Pagina: 15
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comSetReservations
Il messaggio SetReservations viene utilizzato per inserire su BookingFor prenotazioni, che
saranno visibili nella sezione “Prenotazioni e richieste”. Purché una prenotazione sia
valida, devono essere specificati almeno l’indirizzo e-mail del contatto, il totale, periodo
della vacanza e persone all’interno del preventivo correlato. In questo caso, il parametro di
tipologia dell’operazione InsertBulk non sarà utilizzato.
RICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Message 1 Messaggio
Message/Authentication
Login 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del merchant
Message/Request 1
InsertOnly 1 Se valorizzato a true, effettuerà solo l’inserimento
delle prenotazioni e non la modifica delle esistenti
UpdateOnly 1 Se valorizzato a true, effettuerà solo
l’aggiornamento delle prenotazioni esistenti e non
l’inserimento delle nuove
Message/Request/Items 1-n Array di oggetti di tipo Reservation (ogni nodo è
definito come Reservation): vedi Appendice per
vedere la struttura dell’oggetto
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
SetreservationsResult 1 Restituisce il numero totale di record
inseriti/aggiornati
Success 1 Se valorizzato a true, la richiesta è
andata a buon fine
FailureReason 1 Se la richiesta non è andata a buon
fine, verrà specificato il motivo del
fallimento.
GetReservationPayments
Il messaggio GetReservationPayments viene utilizzato per avere la lista di tutti i pagamenti
registrati e/o creati su BookingFor e non ancora recuperati in precedenti chiamate. Una
volta recuperati, non saranno più selezionabili nelle future chiamate.
RICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Message 1 Messaggio
Pagina: 16
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comMessage/Authentication
Login 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del merchant
Message/Request 1
GetOnlySelected 1 Se valorizzato a true, recupera solo i
pagamenti relazionati alle prenotazioni con i
riferimenti specificati su RefIds
Message/Request/Refids 1-n Array di stringhe
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
GetReservationPaymentsResult 1 Array di oggetti di tipo ReservationPayment (ogni nodo
è definito come Result): vedi Appendice per vedere la
struttura dell’oggetto
Success 1 Se valorizzato a true, la richiesta è andata a buon fine
FailureReason 1 Se la richiesta non è andata a buon fine, verrà
specificato il motivo del fallimento.
GetReservationRegistries
Il messaggio GetReservationRegistries viene utilizzato per avere la lista di tutte le
anagrafiche registrate e/o create su BookingFor e non ancora recuperate in precedenti
chiamate. Una volta recuperate, non saranno più selezionabili nelle future chiamate.
RICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Message 1 Messaggio
Message/Authentication
Login 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del merchant
Message/Request 1
GetOnlySelected 1 Se valorizzato a true, recupera solo le anagrafiche
relazionate alle prenotazioni con i riferimenti
specificati su RefIds
Message/Request/Refids 1-n Array di stringhe
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
GetReservationRegistriesResult 1 Array di oggetti di tipo ReservationRegistry (ogni nodo
è definito come Result): vedi Appendice per vedere la
struttura dell’oggetto
Success 1 Se valorizzato a true, la richiesta è andata a buon fine
Pagina: 17
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comFailureReason 1 Se la richiesta non è andata a buon fine, verrà
specificato il motivo del fallimento.
SetReservationRegistries
Il messaggio SetReservationRegistries viene utilizzato per inserire su BookingFor le
anagrafiche di una prenotazione. L’anagrafica principale per la prenotazione deve avere
almeno l’e-mail, nome, cognome, data di nascita e dati del documento validi. In questo
caso, il parametro di tipologia dell’operazione InsertBulk non sarà utilizzato.
RICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Message 1 Messaggio
Message/Authentication
Login 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del merchant
Message/Request 1
InsertOnly 1 Se valorizzato a true, effettuerà solo l’inserimento
delle prenotazioni e non la modifica delle esistenti
UpdateOnly 1 Se valorizzato a true, effettuerà solo
l’aggiornamento delle prenotazioni esistenti e non
l’inserimento delle nuove
Message/Request/Items 1-n Array di oggetti di tipo ReservationRegistry (ogni
nodo è definito come ReservationRegistry): vedi
Appendice per vedere la struttura dell’oggetto
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
SetReservationRegistriesResult 1 Restituisce il numero totale di record
inseriti/aggiornati
Success 1 Se valorizzato a true, la richiesta è
andata a buon fine
FailureReason 1 Se la richiesta non è andata a buon
fine, verrà specificato il motivo del
fallimento.
GetVariationPlans
Il messaggio GetVariationPlans viene utilizzato per recuperare la lista delle offerte
disponibili di un merchant, comprensivo di traduzioni localizzate (a seconda delle lingue
disponibili nella sottoscrizione), foto e regole di applicazione.
Pagina: 18
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comRICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Message 1 Messaggio
Message/Authentication
Login 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del
merchant
Message/Request 1
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
GetVariationPlansResult 1 Array di oggetti di tipo VariationPlan
(ogni nodo è definito come Result):
vedi Appendice per vedere la struttura
dell’oggetto
Success 1 Se valorizzato a true, la richiesta è
andata a buon fine
FailureReason 1 Se la richiesta non è andata a buon
fine, verrà specificato il motivo del
fallimento.
SetVariationPlans
Il messaggio SetVariationPlans viene utilizzato per aggiornare, aggiungere o inserire da
zero le offerte per il merchant. L’operazione avrà comportamenti diversi a secondi di alcuni
parametri che si possono specificare nel messaggio.
RICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Message 1 Messaggio
Message/Authentication
Login 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del merchant
Message/Request 1
InsertOnly 1 Se valorizzato a true, effettuerà solo l’inserimento
delle offerte e non la modifica delle esistenti
UpdateOnly 1 Se valorizzato a true, effettuerà solo
l’aggiornamento delle offerte esistenti e non
l’inserimento delle nuove
InsertBulk 1 Se valorizzato a true, effettua un
reinserimento totale dei dati inoltrati e
cancella TUTTE le offerte esistenti
Pagina: 19
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comMessage/Request/Items 1-n Array di oggetti di tipo VariationPlan (ogni nodo è
definito come VariationPlan): vedi Appendice per
vedere la struttura dell’oggetto
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
SetReservationRegistriesResult 1 Restituisce il numero totale di record
inseriti/aggiornati
Success 1 Se valorizzato a true, la richiesta è
andata a buon fine
FailureReason 1 Se la richiesta non è andata a buon
fine, verrà specificato il motivo del
fallimento.
DeleteVariationPlans
Il messaggio DeleteVariationPlans viene utilizzato per eliminare le offerte specificate per il
merchant.
RICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Message 1 Messaggio
Message/Authentication
Login 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del
merchant
Message/Request 1
Message/Request/Refids 1-n Array di stringhe
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
DeleteResourcesResult 1 Restituisce il numero totale di record
inseriti/aggiornati
Success 1 Se valorizzato a true, la richiesta è
andata a buon fine
FailureReaso 1 Se la richiesta non è andata a buon
n fine, verrà specificato il motivo del
fallimento.
GetMerchantConfiguration
Il messaggio GetMerchantConfiguration viene utilizzato il recupero della configurazione
base del merchant.
Pagina: 20
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comRICHIESTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
Message 1 Messaggio
Message/Authentication
Login 1 Identificativo
Password 1 Password
MerchantId 1 Identificativo del
merchant
Message/Request 1
RISPOSTA
ELEMENTO ATTRIBUTO NUMERO DESCRIZIONE
ELEMENTI
GetMerchantConfigurationResult 1 Oggetto di tipo MerchantConfiguration
(vedi appendice per la definizione)
Success 1 Se valorizzato a true, la richiesta è
andata a buon fine
FailureReason 1 Se la richiesta non è andata a buon
fine, verrà specificato il motivo del
fallimento.
Pagina: 21
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comLegenda campi
EnergyClass
• 0: non impostato
• 1: Non classificabile
• 2: Immobile esente
• 3: in valutazione
• 100: A+
• 101: A
• 102: B
• 103: C
• 104: D
• 105: E
• 106: F
• 107: G
Appendice
RESOURCEOBJECT
Struttura base per recupero, inserimento/aggiornamento dei dati di una risorsa. In seguito,
la definizione della classe.
ELEMENTO TIPO NUMER DESCRIZIONE
O
ELEMEN
TI
RefId String 1 Sarà utilizzato questo parametro per il
recupero/aggiornamento/eliminazione
delle risorse e deve essere univoco
per lo stesso merchant
Weight int 1 Priorità della risorsa (utilizzato
nell’ordinamento delle risorse nelle
liste) in ordine ascendente
Enabled Boolean 1 Se valorizzato a true, la risorsa sarà
visibile nell’area pubblica
MainCategoryId Int 0-1 Categoria di appartenenza della
risorsa (per il recupero vedi
GetResourceProductCategories)
Names TranslationObject 0-n Array di oggetti di tipo
TranslationObject (vedi Appendice per
la definizione della classe):
definiscono le traduzioni disponibili per
il nome
Descriptions TranslationObject 0-n Array di oggetti di tipo
TranslationObject (vedi Appendice per
Pagina: 22
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comla definizione della classe):
definiscono le traduzioni disponibili per
la descrizione
Inclusions TranslationObject 0-n Array di oggetti di tipo
TranslationObject (vedi Appendice per
la definizione della classe):
definiscono le traduzioni disponibili per
descrivere cosa è incluso nella risorsa
Exclusions TranslationObject 0-n Array di oggetti di tipo
TranslationObject (vedi Appendice per
la definizione della classe):
definiscono le traduzioni per
descrivere cosa non è incluso nella
risorsa
WhatToKnow TranslationObject 0-n Array di oggetti di tipo
TranslationObject (vedi Appendice per
la definizione della classe):
definiscono le traduzioni per
descrivere cosa portarsi dietro (utile
per esperienze/tours)
WhatToBring TranslationObject 0-n Array di oggetti di tipo
TranslationObject (vedi Appendice per
la definizione della classe):
definiscono le traduzioni per
descrivere cosa dire al cliente prima
della prenotazione
Area Decimal 0-1 Definisce l’area della risorsa in metri
quadri
Address String 1 Definisce l’indirizzo di ubicazione della
risorsa
StateId Int 0-1 Codice di riferimento dello stato della
risorsa. Per il codice corretto, fai
riferimento a
http://www.geonames.org/
RegionId Int 0-1 Codice di riferimento della
regione/stato federale della risorsa.
Per il codice corretto, fai riferimento a
http://www.geonames.org/
CityId Int 0-1 Codice di riferimento della città della
risorsa. Per il codice corretto, fai
riferimento a
http://www.geonames.org/
XPos String 1 Latitudine della posizione della risorsa
in valori decimali +-90
YPos String 1 Longitudine della posizione della
risorsa in valori decimali +-180
CityCenterDistance Int 1 Distanza in metri dal centro della città
Zones int 0-1 Array di zone sottocrizione (per il
recupero vedi GetGeographicZones)
GetMerchantAddress Bool 1 Se impostato a sì, viene utilizzato in
automatico l’indirizzo del merchant. In
questo caso, non è necessario
Pagina: 23
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comspecificare tutte le informazioni
geografiche della risorsa
GetResourceGroupAddress Bool 1 Se impostato a sì, viene utilizzato in
automatico l’indirizzo del gruppo di
risorse. In questo caso, non è
necessario specificare tutte le
informazioni geografiche della risorsa
IsLimitedPaxes Boolean 1 Se valorizzato a true, la risorsa è
limitata per un minimo e massimo di
persone.
MinPaxes Int 1 Numero minimo di persone nella
risorsa. Questo parametro sarà
influente nei parametri di ricerca.
MaxPaxes Int 1 Numero massimo di persone nella
risorsa. Questo parametro sarà
influente nei parametri di ricerca.
Rating Int 1 Valutazione della risorsa compresi tra
0e5
DefaultImage String 1 url completo dell’immagine principale.
Questo parametro sarà utilizzato solo
su GetResources.
Gallery ImageObject 0-n Array di oggetti di tipo ImageObject
(vedi Appendice per la definizione
della classe): definiscono le immagini
disponibili per la fotogallery principale
Videos ImageObject 0-n Array di oggetti di tipo ImageObject
(vedi Appendice per la definizione
della classe): definiscono i video
associati alla risorsa (campo Value url
YouTube)
ParentRefId String 1 Codice di riferimento del prodotto di
cui è “figlio” (per esempio una
struttura): sarà valorizzato solo se
anche la sottoscrizione ha il supporto
per le strutture
EnergyClass Int 1 Valore della classe energetica della
risorsa (vedi Legenda Campi per i
possibili valori)
EpiValue Decimal 1 Definisce il valore del parametro IPE
della risorsa (l’unità di misura è
specificata nei campi EpiUnit)
EpiUnit String 1 Unità di misura dei parametri IPE di
una risorsa. Possibili valori: KWh/mq,
KWh/mc
AddedOn DateTime 1 Data di inserimento della risorsa (da
API o direttamente da backoffice):
sarà utilizzato solo su GetResources
Tags Int 0-n Array di identificativi dei tag associati
alla risorsa (per il recupero vedi
GetAvailableTags)
Floor Int 1 Piano della risorsa (descrittivo)
Pagina: 24
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comIsIndependent Boolean 1 Se valorizzato a true, la risorsa può
essere acquistata/prenotata in
maniera indipendente. Se valorizzato
a false, può essere acquistata solo
come servizio aggiuntivo di un’altra
risorsa
MinQt Int 1 Quantità minima acquistabile:
utilizzata solo se la risorsa è
indipendente. Se maggiore di 0, la
risorsa sarà obbligatoria
MaxQt Int 1 Quantità minima acquistabile:
utilizzata solo se la risorsa è
indipendente. Se equivalente a MinQt,
la risorsa sarà inclusa e quindi non
visualizzabile tra i servizi aggiuntivi
IsCatalog Boolean 1 Se valorizzato a true, non saranno
gestiti prezzi, disponibilità e restrizioni.
Sarà possibile solo una richiesta
informazioni
HasBindingProducts Boolean 1 Se valorizzato a true, la risorsa è
associata ad altre risorse dello stesso
merchant.
BindingProducts String 0-n Array di codici riferimento di risorse
associate alla risorsa; nel caso di una
risorsa dipendente, vengono
specificate le risorse indipendenti
(come servizio aggiuntivo etc…)
IsRequired Boolean 1 Valido solo per le risorse dipendenti.
Se valorizzato a true, la risorsa è
obbligatoria o inclusa
TimeLength Int 1 Unità di misura della risorsa ad ora (in
minuti)
TimeFixedLength Int 0-1 Lunghezza fissa de unità temporali
(valido solo per risorse a ora). Se
specificato, sovrascriverà i valori di
durata nelle restrizioni
AvailabilityType Int 1 Tipologia della disponibilità della
risorsa. Può essere impostata solo alla
creazione
Valori possibili:
0) Giorno
1) Notte
2) Ora
3) Slot temporali
ItemType Int 1 Tipologia della risorsa. Valori possibili:
0) Alloggio
1) Servizio generico
2) Pacchetto base
3) Servizio noleggio
4) Servizio posto
geolocalizzato
5) Servizio posto spiaggia
Pagina: 25
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.com6) Esperienza
TouristTaxValue String 1 Valore della tassa di soggiorno. Se
vuoto, non è inclusa nel prezzo
VATValue String 1 Valore dell’imposta di valuta applicata
al prezzo. Se vuoto, non è inclusa nel
prezzo
MaxAdultsOccupancy Int 0-1 Numero massimo di adulti per cui la
risorsa può essere prenotata. Per la
distinzione tra adulto, bambino e
seniors, vedi AgeCategories
MaxChildrenOccupancy Int 0-1 Numero massimo di bambini/seniors
per cui la risorsa può essere
prenotata. Per la distinzione tra adulto,
bambino e seniors, vedi
AgeCategories
ManageAvailability Boolean 1 Se valorizzato a true, la disponibilità
dovrà essere gestita ed allineata.
Se valorizzato a false, non sarà
necessario gestire la disponibilità
(sarà sempre disponibile)
IsVirtualProduct Boolean 1 Definisce se la risorsa è virtuale, nel
senso che non avrà una sua
disponibilità e dovrà dipendere da
un’altra (vedi campo
VirtualParentRefId)
VirtualParentRefId String 1 Codice di riferimento della risorsa cui
dovrà derivare la disponibilità
TimeSlots ResourceTimeSlot 0-n Array di oggetti di tipo
ResourceTimeSlot (vedi Appendice
per la definizione della classe):
definiscono gli slot temporali
disponibili della risorsa (se li supporta)
CheckFullPeriod Boolean 1 Se valorizzato a True, nelle ricerche
controlla tutta la disponibilità richiesta
Se valorizzato a False, nelle ricerche
disponibilità viene recuperato il primo
periodo
HasFixedStay Boolean 1 Se valorizzato a True, la risorsa è
valida per una durata fissa
FixedStay Int 1 Se HasFixedStay valorizzato a True,
la durata della risorsa
StayType Int 1 Tipologia di applicazione delle
restrizioni. Valori possibili:
-1) Nessuna condizione
(sempre valido)
0) Minimum stay arrival: tiene
conto della regola valida per
il giorno di arrivo
1) Minimum stay through: tiene
conto di tutte le regole
incluse nel periodo di
Pagina: 26
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.compermanenza, applicando i
valori più restrittivi
Stays ResourceStayObject 0-n Array di oggetti di tipo
ResourceStayObject (vedi Appendice
per la definizione della classe):
definiscono le restrizioni applicate alla
risorsa
AvailabilityQtType Int 1 Tipo di disponibilità
0) Per risorsa
1) Per persona
LinkedAvailability Boolean 1 Se valorizzato a True, la disponibilità è
legata ad altre risorse, sia in fase di
controllo sia in fasce di modifica (solo
da prenotazioni)
LinkedAvailabilityResources String 0-n Array di codici riferimento di risorse
con la disponibilità legata
Quotations RatePlan 0-n Array di oggetti di tipo RatePlan (vedi
Appendice per la definizione della
classe): definiscono i prezzi e le
categorie tariffarie applicate alla
risorsa
AgeCategories AgeCategory 0-n Array di oggetti di tipo AgeCategory
(vedi Appendice per la definizione
della classe): definiscono le fasce
d’età presenti nella risorsa
CalculationType Int 1 Tipologia di calcolo risorsa. Valori
possibili:
0) Risorsa
1) Persona
2) Risorsa più persona
3) Persona (derivata)
4) Risorsa più persona
variabile
PayingFullPaxes Int 1 Definisce il numero di persone che
devono pagare la quota intera
IncludedPaxesType Int 1 Specifica tipo di il numero di persone
incluse nel prezzo risorsa (escluse
tipologie di calcolo “Risorsa”,
“Persona” e “Risorsa più persona”.
Valori possibili:
0) Massima occupazione della
risorsa
1) Minima occupazione della
risorsa
2) Massima occupazione della
singola categoria tariffaria
associata
3) Minima occupazione della
singola categoria tariffaria
associata
Pagina: 27
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.com4) Numero fisso risorsa
(riferimento IncludedPaxes)
5) Numero fisso categoria
tariffaria (riferimento
IncludedPaxes su singolo
Quotation)
IncludedPaxes Int 1 Se tipologia di calcolo equivale a
“Risorsa più persona”, “Persona
(derivata)” o “Risorsa più persona
variabile” specifica il numero di
persone incluso nel prezzo risorsa.
PriceValueSpan Int 1 Numero di giorni di cui il valore del
prezzo è associato
PriceDayReturn Int 1 Se il prezzo è valido per sette giorni
(una settimana), specifica il giorno in
cui il prezzo “comincia” il conteggio
PricesPerStay Bool 1 Se impostato a True, la risorsa utilizza
prezzi diversi a seconda della durata
prenotazione (no risorse a slot
temporali). Vedi
PricesPerStayConfiguration per la
configurazione
PricesPerPax Bool 1 Se impostato a True, la risorsa utilizza
prezzi diversi per occupazione/numero
persone. Vedi
PricesPerPaxConfiguration per la
configurazione
PricesPerPaxType Bool 1 Se impostato a True, la risorsa utilizza
prezzi diversi per tipo persone (es: 2
adulti, 1 adulto + 1 bambino 5-10
anni). In questo caso, è possibile
utilizzare solo il prezzo risorsa. Vedi
PricesPerPaxTypeConfiguration per la
configurazione
PricesPerTimeSlot Bool 1 Se impostato a True, la risorsa utilizza
prezzi diversi per fascia oraria (solo
risorse a slot temporali). Vedi
PricesPerTimeSlotConfiguration per la
configurazione
PricesPerStayConfiguration PriceStayRange 0-n Se PricesPerStay impostata a True,
definisce le fasce di prezzo per
soggiorno. Array di oggetti di tipo
PriceStayRange (vedi Appendice per
la definizione della classe)
PricesPerPaxConfiguration PricePaxRange 0-n Se PricesPerPax impostata a True,
definisce le fasce di prezzo per
soggiorno. Array di oggetti di tipo
PricePaxRange (vedi Appendice per la
definizione della classe)
PricesPerPaxTypeConfiguration PricePaxTypeRange 0-n Se PricesPerPaxType impostata a
True, definisce le fasce di prezzo per
soggiorno. Array di oggetti di tipo
Pagina: 28
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comPricePaxTypeRange (vedi Appendice
per la definizione della classe)
PricesPerTimeSlotConfiguration PriceTimeSlotRange 0-n Se PricesPerTimeSlot impostata a
True, definisce le fasce di prezzo per
soggiorno. Array di oggetti di tipo
PriceTimeSlotRange (vedi Appendice
per la definizione della classe)
AllowEmptyQuotation Boolean 1 Se valorizzato a True, la risorsa può
essere prenotata anche con prezzo a
0
MaxExtrabedQt Int 1 Quantità massima di extrabed
Vedi AgeConfguration per età
MaxCotsQt Int 1 Quantità massima di culle
Vedi AgeConfguration per età
ExtrabedAndCotsCheckType Int 1 Se impostato a 0, possono essere
selezionati solo extrabed o culle
Se impostato a 1, extrabed e culle
possono essere prenotate assieme
ExperienceLength Int 1 Durata dell’esperienza (in minuti)
NB. È solo un valore descrittivo
ExperienceHasLiveGuide Boolean 1 Se valorizzato a True, l’esperienza
fornisce una guida “umana” sul posto
ExperienceHasPaperGuide Boolean 1 Se valorizzato a True, l’esperienza
fornisce una guida cartacea sul posto
ExperienceHasAudioGuide Boolean 1 Se valorizzato a True, l’esperienza
fornisce una guida audio
ExperienceLiveGuideLanguages String 0-1 Se ExperienceHasLiveGuide
valorizzato a True lista di lingue
(codice ISO693-1) per la guida
“umana” sul posto
ExperiencePaperGuideLanguages String 0-1 Se ExperienceHasLiveGuide
valorizzato a True lista di lingue
(codice ISO693-1) per la guida
cartacea sul posto
ExperienceAudioGuideLanguages String 0-1 Se ExperienceHasLiveGuide
valorizzato a True lista di lingue
(codice ISO693-1) per la guida audio
ExperienceMeetingType Int 1 Tipologia di incontro per l’esperienza.
Possibili valori
0) Solo sul posto (vedi
ExperienceMeetingPoints)
1) Solo recupero tramite
servizio di pick-up (vedi
ExperiencePickUpPoints)
2) Sul posto o recupero tramite
servizio di pick-up (vedi
ExperienceMeetingPoints e
ExperiencePickUpPoints)
ExperienceMeetingWindowType Int 1 Finestra e/o orario per incontro.
Possibili valori:
0) Fissa
Pagina: 29
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.com1) Varabile a seconda del
punto l’incontro
ExperienceMeetingWindowStart Int 1 Se ExperienceMeetingWindowType
valorizzato a 0 e risorsa è per giorno o
notti, l’orario di inizio per il ritrovo.
Valore in minuti (es: 06:00 => 360)
ExperienceMeetingWindowEnd Int 1 Se ExperienceMeetingWindowType
valorizzato a 0 e risorsa è per giorno o
notti, l’orario di inizio finestra per il
ritrovo. Valore in minuti (es: 06:00 =>
360)
ExperienceMeetingWindowMinutes Int 1 Se ExperienceMeetingWindowType
Before valorizzato a 0 e risorsa è per ore
oppure slot temporali, indica quanti
minuti prima dell’inizio dell’esperienza
inizia la finestra per il ritrovo
(es: inizio ore 10, ritrovo ore 9, valore
=> 60)
ExperienceMeetingWindowMinutes Int 1 Se ExperienceMeetingWindowType
Length valorizzato a 0 e risorsa è per ore
oppure slot temporali, indica la durata
della finestra per il ritrovo
(es: inizio ore 10, ritrovo ore 9, max
orario 9:45, valore => 45)
ExperiencePickUpWindowType Int 1 Finestra di pick-up. Possibili valori:
0) Fissa
1) Varabile a seconda del
punto di pick-up
ExperiencePickUpWindowStart Int 1 Se ExperiencePickUpWindowType
valorizzato a 0 e risorsa è per giorno o
notti, l’orario di inizio finestra pick-up.
Valore in minuti (es: 06:00 => 360)
ExperiencePickUpWindowEnd Int 1 Se ExperiencePickUpWindowType
valorizzato a 0 e risorsa è per giorno o
notti, l’orario di inizio finestra pick-up.
Valore in minuti (es: 06:00 => 360)
ExperiencePickUpWindowMinutesB Int 1 Se ExperiencePickUpWindowType
efore valorizzato a 0 e risorsa è per ore
oppure slot temporali, indica quanti
minuti prima dell’inizio dell’esperienza
inizia la finestra di pick-up
(es: inizio ore 10, ritrovo ore 9, valore
=> 60)
ExperiencePickUpWindowMinutesL Int 1 Se ExperiencePickUpWindowType
ength valorizzato a 0 e risorsa è per ore
oppure slot temporali, indica la durata
della finestra di pick-up
(es: inizio ore 10, ritrovo ore 9, max
orario 9:45, valore => 45)
ExperienceDropOffType Int 1 Azione per fine esperienza. Possibili
valori:
0) Nessun servizio di drop-off
Pagina: 30
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.com1) Servizio di drop-off, stesso
punto di pick-up (vedi
ExperiencePickUpPoints)
2) Servizio di drop-off, punti
diversi (vedi
ExperienceDropOffPoints)
ExperiencePickUpAllowCustomAdd Boolean 1 Se valorizzato a True, si permette al
ress cliente di inserire un proprio indirizzo
per il servizio di pick-up
ExperienceDropOffAllowCustomAd Boolean 1 Se valorizzato a True, si permette al
dress cliente di inserire un proprio indirizzo
per il servizio di drop-off
ExperienceRoutePoints ResourcePOIPointObject 0-n Array di oggetti di tipo
ResourcePOIPointObject (vedi
Appendice per la definizione della
classe): definisce i vari punti di
interesse presenti nell’esperienza
ExperienceMeetingPoints ResourcePOIPointObject 0-n Array di oggetti di tipo
ResourcePOIPointObject (vedi
Appendice per la definizione della
classe): definisce i punti di ritrovo, se
abilitati
ExperiencePickUpPoints ResourcePOIPointObject 0-n Array di oggetti di tipo
ResourcePOIPointObject (vedi
Appendice per la definizione della
classe): definisce i punti di pick-up, se
abilitati
ExperienceDropOffPoints ResourcePOIPointObject 0-n Array di oggetti di tipo
ResourcePOIPointObject (vedi
Appendice per la definizione della
classe): definisce i punti di pick-up, se
abilitati
AttachmentEnableTickets Boolean 1 Se valorizzato a True, in fase di
prenotazione verrà fornito un biglietto
in allegato
AttachmentPerPeople Boolean 1 Se valorizzato a True, in fase di
prenotazione verrà fornito un biglietto
in allegato per ogni persona
AttachmentAdditionalMessage String 1 Messaggio aggiuntivo a corredo del
biglietto
AttachmentCodeType Int 1 Tipologia di codice biglietto fornito.
Possibili valori:
0) Codice QR
1) Codice a barre
2) Codice PDF417
3) Matrice dati
4) AZTEC
AttachmentPickUpType Int 1 Tipologia di biglietto. Possibili valori
0) Biglietto definitivo e valido
per l’esperienza
Pagina: 31
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.com1) Biglietto temporaneo e
necessita di cambio
AttachmentPickUpPoints ResourcePOIPointObject 0-n Se AttachmentPickUpType valorizzato
a 1, array di oggetti di tipo
ResourcePOIPointObject (vedi
Appendice per la definizione della
classe): definisce i punti per il cambio
biglietto
CheckOutMainContactDataRequire ResourceCheckOutFieldContact 0-1 Oggetto con i campi abilitati e/o
ments richiesti in fase di check-out per
l’intestatario prenotazione (vedi
Appendice per la definizione della
classe)
CheckOutRequireCrewData Boolean 1 Se valorizzato a True, in fase di
check-out verranno richiesti anche i
dati per i singoli componenti della
prenotazione
CheckOutCrewDataRequirements ResourceCheckOutFieldContact 0-1 Oggetto con i campi abilitati e/o
richiesti in fase di check-out per i
singoli componenti della prenotazione
(vedi Appendice per la definizione
della classe)
AdditionalQuestions ResourceCheckOutAdditionalQuestion 0-n Array di
Object ResourceCheckOutAdditionalQuestion
Object (vedi Appendice per la
definizione della classe): definisce le
domande aggiuntive da porre in fase
di check-out
Note: per numero elementi 0-1 per i campi int e booleani, si intende che l’elemento è
“nullable” ma, se il valore sarà nullo, dovrà essere specificato nel seguente modo:
Per i campi string, se il valore è nullo il nodo può non essere specificato
CATEGORYOBJECT
ELEMENTO TIPO NUMERO DESCRIZIONE
ELEMENTI
Id int 1 Identificativo univoco della categoria
(da utilizzare per MainCategoryId
della risorsa)
RefId String 1 Identificativo di riferimento
Names TranslationObjec 0-n Array di oggetti di tipo
t TranslationObject (vedi Appendice
per la definizione della classe):
definiscono le traduzioni disponibili
per il nome
Pagina: 32
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comDescriptions TranslationObjec 0-n Array di oggetti di tipo
t TranslationObject (vedi Appendice
per la definizione della classe):
definiscono le traduzioni disponibili
per la descrizione
GEOGRAPHICZONEOBJECT
ELEMENTO TIPO NUMERO DESCRIZIONE
ELEMEN
TI
Id int 1 Identificativo univoco della zona (da
utilizzare per Zones della risorsa)
Order Int 1 Ordine di priorità della zona
Selectable Bool 1 Se impostato a Sì, la zona può
essere utilizzata, altrimenti verrà
associata in automatico dal sistema
Names TranslationObject 0-n Array di oggetti di tipo
TranslationObject (vedi Appendice
per la definizione della classe):
definiscono le traduzioni disponibili
per il nome
States GeographicZoneStateAssociationO 0-n Array di oggetti di tipo
bject GeographicZoneStateAssociationO
bject (vedi Appendice per la
definizione della classe): definisce
gli stati e gli eventuali filtri
regione/città associati alla zona
GEOGRAPHICZONESTATEASSOCIATIONOBJECT
ELEMENTO TIPO NUMERO DESCRIZIONE
ELEMENT
I
Id Int 1 Identificativo stato
Per il codice corretto, fai riferimento a
http://www.geonames.org/
GetAllItems Bool 1 Se impostato a True, la zona copre
tutto il territorio dello stato
Se impostato a False, la zona copre
una parte dello stato. Vedi Regions
Cities Int 0-n Se lo stato non ha regioni e
GetAllItems impostato a True,
definisce le città inglobate nella zona
Per i codici corretti, fai riferimento a
http://www.geonames.org/
Regions GeographicZoneStateAssociationObje 0-n Array di oggetti di tipo
ct GeographicZoneStateAssociationObje
ct (vedi Appendice per la definizione
della classe): definisce gli stati e gli
eventuali filtri regione/città associati
alla zona
GEOGRAPHICZONEREGIONASSOCIATIONOBJECT
Pagina: 33
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comELEMENTO TIPO NUMERO DESCRIZIONE
ELEMENTI
Id Int 1 Identificativo stato
Per il codice corretto, fai riferimento a
http://www.geonames.org/
GetAllItems Bool 1 Se impostato a True, la zona copre
tutto il territorio della regione
Se impostato a False, la zona copre
una parte della regione. Vedi cities
Cities Int 0-n Se GetAllItems impostato a True,
definisce le città inglobate nella zona
Per i codici corretti, fai riferimento a
http://www.geonames.org/
AGECATEGORY
ELEMENTO TIPO NUMERO DESCRIZIONE
ELEMENTI
MinAge Int 1 Età minima fascia (anni compiuti)
MaxAge Int 1 Età massima fascia (anni non
compiuti)
IsLimitedQt Int 1 Se valorizzato a True, la fascia
viene limitata per un numero definito
di persone (su letti esistenti)
MinQt Int 1 Se IsLimitedQt valorizzato a True,
numero minimo di persone (su letti
esistenti)
MaxQt Int 1 Se IsLimitedQt valorizzato a True,
numero massimo di persone (su letti
esistenti)
IsMainCategory Boolean 1 Se valorizzato a true, la fascia viene
considerata come principale
(solitamente adulto)
IncludedInQuotation Boolean 1 Se valorizzato a False, la fascia non
è valida (su letti esistenti)
BaseValue String 1 Valore base associato alla fascia,
non disponibile per la principale
ES: 25% => viene applicato il 25%
rispetto al prezzo principale nello
stesso periodo
Order Int 1 Ordine di applicazione
SortDirection String 1 Ordine di applicazione per stessa
fascia. Possibili valori:
asc => ordine ascendente età
desc => ordine discendente età
ForExtraPaxes Boolean 1 Se valorizzato a True, la fascia in
questione viene utilizzata per gli
extrabed
ForCots Boolean 1 Se valorizzato a True, la fascia in
questione viene utilizzata per le
culle (verrà considerato solo
MaxAge)
Pagina: 34
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comMaxExtraQt Int 1 Se ForExtraPaxes valorizzato a
True, quantità max di extrabed
disponibili per questa fascia
IsLimitedPaxPosition Boolean 1 Se valorizzato a True, la fascia in
questione è applicata per un
numero definito di posizioni/posti
(non valido per extrabed e culle)
MinPaxPosition Int 1 Se valorizzato a True, la fascia è
valida a partire dal posto indicato
MaxPaxPosition Int 1 Se valorizzato a True, la fascia è
valida fino al posto indicato
PRICESTAYRANGE
ELEMENTO TIPO NUMERO DESCRIZIONE
ELEMENTI
MinStay int 1 Durata minima associata al prezzo
MaxStay int 1 Durata massima associata al prezzo
MainRange Boolean 1 Se valorizzato a True, la fascia è
impostata come principale
BaseValue String 1 Valore base associato alla
categoria, non disponibile per la
principale (100%)
ES: 25% => viene applicato il 25%
rispetto al prezzo principale nello
stesso periodo
LockValue Boolean 1 Se valorizzato a True, i valori
vengono bloccati ed ereditati da
BaseValue
PRICESTAYRANGE
ELEMENTO TIPO NUMERO DESCRIZIONE
ELEMENTI
MinStay int 1 Durata minima associata al prezzo
MaxStay int 1 Durata massima (esclusa) associata
al prezzo
MainRange Boolean 1 Se valorizzato a True, la fascia è
impostata come principale
BaseValue String 1 Valore base associato alla
categoria, non disponibile per la
principale (100%)
ES: 25% => viene applicato il 25%
rispetto al prezzo principale nello
stesso periodo
LockValue Boolean 1 Se valorizzato a True, i valori
vengono bloccati ed ereditati da
BaseValue
PRICEPAXRANGE
ELEMENTO TIPO NUMERO DESCRIZIONE
ELEMENTI
Pagina: 35
Riservati tutti i diritti - Copyright Ipertrade s.r.l info@bookingfor.com – www.bookingfor.comPuoi anche leggere
