Documentatie API

Atentie: decodarea raspunsurilor in PHP trebuie facuta cu:

json_decode($response, true); //returned objects will be converted into associative arrays.

/bursa/services/authentication

Aceasta este functia pentru autentificare
Functia primeste 2 parametrii in POST:
email (obligatoriu) password (obligatoriu)

Api-ul va raspunde cu un obiect JSON cu urmatoarele campuri
status - ok/error
error - motivul pentru care a esuat eroarea (apare numai daca status este error)
token - token-ul care va fi folosit pentru request-urile viitoare (apare numai daca status este ok)
userId - ID-ul userului care a fost autentificat (apare numai daca status este ok)
yardId - ID-ul parcului de dezmembrari care a fost autentificat (apare numai daca status este ok)
expiresIn - numarul de secunde in care tokenul expira (apare numai daca status este ok)

/bursa/services/manufacturers

Aceasta este functia care listeaza toti producatorii
Functia primeste 1 parametru in POST:
token (obligatoriu)

/bursa/services/models

Aceasta este functia care listeaza modelele unui producator
Functia primeste 1 parametru in POST:
token (obligatoriu) manufacturerId (obligatoriu)

/bursa/services/adverts

Aceasta este functia pentru listarea anunturilor
Functia primeste 6 parametru in POST:
token (obligatoriu) - este token-ul optinut la autentificare
extraFields (optional) - valori posibile: 0/1
advertState (optional) - valori posibile: purchased, published, sold, toBePurchased
manufacturerId (optional) - ID-ul unui producator auto
modelId (optional) - ID-ul unui model auto
generationId (optional) - ID-ul unei generatii

In caz de eroare API-ul va raspunde cu un obiect JSON cu urmatoarele campuri
status - error
error - motivul pentru care a esuat eroarea

In caz de succes API-ul va raspunde cu o lista de obiecte JSON cu urmatoarele campuri
id - ID-ul anuntului
active - 1/0 (1 daca este activ, 0 daca nu mai este activ)
customerLocation
carShortName
carLongName
partsShortName
partsLongName
remarks
publishedByType
publishedByName
publishedDate
publishedTime
publishedByUserId (folositor pentru a stii daca utilizatorul autentificat a publicat anuntul)
publishedByYardId (folositor pentru a stii daca parcul de dezmembrari autentificat a publicat anuntul)
purchased - 1/0 (1 daca este a fost cumparat de cineva, 0 daca mai poate fi cumparat)
purchasedByName
purchasedDate
purchasedTime
purchasedByYardId (folositor pentru a stii daca parcul de dezmembrari autentificat a cumparat anuntul)
campuri suplimentare (pentru integrarile mai avansate atunci cand in post avem extraFields: 1)
publishedDateTime (data si ora in format interpretabil de catre un calculator)
publishedByUser (obiect)
publishedByUser.name
publishedByUser.phone
publishedByUser.email
publishedByYard (obiect)
publishedByYard.name
publishedByYard.company
publishedByYard.city
publishedByYard.region
publishedByYard.vatNo
publishedByYard.registrationNo
publishedByYard.phone
publishedByYard.email
purchasedDateTime (data si ora in format interpretabil de catre un calculator)
purchasedByYard (obiect)
purchasedByYard.name
purchasedByYard.company
purchasedByYard.city
purchasedByYard.region
purchasedByYard.vatNo
purchasedByYard.registrationNo
purchasedByYard.phone
purchasedByYard.email
manufacturer (obiect) - producatorul auto
manufacturer.name
manufacturer.id
manufacturer.slug
model (obiect) - modelul auto
model.name
model.id
model.slug
generation (obiect) - generatia
generation.name
generation.id
generation.slug
series (obiect) - caroserie
series.name
series.id
series.slug
trim (obiect) - motorizare
trim.name
trim.id
trim.slug
parts (lista de obiecte) - lista de piese
parts[].name
parts[].color
parts[].code

/bursa/services/advert_details

Aceasta este functia pentru afisarea detaliilor despre un anunt
Functia primeste 6 parametru in POST:
token (obligatoriu) - este token-ul optinut la autentificare
extraFields (optional) - valori posibile: 0/1
advertId (obligatoriu) - id-ul auntului pentru care dorim sa afisam detaliile

In caz de eroare API-ul va raspunde cu un obiect JSON cu urmatoarele campuri
status - error
error - motivul pentru care a esuat eroarea

In caz de succes API-ul va raspunde cu o lista de obiecte JSON in care sunt toate campurile din lista plus urmatoarele campuri
customerName (numai daca anuntul a fost cumparat)
customerPhone (numai daca anuntul a fost cumparat)
customerEmail (numai daca anuntul a fost cumparat)
shouldBeInactivated - 1/0 (1 daca a fost propus pentru dezactivare, 0 daca nu)
shouldBeInactivatedSugestedDate (numai daca anuntul a fost propus pentru dezactivare)
shouldBeInactivatedSugestedTime (numai daca anuntul a fost propus pentru dezactivare)
shouldBeInactivatedSugestedByUserName (numai daca anuntul a fost propus pentru dezactivare)
shouldBeInactivatedSugestedByYardName (numai daca anuntul a fost propus pentru dezactivare)
hasCancellationHistory - 1/0 (1 daca a fost cumparat si ulterior s-a anulat cumpararea, 0 daca nu)
CancellationHistory (lista de obiecte, apare numai daca exista istoric)
CancellationHistory[].purchasedByYardName (apare numai daca exista istoric)
CancellationHistory[].purchasedByYardId (apare numai daca exista istoric)
CancellationHistory[].purchasedDate (apare numai daca exista istoric)
CancellationHistory[].purchasedTime (apare numai daca exista istoric)
CancellationHistory[].cancellationDate (apare numai daca exista istoric)
CancellationHistory[].cancellationTime (apare numai daca exista istoric)
CancellationHistory[].cancellationReasonText (apare numai daca exista istoric)
CancellationHistory[].cancellationReasonRemarks (apare numai daca exista istoric)
canBePurchased - 1/0 (1 daca poate fi cumparat, 0 daca nu)
canBeDeactivated - 1/0 (1 daca poate fi dezactivat, 0 daca nu)
purchaseCanBeCancelled - 1/0 (1 daca a fost cumparat si poate fi anulata cumpararea, 0 daca nu)
canBeMarkedAsSold - 1/0 (1 daca a fost cumparat si poate fi marcat ca vandut, 0 daca nu)