LT API Metodai
1.Patekimas į teritoriją
1.1. Atpažinto numerio siuntimas
|
Pavadinimas |
Atpažinto numerio siuntimas |
|
|
URL |
/api/V1/CarArrived |
|
|
Metodas |
POST (API CRM) |
|
|
URL Parametrai |
Reikalaujama: { CamId: [string], ScanId: [integer], CarNr: [string] } |
Pavyzdys: { „ScanId“: 3, „CarNumber“: „AAA111“, „CamId“: „a0657dde-dac1-409d-be7a-f2713715c554“ } |
|
Sėkmingas atsakymas |
Grąžinama: { } |
Pavyzdys: { } |
|
Klaidingas atsakymas |
Pavyzdys: { error: „Wrong data“ } |
|
|
Parametrų aprašymas |
CamId – kameros GUID ScanId – unikalus veiksmo numeris šitai kamerai CarNr – atpažintas transporto priemonės numeris |
|
1.2. Pranešimo atvaizdavimas švieslentėje
|
Pavadinimas |
Pranešimo atvaizdavimas švieslentėje |
|
|
URL |
/api/V1/DisplayText/{BoardId:GUID} |
|
|
Metodas |
POST (API ScaleExpert) |
|
|
URL Parametrai |
Reikalaujama: { Text: [string] } |
Pavyzdys: { „Text“: „Užvažiuokite ant svarstyklių“ } |
|
Sėkmingas atsakymas |
Grąžinama: { } |
Pavyzdys: { } |
|
Klaidingas atsakymas |
Pavyzdys: { error: „Wrong data“ } |
|
|
Parametrų aprašymas |
BoardId - švieslentės GUID Text – atvaizduojamo pranešimo tekstas |
|
1.3. Užtvaros valdymas
|
Pavadinimas |
Užtvaros valdymas |
|
|
URL |
/api/V1/PlcDeviceManipulation/{DeviceId:GUID} |
|
|
Metodas |
POST (API ScaleExpert) |
|
|
URL Parametrai |
Reikalaujama: { Cmd: [string] } |
Pavyzdys: { „Cmd“: „ allow“ or “prevent” } |
|
Sėkmingas atsakymas |
Grąžinama: { } |
Pavyzdys: { } |
|
Klaidingas atsakymas |
Pavyzdys: { error: „Wrong data“ } |
|
|
Parametrų aprašymas |
DeviceId – užtvaros identifikatorius Cmd (open, close) – komanda, kurį turi būti įvykdyta su užtvara |
|
1.4. Užtvaros pozicija
|
Pavadinimas |
Užtvaros statusas |
|
|
URL |
/api/V1/BarrierState |
|
|
Metodas |
GET (API ScaleExpert) |
|
|
URL Parametrai |
Reikalaujama: { BarrierId: [string] } |
Pavyzdys: { „BarrierId“: „6150e1d0-aab0-4ed2-8df0-040a1a839764“ } |
|
Sėkmingas atsakymas |
Grąžinama: { State: [string] } |
Pavyzdys: { „State“: „closed“ } |
|
Klaidingas atsakymas |
Pavyzdys: { error: „Wrong data“ } |
|
|
Parametrų aprašymas |
BarrierId – užtvaros identifikatorius State (closed, opened, closing, opening, unknown, error) – užtvaros padėties būsena |
|
2. Iškvietimo švieslentė
|
Pavadinimas |
Iškviečiamų transporto priemonių sąrašo gavimas |
|
|
URL |
/api/V1/ ExternalApiCommunicator/Cars |
|
|
Metodas |
POST (API CRM) |
|
|
URL Parametrai |
Reikalaujama: { StartTime: [datetime], EndTime: [datetime] } |
Pavyzdys: { „StartTime“: „2024-09-24 08:00“, „EndTime“: „2024-09-24 09:00“ } |
|
Sėkmingas atsakymas |
Grąžinama: [ { VehicleNumber: [string], Gate: [integer] }, { VehicleNumber: [string], Gate: [integer] } ] |
Pavyzdys: [ { „VehicleNumber“: „AAA111“, „Gate“: 3 }, { „VehicleNumber“: „BBB222“, „Gate“: 2 } ] |
|
Klaidingas atsakymas |
Pavyzdys: { error: „Wrong data“} |
|
|
Parametrų aprašymas |
StartTime – transporto priemonės užsakymo pradžios laikas EndTime – transporto priemonės užsakymo pabaigos laikas VehicleNumber – transporto priemonės numeris Gate – vartų numeris |
|
3. Svėrimas
3.1. Atpažinto numerio siuntimas
Žiūrėti 1.1 punktą 1 puslapyje.
3.2. Komanda pasverti
|
Pavadinimas |
Komanda pasverti |
|
|
URL |
/api/V1/StartWeighingByCarNr/{DeviceId:GUID} |
|
|
Metodas |
POST (API ScaleExpert) |
|
|
URL Parametrai |
Reikalaujama: { CarNr: [string] } |
Pavyzdys: { „CarNr“: „AAA111“ } |
|
Sėkmingas atsakymas |
Grąžinama: { } |
Pavyzdys: { } |
|
Klaidingas atsakymas |
Pavyzdys: { error: „Wrong data“ } |
|
|
Parametrų aprašymas |
CarNr – atpažintas transporto priemonės numeris |
|
3.3. Pasverto svorio grąžinimas
|
Pavadinimas |
Pasverto svorio grąžinimas (callback function) |
|
|
URL |
/api/V1/WeighingDone |
|
|
Metodas |
POST (API CRM) |
|
|
URL Parametrai |
Reikalaujama: { DeviceId: [GUID], WeighingId: [integer], Weight: [double], CarNr: [string] } |
Pavyzdys: { „DeviceId“: “91A14708-FE64-4081-A833-182ABFD9E8CC”, „ WeighingId“: 3, „Weight“: 32800, „CarNr“: „AAA111“ } |
|
Sėkmingas atsakymas |
Grąžinama: { } |
Pavyzdys: { } |
|
Klaidingas atsakymas |
Pavyzdys: { error: „Wrong data“ } |
|
|
Parametrų aprašymas |
WeighingId – svėrimo identifikatorius Weight – svoris CarNr – pasvertos transporto priemonės numeris |
|
4. Transporto priemonės
Naudojamas esamas API Swagger UI (scales.lt)
Atvykus transporto priemonei, ji turi būti sukurta sistemoje, naudojant sekantį metodą:
|
Pavadinimas |
Transporto priemonių kūrimas |
|
|
URL |
/api/Vehicles/v1/create |
|
|
Metodas |
POST (API ScaleExpert) |
|
|
URL Parametrai |
Reikalaujama: { plateNumber: [string], isEnabled: [bool] } |
Pavyzdys: { „plateNumber“: „21812471217“, „isEnabled“: true } |
|
Sėkmingas atsakymas |
Grąžinama: { plateNumber: [string], isEnables: [bool], type: [string], state: [string], ... } |
Pavyzdys: { „plateNumber“: „21812471217“, „isEnables“: true, „type“: „car“, „state“: „outside“, ... } |
|
Klaidingas atsakymas |
Pavyzdys: { error: „Wrong data“ } |
|
|
Parametrų aprašymas |
plateNumber – transporto priemonės numeris isEnabled (true/false) – transporto priemonės aktyvumo būsen |
|
Tam, kad pasitikrinti ar tam tikra transporto priemonė jau yra sukurta sistemoje, yra galimybė peržiūrėti esamas transporto priemonės, naudojant sekantį metodą:
|
Pavadinimas |
Transporto priemonių peržiūra |
|
|
URL |
/api/Vehicles/v1 |
|
|
Metodas |
POST (API ScaleExpert) |
|
|
URL Parametrai |
Reikalaujama: { filters: [ { field: [string], operator: [string], value: [string] } ] } |
Pavyzdys: { „filters“: [ { „field“: „plateNumber“, „operator“: „eq“, „value“: „21812471217“ } ] } |
|
Sėkmingas atsakymas |
Grąžinama: [ { plateNumber: [string], isEnables: [bool], type: [string], state: [string], ... }, { plateNumber: [string], isEnables: [bool], type: [string], state: [string], ... } ] |
Pavyzdys: [ { „plateNumber“: „21812471217“, „isEnables“: true, „type“: „car“, „state“: „outside“, ... }, „plateNumber“: „03912471534“, „isEnables“: true, „type“: „car“, „state“: „outside“, ... } ] |
|
Klaidingas atsakymas |
Pavyzdys: { error: „Wrong data“ } |
|
|
Parametrų aprašymas |
plateNumber – transporto priemonės numeris isEnabled (true/false) – transporto priemonės aktyvumo būsena |
|
Pastaba. Pasibaigus tam tikros transporto priemonės rezultatui, ji deaktyvuojama.
Esant atvykusiai jau esančiai sistemoje transporto priemonei, ji turi būti aktyvuojama, naudojant transporto priemonės atnaujinimo metodą:
|
Pavadinimas |
Transporto priemonių atnaujinimas |
|
|
URL |
/api/Vehicles/v1/update/{id} |
|
|
Metodas |
PUT (API ScaleExpert) |
|
|
URL Parametrai |
Reikalaujama: { Id: [integer], plateNumber: [string], isEnabled: [bool] } |
Pavyzdys: { „Id“: „2“, „plateNumber“: „21812471217“, „isEnabled“: true } |
|
Sėkmingas atsakymas |
Grąžinama: { plateNumber: [string], isEnables: [bool], type: [string], state: [string], ... } |
Pavyzdys: { „plateNumber“: „21812471217“, „isEnables“: true, „type“: „car“, „state“: „outside“, ... } |
|
Klaidingas atsakymas |
Pavyzdys: { error: „Wrong data“ } |
|
|
Parametrų aprašymas |
Id – transporto priemonės identifikatorius plateNumber – transporto priemonės numeris isEnabled (enabled/disabled) – transporto priemonės aktyvumo būsena |
|
Visų transporto priemonių periode svėrimų/rezultatų gavimas vykdomas, sekančio metodo pagalba:
|
Pavadinimas |
Transporto priemonių periode rezultatų gavimas |
|
|
URL |
/api/Results/v1/all |
|
|
Metodas |
POST (API ScaleExpert) |
|
|
URL Parametrai |
Reikalaujama: { filters: [ { field: [string], operator: [string], value: [string], logic: [string] }, { field: [string], operator: [string], value: [string] } ], fields: [string] } |
Pavyzdys: { "filters": [ { "field": "Date", "operator": "gte", "value": "2024-06-10 00:00", "logic": "And" }, { "field": "Date", "operator": "lt", "value": "2024-06-11 00:00" } ], "fields": "Id,Date,Sender,Receiver,Carrier,Vehicle, Driver,ExternalCode,Products,Add1,Add2,Add5, ToAddress,FromAddress,Neto,Modified" } |
|
Sėkmingas atsakymas |
Grąžinama: [ { Id: [integer], Date: [datetime], Vehicle: { id: [integer], plateNumber: [string], state: [string] }, Tare: { time: [datetime], weight: [integer] }, Bruto: { time: [datetime], weight: [integer] }, ... }, { Id: [integer], Date: [datetime], ... }, ... ] |
Pavyzdys: [ { "Id": 290, "Date": "2024-04-22T11:36:00", "Vehicle": { "id": 25, "plateNumber": "21812471217", "state": "Outside" }, "Tare": { "time": null, "weight": null }, "Bruto": { "time": "2024-04-22T11:35:00", "weight": 12400 }, ... }, { "Id": 290, "Date": "2024-04-22T11:36:00", ... }, ... ] |
|
Klaidingas atsakymas |
Pavyzdys: { error: „Wrong data“ } |
|