PREGLED PODATKOV VSEH LOKACIJ
URL: api/locations
HTTP metoda klica: GET
Parametri glave klica (Request headers): FindApiKey, FindApiAuthenticationToken
HTTP koda rezultata: 200, 401
Vhodni podatki:
- start (int); pozicija kurzorja v URL naslovu klica
- count (int): št. elementov v URL naslovu klica
Primer vhodnih podatkov:
GET api/locations?start=0&count=100
OPOMBA: V primeru, da parametrov v zahtevi ne navedete se upoštevajo privzete vrednosti:
Izhodni podatki:
- id (string)
- code (string)
- name (string)
- description (string)
- new_name (string)
- is_new (bool)
Primer izhodnih podatkov:
{
"row_count": 3,
"total_count": 3,
"data": [
{
"id": "d567eac3-c7ff-41d2-b555-45c5e8593b2a",
"code": "000001",
"name": "Location 1",
"description": "",
"is_new": false,
"new_name": null
},
{
"id": "a356b7b1-7dbb-49b4-92e9-ef11eaca3156",
"code": "000002",
"name": "Location 2",
"description": "This is extra description",
"is_new": false,
"new_name": null
},
{
"id": "006a4f17-3466-4c66-8fa4-a00c4bc3799e",
"code": "000003",
"name": "Location 3",
"description": "This is extra description",
"is_new": false,
"new_name": null
}
]
}PREGLED PODATKOV POSAMEZNE LOKACIJE
URL: api/locations/{id}
HTTP metoda klica: GET
Parametri glave klica (Request headers): FindApiKey, FindApiAuthenticationToken
HTTP koda rezultata: 200, 401, 404
Vhodni podatki:
- {id}; id lokacije v URL naslovu klica
Primer vhodnih podatkov:
GET api/locations/d567eac3-c7ff-41d2-b555-45c5e8593b2a
Izhodni podatki:
Struktura podatov je enaka kot pri izpisu vseh lokacij, le da je v tem primeru vrnjena samo ena entiteta.