MagicTours.pl - System Rezerwacyjny

tripsGenerator()

Generator teminów do oferty na podstawie planu. Stare terminy z wybranego okresu są kasowane.

Parameters:

token : unikalny kod umożliwiający dostęp do API ( config defined )
function : this function name
ID_OFERTY : identyfikator oferty, do której mają być wygenerowane terminy.
DATA_OD : data początkowa ( YYYY-MM-DD )
DATA_DO : data końcowa ( YYYY-MM-DD )
CHD_AGE : (opcjonalny) limit wieku CHD ( domyślnie 12 )
INF_AGE : (opcjonalny) limit wieku ADT ( domyślnie 2 )

Returns:

Gdy operacja się powiedzie to
```
   DONE,count=123
```
gdzie "123" to ilośc utworzonych "terminów\/imprez".
Gdy operacja się nie powiedzie to
```
   ERROR
   001:Opis błędu
```

Example of use

It is recomended to send parametrs using POST method.

tripsUpdate()

Aktualizuje istniejące terminy w ofercie na podstawie planu.

Parameters:

token : unikalny kod umożliwiający dostęp do API ( config defined )
function : this function name
ID_OFERTY : identyfikator oferty, do której mają być wygenerowane terminy.

Returns:

Gdy operacja się powiedzie to
```
   DONE,status=OK
```
Gdy operacja się nie powiedzie to
```
   ERROR
   001:Opis błędu
```

Example of use

It is recomended to send parametrs using POST method.

createEvent()

Tworzy imprezę ( event ) do wybranej oferty i dla wybranego okresu.

Parameters:

token : unikalny kod umożliwiający dostęp do API ( config defined )
function : this function name
ID_OFERTY : identyfikator oferty, do której ma być utworzona impreza.
DATA_OD : data początkowa ( YYYY-MM-DD )
DATA_DO : data końcowa ( YYYY-MM-DD )

Returns:

Gdy operacja się powiedzie to
```
   DONE,id=927
```
lub
```
   EXISTS,id=927
```
gdzie "927" to identyfikator imprezy w ( R2_IMPREZA ).
Gdy operacja się nie powiedzie to
```
   ERROR
   001:Opis błędu
```

Example of use

It is recomended to send parametrs using POST method.

convertFastToR2()

Przekształcenie R2Fast w rezerwację R2 z kompletem składników.

Parameters:

token : unikalny kod umożliwiający dostęp do API ( config defined )
function : this function name
ID_R2FAST : identyfikator rekordu do przekształcenia

Returns:

Gdy operacja się powiedzie to
```
   DONE,ID=63
```
gdzie "63" to identyfikator utworzonej rezerwacji w R2.
Gdy operacja się nie powiedzie to
```
   FAIL
```
lub
```
   ERROR
   001:Opis błędu
```

Example of use

It is recomended to send parametrs using POST method.

pickupGenerate()

Generuje wydruk pick-up.

Parameters:

token : unikalny kod umożliwiający dostęp do API ( config defined )
function : this function name
ID_R2_IMPREZA : identyfikator imprezy
TEMPLATE : szablon umowy ( gdy brak to = default )

Returns:

Gdy operacja się powiedzie to zwracany jest wydruk w formacie HTML.
Gdy operacja się nie powiedzie to zwraca:
```
   FAIL
```
lub
```
   ERROR
   001:Opis błędu
```

Example of use

It is recomended to send parametrs using POST method.

agreementGenerate()

Generuje wydruk umowy.

Parameters:

token : unikalny kod umożliwiający dostęp do API ( config defined )
function : this function name
ID_R2 or WEB_TAG : identyfikator rezerwacji, gdy uzywamy WEB_TAG to nie jest wymagany token.
TEMPLATE : szablon umowy ( gdy brak to = default )

Returns:

Gdy operacja się powiedzie to zwracany jest wydruk w formacie HTML.
Gdy operacja się nie powiedzie to zwraca:
```
   FAIL
```
lub
```
   ERROR
   001:Opis błędu
```

Example of use

It is recomended to send parametrs using POST method.

reservationForm()

Okno rezerwacji online

Parameters:

function : this function name
idOffer : identyfikator oferty ( idOffer )
dateFrom : (opcjonalny)termin wyjazdu/rozpoczęcia imprezy
subGroup : (opcjonalny)podgrupa ofert
request : (opcjonalny) domyślne wartości pól formularza - zgodnie z nazwami elementów input.

Returns:

HTML formularza rezerwacyjnego do gotowy do prezentacji w przeglądarce.

Example of use

It is recomended to send parametrs using POST method.

getOfferTripList()

Pobieranie listy ofert z kalkulacją za dojazd i uwzględnieniem wieku uczestników.

Parameters:

token : unikalny kod umożliwiający dostęp do API ( config defined )
function : this function name
idOffer : identyfikatory ofert oddzielone znakiem "," ( przecinka )
idHotel : identyfikator hotelu ( idHotel )
dateFrom : termin rozpoczęcia imprezy od dnia
dateTo : termin rozpoczęcia imprezy do dnia

participants : Lista uczestników jako tablica zakodowana w json:

              data = array();
              data [ 'participants' ][ 0 ][ 'name' ] = 'Paweł' ;           // PIERWSZY WYMAGANY
              data [ 'participants' ][ 0 ][ 'surname' ] = 'Niekumatski' ;  // PIERWSZY WYMAGANY
              data [ 'participants' ][ 0 ][ 'birthDate' ] = '1978-05-21' ; // PIERWSZY WYMAGANY

              data [ 'participants' ][ 1 ][ 'name' ] = 'Beata' ;
              data [ 'participants' ][ 1 ][ 'surname' ] = 'Niekumatska' ;
              data [ 'participants' ][ 1 ][ 'birthDate' ] = '1981-06-18' ;
              data [ 'participants' ][ 3 ][ 'name' ] = 'Zuza' ;
              data [ 'participants' ][ 3 ][ 'surname' ] =  'Niekumatska' ;
              data [ 'participants' ][ 3 ][ 'birthDate' ] = '2016-01-01' ;
              participants = json_encode ( data [ 'participants' ] ) ;

Returns:

Array w fromacie JSON z listą ofert i terminów ( wszystkie niezbędne informacje do przygotowania lisy wyboru ).

Example of use

It is recomended to send parametrs using POST method.

getEventsListForm()

Pobieranie listy imprez / listy dostępności.

Parameters:

token : unikalny kod umożliwiający dostęp do API ( config defined )
function : this function name
dateFrom : imprezy od dnia ( yyyy-mm-dd )
dateTo : imprezy do dnia ( yyyy-mm-dd )
offerRegion : lista regionów ofert oddzielona znakiem przecinka
offerCode : lista kodów ofert oddzielona znakiem przecinka

Returns:

Lista w HTML.

Example of use

It is recomended to send parametrs using POST method.

getDistanceHotelDepPlace()

Zwraca odległośc pomiędzy hotelem a przystankiem.

Parameters:

token : unikalny kod umożliwiający dostęp do API ( config defined )
function : this function name
idHotel : identyfikator hotelu
idDeparturePlace : identyfikator przystanku

Returns:

odległość w km. w json

Example of use

It is recomended to send parametrs using POST method.

getAvailability()

Zwraca dostępnośc miejsc na imprezę/termin

Parameters:

token : unikalny kod umożliwiający dostęp do API ( config defined )
function : this function name
offerCode : kod oferty
dateFrom : data od
dateTo : data do

Returns:

json z informacją o dostępności np.: {"availablePax":19,"eventsOccupiedPax":0,"offerMaxPax":"19","offerBusSize":"0","offerMaxRounds":"0"}

Example of use

It is recomended to send parametrs using POST method.

generateEvents()

Funkcja tworzy imprezy na dzień zadany w parametrze. Podstawą do utworzenia imprez są informacje z oferty ( ilośc tur + obłożenie tury )
Jeśli w wybranym terminie istnieją już imprezy na daną ofertę to tworzone są tylko te "uzupełniające" do ilości tur określonych w ofercie.

Parameters:

token : unikalny kod umożliwiający dostęp do API ( config defined )
function : this function name
date : format YYYY-MM-DD, domyślnie +21 dni

Returns:

json z informacją o załozonych imprezach.:

Example of use

It is recomended to send parametrs using POST method.

getGpsTracking()

Zwraca listę pozycji GPS pracowników oraz niezbędne powiązania.

Parameters:

token : unikalny kod umożliwiający dostęp do API ( config defined )
function : this function name
region : nazwa regionu (wymagana)
date : format YYYY-MM-DD, domyślnie bieżąca data
timeFrom : format HH:MM:SS, domyślnie bieżąca godzina i minuta + 00s

Returns:

json z informacją o pozycjach np.:

Example of use

It is recomended to send parametrs using POST method.

getEventsLiveInfo()

Funkcja zwraca informacje ogólne o imprezach na potrzeby aplikacji uruchamianej na duzych TV.

Parameters:

token : unikalny kod umożliwiający dostęp do API ( config defined )
function : this function name
date : format YYYY-MM-DD ( domyslnie bieżąca data )
region : nazwa regionu (wymagana)

Returns:

json z informacją o imprezach.:

Example of use

It is recomended to send parametrs using POST method.

setAutoReservationsStatus()

Ustawia statusy rezerwacji. Np nieopłacone po terminie jako 'anulowana' itp ...

Parameters:

token : unikalny kod umożliwiający dostęp do API ( config defined )
function : this function name
dateFrom : format YYYY-MM-DD ( dotyczy rezerwacji gdzie data rezerwacji jest większa lub równa niż podana wartość ), domyślnie -28 days.

Returns:

json z informacją o rezerwacjach, których status uległ zmianie.:

Example of use

It is recomended to send parametrs using POST method.

generateCostDocuments()

          Generuje dokumenty kosztów na podstawie:
            a) [mode=generalMonth] ogólne na podstawie definicji kosztów
               - wynagrodzenia na pracowników ;
               - wypłaty dla kontrahentów ;
            b) [mode=event] do wskazanej s idEvent imprezy:
               - na podstawie definicji kosztów ;
               - transportu na podstawie definicji kosztów + R2_IMPREZA.ID_AUTOAKR->R2_AUTOKARY.ID_FIRMA_WLASCICIEL ;
               - przewodnika na podstawie R2_IMPREZA.ID_PILOT1

Parameters:

token : unikalny kod umożliwiający dostęp do API ( config defined )
function : this function name
mode : generalMonth | event, dla general wymagane uzupełnienie parametru monthYear, dla event wymagane uzupełnienie parametru idEvent
monthYear : pierwszy dzień miesiąca za który mają być wygenerowane koszty np. 2018-05-01 ( tylko dla mode = generalMonth )
idEvent : id imprezy ( tylko dla mode = event )

Returns:

json z informacjami o wygenerowanych kosztach lun informacje o błędzie:

Example of use

It is recomended to send parametrs using POST method.

generateCostDocumentsForm()

interfejs pośredniczący w wywoływaniu funkcji generateCostDocuments.

Parameters:

token : unikalny kod umożliwiający dostęp do API ( config defined )
function : this function name
mode : generalMonth | event, dla general wymagane uzupełnienie parametru monthYear, dla event wymagane uzupełnienie parametru idEvent
monthYear : pierwszy dzień miesiąca za który mają być wygenerowane koszty np. 2018-05-01 ( tylko dla mode = generalMonth )
idEvent : id imprezy ( tylko dla mode = event )

Returns:

HTML

Example of use

It is recomended to send parametrs using POST method.

MagicTours CRM Tools - by KSI

API functions:

tripsGenerator()

tripsUpdate()

createEvent()

convertFastToR2()

pickupGenerate()

agreementGenerate()

reservationForm()

getOfferTripList()

getEventsListForm()

getDistanceHotelDepPlace()

getAvailability()

generateEvents()

getGpsTracking()

getEventsLiveInfo()

setAutoReservationsStatus()

generateCostDocuments()

generateCostDocumentsForm()