Foglalás mentése

Innen: acemobilesafeticertificates.com.au oldal inspektor API leírás

Bevezetés

Ezzel a hívással lehetőségünk van menteni egy foglalás minden adatát. Új foglalás mentése és meglévő módosítása is rendelkezésre áll.

Figyelmeztetés

Foglalás módosítása esetén csak azokat az adatokat menti a program, melyek léteznek a küldött adatok között. Azaz, ha van egy megjegyzésünk, de nem küldjük az inspector_comment mezőt, akkor nem ürül ki, hanem változatlan marad. Ha üresen küldjük, akkor kiürül! Ami viszont még fontosabb, hogy a képek esetén ha üres tömböt küldünk, akkor üríti a program a képeket! Ha nem akarjuk módosítani, akkor ne legyen ilyen kulcsú elemünk a küldött adatok között!

Kérés adatai

  • URL: /saveBooking/
  • Metódus: POST
  • Fejléc: Access-Token: kapott token
    • VAGY User-Hash: a minden kérés válasz fejlécében megtalálható, userId kulccsal visszaadott érték. Ez nem módosul és nem minden kérésnél elfogadott!

Válasz HTTP kódok

  • 200: a kérés sikerült
  • 405: nem megfelelő a metódus. Csak POST metódust fogad a webservice.

Hibaüzenetek

  • r002: hiányzik a token. A korábban a bejelentkezéssel megszerzett tokent kell küldeni fejlécben, Access-Token névvel, vagy User-Hash kulccsal a userId-t.
  • r003: rossz a token. A megadott token, vagy userId nem létezik, vagy lejárt. Újat kell kérni a bejelentkezés hívással, vagy ellenőrizni kell a megadott User-Hash értéket
  • sb001: megadtuk az id paramétert, de az adott számmal nem létezik a bejelentkezett inspekor által kezelhető foglalás.
  • sb002: új foglalás esetén hiányzik a járműkategória.
  • sb003: nem létezik a megadott járműkategóra.
  • sb004: új foglalás esetén hiányzik a szolgáltatás.
  • sb005: nem létezik a megadott szolgáltatás.
  • sb006: új foglalás esetén hiányzik a vevő szolgáltatást kérő neve.
  • sb007: új foglalás esetén hiányzik a vevő szolgáltatást kérő mobilszáma.
  • sb008: új foglalás esetén hiányzik a szolgáltatási hely állama.
  • sb009: nem létezik a megadott állam.
  • sb010: új foglalás esetén hiányzik a kezdési időpont dátuma és/vagy időpontja.
  • sb011: új foglalás esetén hiányzik a szolgáltatási hely címe.
  • sb012: új foglalás esetén hiányzik a szolgáltatási hely kerülete.
  • sb013: új foglalás esetén hiányzik a szolgáltatási hely irányítószáma.
  • sb014: a rendelkezésre álló szolgáltatási cím adatokból a Google Maps nem tudott koordinátákat megállapítani, valószínüleg nem érvényes a cím.
  • sb015: új foglalás esetén hiányzik a vevő szolgáltatást kérő e-mail címe.
  • sb016: a megadott címen nem végez a cég szolgáltatást.
  • sb017: a megadott selling_id mező értéke nem létezik az értékkészletben. Lásd: Értékkészletek-listája
  • sb018: a megadott warranty_id mező értéke nem létezik az értékkészletben. Lásd: Értékkészletek-listája
  • sb019: nem értelmezhető a megadott kezdési dátum és/vagy időpont
  • sb020: nem értelmezhető a szolgáltatás elvégzésének dátuma
  • sb021: a megadott service_history_id mező értéke nem létezik az értékkészletben. Lásd: Értékkészletek-listája
  • sb022: nem értelmezhető a gyártás dátuma.
  • sb023: nem értelmezhető az utolsó szolgáltatás dátuma.
  • sb024: a megadott fuel_type_id mező értéke nem létezik az értékkészletben. Lásd: Értékkészletek-listája
  • sb025: a kezdési start_time paraméter nem megfelelő. UNIX timestamp * 1000 formában kell megadni.
  • sb026: a megadott spare_key_id mező értéke nem létezik az értékkészletben. Lásd: Értékkészletek-listája
  • sb027: a megadott roadworthy_certificate_id mező értéke nem létezik az értékkészletben. Lásd: Értékkészletek-listája
  • sb028: a megadott ppsr_report_id mező értéke nem létezik az értékkészletben. Lásd: Értékkészletek-listája

Várt és opcionális paraméterek

A kötelező paraméterek akkor kötelezők, ha új foglalást viszünk fel, vagy valamely okból kifolyólag hiányosak a foglalás adatai, ugyanis ezen paraméterek esetén, ha módosítást végzünk, akkor ha nem létezik a mező a küldött adatokban, a program a már meglévő értéket menti (azaz nem csinál semmit az adott értékkel).

  • id: a foglalás azonosítója (nem kötelező). Ha nincs megadva, akkor új foglalást rögzítünk, egyébként módosítunk. Ha meg van adva, de nem létezik a foglalás, hibaüzenetet kapunk!


  • start_time: a munka kezdő időpontja UNIX timestamp * 1000 formában megadva (kötelező, ha új foglalást rögzítünk).

---VAGY---

  • formatted_date: a munka kezdő időpontja mm/dd/YYYY formában megadva (kötelező, ha új foglalást rögzítünk).
  • formatted_time: a munka kezdő időpontja HH:ii{am/pm} formában megadva (kötelező, ha új foglalást rögzítünk).


  • service_category_id: a választott járműkategória azonosítója (kötelező, ha új foglalást rögzítünk). Lásd: Szolgáltatások-listája
  • service_id: a választott szolgáltatás azonosítója (kötelező, ha új foglalást rögzítünk). Lásd: Szolgáltatások-listája
  • inspection_name: a foglalásnál megadott név (kötelező, ha új foglalást rögzítünk)
  • inspection_address: cím, ahol a munkát végzik (kötelező, ha új foglalást rögzítünk)
  • inspection_company_name: a foglalásnál megadott cégnév (nem kötelező)
  • inspection_suburb: a foglalásnál megadott kerület (kötelező, ha új foglalást rögzítünk)
  • inspection_state: a foglalásnál kiválasztott állam (kötelező, ha új foglalást rögzítünk). Szövegként kell megadni, mentéskor a program visszakeresi az ID-t. Hibaüzenetet kapunk, ha nem létező államot adunk meg.
  • inspection_postcode: a foglalásnál megadott irányítószám (kötelező, ha új foglalást rögzítünk)
  • inspection_email: a foglalásnál megadott e-mail cím (kötelező, ha új foglalást rögzítünk)
  • inspection_mobile: a foglalásnál megadott mobilszám (kötelező, ha új foglalást rögzítünk)
  • make: gyártmány (nem kötelező)
  • model: modell (nem kötelező)
  • vin: VIN szám (nem kötelező)
  • registration_number: rendszám (nem kötelező)
  • mileage: kilométer óra állása (nem kötelező)
  • selling_id: azonosítószáma a megadott eladás típusnak (nem kötelező). Ha megadjuk, akkor muszáj a készletből származnia. Lásd: Értékkészletek-listája
  • warranty_id: azonosítószáma a garancia típusnak (nem kötelező). Ha megadjuk, akkor muszáj a készletből származnia. Lásd: Értékkészletek-listája


  • inspection_date: a gyártás időpontja időpontja UNIX timestamp * 1000 formában megadva (kötelező, ha új foglalást rögzítünk).

---VAGY---

  • formatted_inspection_date: a gyártás időpontja mm/dd/YYYY formában megadva (kötelező, ha új foglalást rögzítünk).


  • service_history_id: azonosítószáma a history típusnak (nem kötelező). Ha megadjuk, akkor muszáj a készletből származnia. Lásd: Értékkészletek-listája


  • built_date: a gyártás időpontja időpontja UNIX timestamp * 1000 formában megadva (kötelező, ha új foglalást rögzítünk).

---VAGY---

  • formatted_built_date: a gyártás időpontja mm/dd/YYYY formában megadva (kötelező, ha új foglalást rögzítünk).


  • last_service: az utolsó ellenőrzésidőpontja UNIX timestamp * 1000 formában megadva (kötelező, ha új foglalást rögzítünk).

---VAGY---

  • formatted_last_service: az utolsó ellenőrzés időpontja mm/dd/YYYY formában megadva (kötelező, ha új foglalást rögzítünk).


  • fuel_type_id: azonosítószáma az üzemanyag típusnak (nem kötelező). Ha megadjuk, akkor muszáj a készletből származnia. Lásd: Értékkészletek-listája
  • inspector_comment: inspekor hozzáfűzni valója a foglaláshoz (nem kötelező).
  • checklist_comment: inspekor hozzáfűzni valója a checklisthez (nem kötelező).
  • results: a foglalás eredményeit tartalmazó tömb (nem kötelező). Leírását lásd lentebb!
  • make_images: a gyártó képei tömbként (nem kötelező). Leírását lásd lentebb!
  • formatted_built_date_pdfs: a gyártás dátumának PDF dokumentumjai tömbként (nem kötelező). Leírását lásd lentebb!
  • registration_number_pdfs: a rendszám PDF dokumentumjai tömbként (nem kötelező). Leírását lásd lentebb!
  • vin_pdfs: a VIN PDF dokumentumjai tömbként (nem kötelező). Leírását lásd lentebb!
  • mileage_pdfs: a kilométer óra állásának PDF dokumentumjai tömbként (nem kötelező). Leírását lásd lentebb!
  • selling_type_pdfs: az eladás típusnak PDF dokumentumjai tömbként (nem kötelező). Leírását lásd lentebb!
  • warranty_pdfs: a garancia PDF dokumentumjai tömbként (nem kötelező). Leírását lásd lentebb!
  • formatted_inspection_date_pdfs: a munka elvégzésének időpontjának PDF dokumentumjai tömbként (nem kötelező). Leírását lásd lentebb!
  • inspector_name_pdfs: a munkát végző ember nevének PDF dokumentumjai tömbként (nem kötelező). Leírását lásd lentebb!
  • service_history_pdfs: a history type PDF dokumentumjai tömbként (nem kötelező). Leírását lásd lentebb!
  • last_service_pdfs: az utolsó szolgáltatás PDF dokumentumjai tömbként (nem kötelező). Leírását lásd lentebb!
  • fuel_type_pdfs: az üzemanyag típus PDF dokumentumjai tömbként (nem kötelező). Leírását lásd lentebb!
  • checklist_pdfs: a checklist blokk PDF dokumentumjai tömbként (nem kötelező). Leírását lásd lentebb!
  • formatted_built_date_images: a gyártás dátumának képei tömbként (nem kötelező). Leírását lásd lentebb!
  • registration_number_images: a rendszám képei tömbként (nem kötelező). Leírását lásd lentebb!
  • vin_images: a VIN képei tömbként (nem kötelező). Leírását lásd lentebb!
  • mileage_images: a kilométer óra állásának képei tömbként (nem kötelező). Leírását lásd lentebb!
  • selling_type_images: az eladás típusnak képei tömbként (nem kötelező). Leírását lásd lentebb!
  • warranty_images: a garancia képei tömbként (nem kötelező). Leírását lásd lentebb!
  • formatted_inspection_date_images: a munka elvégzésének időpontjának képei tömbként (nem kötelező). Leírását lásd lentebb!
  • inspector_name_images: a munkát végző ember nevének képei tömbként (nem kötelező). Leírását lásd lentebb!
  • service_history_images: a history type képei tömbként (nem kötelező). Leírását lásd lentebb!
  • last_service_images: az utolsó szolgáltatás képei tömbként (nem kötelező). Leírását lásd lentebb!
  • fuel_type_images: az üzemanyag típus képei tömbként (nem kötelező). Leírását lásd lentebb!
  • checklist_images: a checklist blokk képei tömbként (nem kötelező). Leírását lásd lentebb!
  • make_note: megjegyzés a make mezőhöz (nem kötelező). Leírását lásd lentebb!
  • model_note: megjegyzés a model mezőhöz (nem kötelező). Leírását lásd lentebb!
  • formatted_built_date_note: megjegyzés a formatted_built_date mezőhöz (nem kötelező). Leírását lásd lentebb!
  • registration_number_note: megjegyzés a registration_number mezőhöz (nem kötelező). Leírását lásd lentebb!
  • vin_note: megjegyzés a vin mezőhöz (nem kötelező). Leírását lásd lentebb!
  • mileage_note: megjegyzés a mileage mezőhöz (nem kötelező). Leírását lásd lentebb!
  • selling_type_note: megjegyzés a selling_id mezőhöz (nem kötelező). Leírását lásd lentebb!
  • warranty_note: megjegyzés a warranty_id mezőhöz (nem kötelező). Leírását lásd lentebb!
  • formatted_inspection_date_note: megjegyzés a formatted_inspection_date mezőhöz (nem kötelező). Leírását lásd lentebb!
  • inspector_name_note: megjegyzés az inspector_name mezőhöz (nem kötelező). Leírását lásd lentebb!
  • service_history_note: megjegyzés a service_history mezőhöz (nem kötelező). Leírását lásd lentebb!
  • last_service_note: megjegyzés a last_service mezőhöz (nem kötelező). Leírását lásd lentebb!
  • fuel_type_note: megjegyzés a fuel_type_id mezőhöz (nem kötelező). Leírását lásd lentebb!

Eredmények, results mező

Itt egy tömböt kell megadni, melynek elemei objektumok. A formája megegyezik a Jelenlegi-foglalások kimenetén belül a list elemen belüli tomb egy elemének formájával, annyi eltéréssel, hogy nem kell tartalmaznia minden mezőt. Ha elhagyjuk ezt a mezőt, akkor nem történik eremény mentés egyáltalán.
Itt az egyes objektumok a táblázat egy-egy csoportját írják le, továbbá a Bodywork csoportban ez tartalmazza az autó képének adatait. Paraméterek:

  • group_title: a csoport megnevezése. Kötelező megadni, ha a csoportot menteni szeretnénk
  • rows: a táblázat csoporton belüli sorait tartalmazó tömb. Leírását lásd lentebb.
Eredmények táblázat sorai, rows

Ez egy tömb, amelynek elemei objektumok. Egy-egy objektum a táblázat egy sora, vagy a karosszéria egy eleme. Az objektum várt elemei (nagyon hasonlít a Jelenlegi-foglalások esetén visszaadott sorokhoz. Ebből hiányozhat néhány elem, valamint a képeket nem URL-két kell átadni):

  • id: a sor azonosítója. Ha csak módosítani szeretnénk egy sort, ezt küldeni kell.
  • title: megnevezés. Kötelező mező.
  • slug: URL barát megnevezés.
  • score: Pontszám. NA, vagy 1 és 5 közé eső egész szám, amellyel osztályozzuk az adott tulajdonságát az autónak.
  • note: Opcionális megjegyzés az adott sorhoz, vagy karosszéria elemhez.
  • images: Az aktuális sorhoz kapcsolt képek. Leírását lásd lentebb.

Képek mentése

A fentebb említett képeket menteni úgy lehet, hogy base64 kódolással küldjük fel. Minden esetben egy tömbött kell a mezőben küldeni, amelynek elemei objektumok. Minden kép egy objektum. Az objektumnak egyetlen eleme kell legyen image kulccsal, amely a base64 kódolt karakterláncot tartalmazza. Fontos, hogy csak a karakterlánc legyen, tehát PNG kép esetén a data:image/png;base64, NE legyen benne! A képet a progam menti úgy, ahogy van, valamint készít belőle egy 64x64px méretű kis képet 75-ös minőséggel.

PDF dokumentumok mentése

A fentebb említett PDF dokumentumokat menteni úgy lehet, hogy base64 kódolással küldjük fel. Minden esetben egy tömbött kell a mezőben küldeni, amelynek elemei objektumok. Minden PDF egy objektum. Az objektumnak egyetlen eleme kell legyen pdf kulccsal, amely a base64 kódolt karakterláncot tartalmazza. Fontos, hogy csak a karakterlánc legyen, tehát PDF esetén a data:application/pdf;base64, NE legyen benne! A PDF dokumentumot a progam menti úgy, ahogy van.

Válasz

Amennyiben nincs hiba, a válasz egy 3 elemű objektum.

  • success: true az értéke. Jelzi, hogy sikerült a mentés.
  • modify: true az értéke, ha módosítva lett egy foglalás, false pedig új tételt rögzítettünk.
  • bookingId: a módosított, vagy létrehozott foglalás azonosítója.