# Softra Rent API - Transkrypcja: Autoryzacja i flota

> ?r?d?o: "Oferta 37 Softra_Rent_API - zaaczni k Specyfikacja_Rent_RESTAPI_1_15.pdf"

1. Generowanie tokena JWT
Opis: Generuje token za JWT dla przesłanego loginu i hasła
URL : /account/auth
Typ metody : POST
Nagłówki: Brak

Parametry JSON Object

Nazwa pola Opis pola Typ danych  Uwagi
login Identyfikator użytkownika String  Parametr
wymagany

password hasło String  Parametr
wymagany

Odpowiedź  : Obiekt LoginResponse

Obiekt LoginResponse

Nazwa pola Opis pola Typ danych  Uwagi
token token JWT String  ważny 1h

2. Pobranie listy oddziałów

Opis:  pobiera listę dostępnych odziałów
Url : /branch/list
Typ metody : GET
Nagłówki:
  "Authorization: Bearer [token]"
Parametry:
Brak

Odpowiedź  :   Obiekt typu List<Branch>

Obiekt Branch

Nazwa pola Opis pola Typ danych  Uwagi
name symbol oddziału String
description opis oddziału String
zipCode kod pocztowy String
street ulica String
city miejscowość String
voivodeship województwo String
openingTime godziny otwarcia - dni robocze String
closingTime godziny zamknięcia – dni robocze String
isVirtual czy oddział wirtualny Boolean
email adres email oddziału String
phoneNo numer telefonu odziału String
relatedBranchName symbol oddziału powiązanego String
openingTimeSaturday godziny otwarcia - soboty String
closingTimeSaturday godziny zamknięcia - soboty String
openingTimeSunday godziny otwarcia - niedziele String
closingTimeSunday godziny zamknięcia - niedziele String

3. Pobranie listy dostępnych klas pojazdów

Opis: zwraca listę kategorii pojazdów dostępnych we wskazanym oddziale i okresie
spełniających określone warunki klienta ( np. rodzaj skrzyni biegów)
URL : /car/class/list
Typ metody : POST
Nagłówki:
  "Authorization: Bearer [token]"
Parametry JSON Object

Nazwa  Opis pola Typ danych  Wymagalność
dateFrom data początku wynajmu w
formacie w formacie YYYY-MM-
DDTHHT24:MI:SS np 2014-10-
10T00:00:00
String  TAK
dateTo data końca wynajmu w formacie
YYYY-MM-DDTHH24:MI:SS np
2014-10-10T00:00:00
String  TAK
branchName symbol oddziału String  TAK
fuelType rodzaj paliwa 'DIESEL', 'NPB', 'LPG' String  NIE
carBodyType rodzaj pojazdu  String  NIE

Odpowiedź  :   Obiekt typu List< String > , gdzie każdy element to symbol klasy pojazdu

4. Pobranie listy dostępnych marek i modeli w danej klasie i
oddziale

Opis: zwraca listę dostępnych marek i modeli w danej klasie pojazdów w danym oddziale na
podany dzień początku najmu spełniających określone warunki klienta
URL : /car/model/list
Typ metody : POST
Nagłówki:
  "Authorization: Bearer [token]"
Paremetry GET: includeBrandDetails  true/false  (opcjonalny)
Parametry JSON Object

Nazwa  Opis pola Typ danych  Wymagalność
dateFrom data początku wynajmu w
formacie w formacie YYYY-MM-
DDTHH24:MI:SS np 2014-10-
10T00:00:00
String  TAK
dateTo data końca wynajmu w formacie
YYYY-MM-DDTHH24:MI:SS np
2014-10-10T00:00:00
String  TAK
branchName symbol oddziału String  TAK
category kategoria pojazdu, - empty string
zwróci listę dostępnych modeli dla
wszystkich klas pojazdów
String  NIE
fuelType rodzaj paliwa 'DIESEL', 'NPB', 'LPG' String  NIE
carBodyType rodzaj pojazdu  String  NIE

Odpowiedź  :   Obiekt typu List< CarModel >

Obiekt CarModel

Nazwa pola Opis pola Typ danych  Uwagi
branchName symbol oddziału String
bodyType rodzaj nadwozia String
category kategoria String
doorCount ilość drzwi Integer
gearboxType rodzaj skrzyni biegów String
seatCount ilość miejsc Integer
fuelType rodzaj paliwa String
bagCount Ilosć walizek Integer
brandDesc Opis marki String  Zwracany gdy
includeBrandDetails
=true

modelDesc Opis modelu String  Zwracany gdy
includeBrandDetails
=true

5. Pobranie cen

Opis: zwraca ceny dla wskazanej kategorii pojazdów w raz z listą dostępnych dodatków i ich
cenami dla podanego okresu wynajmu
URL : /pricelist/list
Typ metody : POST

Nagłówki:
  "Authorization: Bearer [token]"
Parametry JSON Object

Nazwa  Opis pola Typ danych  Wymagalność
category kategoria pojazdu, empty string
wróci listę dostępnych cenników
dla wszystkich klas pojazdów
String  NIE
dateFrom data początku najmu w formacie
YYYY-MM-DDTHHT24:MI:SS

String  TAK
dateTo data końca najmu w formacie
YYYY-MM-DDTHHT24:MI:SS
String  TAK
pickUpLocation miejsce wydania (symbol odziału) String  TAK
language język String  TAK
currency Waluta String  TAK

Odpowiedź  :   Obiekt typu List< PriceList >

Obiekt PriceList

Nazwa pola Opis pola Typ danych  Uwagi
id identyfikator cennika String
dateFrom data początku
obowiązywania cennika
String
dateTo data końca obowiązywania
cennika
String
kind rodzaj cennika String  ['standard',
'weekend',
'specjalny']

name nazwa cennika String
carCategory kategoria pojazdu String
group grupa cennikowa String
odoLimit limit dzienny kilometrów BigDecmial
notes uwagi String
currency symbol waluty np. PLN, EUR String
type rodzaj kalkulacji Netto/Brutto String
number numer cennika String
isRes czy zaznaczona opcja okresu
rezerwacji
Boolean
resDateFrom data od kiedy dopuszczalna
rezerwacja
String
resDateTo data do kiedy dopuszczalna
rezerwacja
String
depositValue wysokość kaucji BigDecmial

milageOverLimitCost koszt kilometra nadprzebiegu BigDecmial
fuelLackCost koszt niedotankowanego
paliwa za litr
BigDecmial
returnDelayCost koszt opoźnienia zwrotu za
dobę
BigDecmial
carDamageFullValue opłata za szkodę całkowitą BigDecmial
carDamagePartlyValue opłata za szkodę częściową BigDecmial
rentPrice Opłata za dobę wynajmu BigDecmial
rentMinPrice Minimalna opłata za dobę
wynajmu
BigDecmial
rentDescription Opis usługi najmu String
rentUnit jednostka miary String
additionalItems lista zadeklarowanych
elementów dodatkowych
wraz z ceną
List<AddItem>

Obiekt AddItem:

Nazwa pola Opis pola Typ danych  Uwagi
id identyfikator usługi dodatkowej String
name nazwa usługi dodatkowej String
unit jednostka miary String
price   cena jednostkowa BigDecmial
minPrice minimalna cena jednostkowa BigDecmial
maxQuanityOnPrincing maksymalna ilość dodatków na
wycenie
Integer
code Symbol opłaty String
