UDDS_ATLS API Gate.

Wszystkie informacje ofertowe umieszczane w ramach serwisów Atlas działają za pośrednictwem jednego interfejsu ( klasa PHP ), który udostępnia kilka funkcji. klasa ta jest jedynie klientem serwera UDDS API, który realizuje poszczególne funkcje wyszukiwania.

IDEA

Każda z funkcji pracuje w kontekście tablicy $searchParams co znaczy, że zwracane wyniki zawsze dotyczą ofert spełniających kryteria wyszukiwania przekazane w tej tablicy.
Przykładowo jeśli chcemy pobrać listę wszystkich armatorów to użyjemy funkcji :

http://api-gate.namorzu.pl/documentation/examples/ex1.php

Natomiast jeśli chcemy pobrać listę wszystkich armatorów obsługujących Karaiby z datą rozpoczęcia w sierpniu to umożliwia nam to wywołanie funkcji w następujący sposób :

http://api-gate.namorzu.pl/documentation/examples/ex2.php

Analogicznie wygląda sytuacja w przypadku gdy chcemy pobrać listę wszystkich regionów, statków i armatorów dla których rejsy są organizowane jesienią w cenie do 300 EUR :

http://api-gate.namorzu.pl/documentation/examples/ex3.php

Tak samo zachowują się pozostałe funkcje interfejsu czyli wyniki, które funkcje zwracają zawsze są zawężone do kontekstu wynikającego z parametrów wyszukiwania przekazanych w tablicy $udds->$searchParams.

Funkcje zwracają dane w taki sposób aby na podstawie uzyskanych wyników można było wprost zbudować widok strony dla klienta końcowego bez konieczności wykonywania dodatkowych zapytań do API. Ma to na celu zmniejszenie obciążenia serwera generującego stronę internetową oraz zminimalizowanie ilości zapytań pomiędzy warstwą front-end a serwerem wyszukującym.

Funkcja $udds->GetPossibleParams ( $params ).

Funkcja zwraca wszystkie niezbędne dane / słowniki / identyfikatory, które niezbędne są do zaimplementowania okna wyszukiwarki. Funkcja uwzględnia możliwość zawężania wyników wyszukiwania.

Parametry wejściowe:

$params przekazywany jako argument funkcji.
Jest to tablica pustych elementów dla których nazwa klucza określa nazwy grup danych jakie funkcja ma zwracać.

Przykład 1 ( wszystkie możliwe klucze ) :

    $params = array();
    $params['shipowners'] = null;
    $params['regions'] = null;
    $params['ships'] = null;
    $params['attributes'] = null;
    $params['routes'] = null;

Przykład 2 ( wybrane klucze ) :

    $params = array();
    $params['shipowners'] = null;

Dla każdego elementu tablicy przekazanej w argumencie funkcja zwróci odpowiednie listy.

$udds->searchParams pole klasy, którego zawartość ma wpływ na rezultat funkcji.

Przykłady :

http://api-gate.namorzu.pl/documentation/examples/ex1.php
http://api-gate.namorzu.pl/documentation/examples/ex2.php
http://api-gate.namorzu.pl/documentation/examples/ex3.php

Funkcja $udds->getOffersList()

Funkcja zwraca listę ofert spełniających wybrane kryteria wyszukiwania określone w strukturze $udds->searchParams.

Parametry wejściowe :

• $udds->searchParams pole klasy, którego zawartość ma wpływ na rezultat funkcji.

Przykłady:

1. Wszystkie rejsy jesienią w cenie poniżej 300 EUR a na stronie chcemy zwrócić tylko 3 oferty :

http://api-gate.namorzu.pl/documentation/examples/ex4.php

2. Wszystkie rejsy na Alaskę lub Karaiby o długości od 3 do 5 dni:

http://api-gate.namorzu.pl/documentation/examples/ex5.php

Funkcja $udds->getOffer()

Funkcja zwraca szczegóły wybranej oferty oferty ofert spełniających wybrane kryteria wyszukiwania określone w strukturze $udds->searchParams.
Funkcja zwraca także listę identyfikatorów ofert do pozostałych terminów dla tego rejsu a także wszystkie niezbędne opisy !

Parametry wejściowe :

• $udds->searchParams['offersIds'] = array ( idOffer ). Przekazujemy tylko jeden identyfikator oferty.

Przykłady:

1. Pokaż szczegóły najtańszej oferty spełniającej kryteria rejsy jesienią w cenie poniżej 300EUR.

http://api-gate.namorzu.pl/documentation/examples/ex6.php Dodatkowe funkcje pomocnicze :

Funkcja $udds->getShip()

Funkcja zwraca szczegółowe informacje na temat wybranego statku.

Przykład : http://api-gate.namorzu.pl/documentation/examples/ex7.php

Funkcja $udds->getShipowner()

Funkcja zwraca szczegółówe informacje dotyczące wybranego armatora.

Przykład : http://api-gate.namorzu.pl/documentation/examples/ex8.php

Funkcja $udds->getShipsList()

Funkcja zwraca szczegółowe informacje na temat listy wybranych statków.

Przykład : http://api-gate.namorzu.pl/documentation/examples/ex9.php

Parametry wyszukiwania / kontekst wyszukiwania

Dostępne parametry wyszukiwania:

    
      $searchParam['offersIds'] = array() // array number;
      
$searchParam['attributes'] = array(); // array number;
      
$searchParam['ships'] = array(); // array number;
      
$searchParam['shipsName'] = array(); // array str;
      
$searchParam['shipowners'] = array(); // array number;
      
$searchParam['regions'] = array();  // array number;
      
$searchParam['routes'] = array(); // array number ( Nie jest niezbędne )
      
$searchParam['length'][0] = null; // string number
      
$searchParam['length'][1] = null; // string number
      
$searchParam['currency'] = array(); // one of ('PLN', 'USD', 'EUR')
      
$searchParam['price'] = array( $from, $to ); // elements number
      
$searchParam['sort'][0] = null; // string; example: 'a', 'd'
      
$searchParam['sort'][1] = null; // string definition; example 'ship', 
                                      'shipowner', 'price', 'departureDate',
                                      'returnDate', 'attribute'
      
$searchParam['departureDateFrom'] = null; // date; example 2014-09-09 
      
$searchParam['departureDateTo'] = null; // date; example 2014-09-09 
      
$searchParam['returnDateFrom'] = null; // date;example 2014-09-09 
      
$searchParam['returnDateTo'] = null; // date; example 2014-09-09 
      
$resultsPerPage['resultsPerPage'] = null // string number - default 20
      
$resultsPerPage['resultsPageNumber'] = null // string number - default 1