Dodaj ali uredi lokacije

DODAJ LOKACIJE

URL: api/locations
HTTP metoda klica: PUT
Parametri glave klica (Request headers): FindApiKey, FindApiAuthenticationToken
HTTP koda rezultata: 200, 401, 400, 403
Format vhodnih podatkov: application/json

Vhodni podatki:

Vhodni podatki lahko vsebujejo več objektov, ki so združeni v JSON množici (ang. array). Podatki označeni z (*) so obvezni. Ostale atribute lahko iz zahteve izključite ali jih pošljete z vrednostjo "null".

• * id (string); unikatna oznaka lokacije v GUID formatu. Če je atribut prazen (ang. empty string), ga sistem avtomatsko generira.
• * code (string)
• * name (string)
• description (string)

Primer vhodnih podatkov:

[
  {
    "id": "",
    "code": "000001",
    "name": "Test Location 1",
    "description": "This is extra description"
  },
  {
    "id": "",
    "code": "000002",
    "name": "Test Location 2",
    "description": "This is extra description"
  },
  {
    "id": "",
    "code": "000003",
    "name": "Test Location 3",
    "description": "This is extra description"
  }
]

Izhodni podatki:

• id (string); unikatna oznaka kreiranih lokacij v GUID formatu.

Primer izhodnih podatkov:

{
  "row_count": 3,
  "total_count": 3,
  "data": [
    {
      "id": "13de921d-db3a-4b1f-8c26-75154c60549b"
    },
    {
      "id": "a7f4cc9d-9cac-4098-aa3a-9b13ce0ca6ad"
    },
    {
      "id": "232cafe0-663b-4730-ae42-c31866c5f1d1"
    }
  ]
}

UREDI LOKACIJE

Lokacije lahko urejamo tako, da pošljemo enaki klic, kot v primeru kreiranja, le da v zahtevi vključimo id lokacije katerega želimo urediti.

Vhodni podatki:

Enako kot pri kreiranju lokacije.

Primer vhodnih podatkov:

[
  {
    "id": "d567eac3-c7ff-41d2-b555-45c5e8593b2a",
    "code": "000001",
    "name": "Location 1",
    "description": "This is extra description"
  },
  {
    "id": "a356b7b1-7dbb-49b4-92e9-ef11eaca3156",
    "code": "000002",
    "name": "Location 2",
    "description": "This is extra description"
  },
  {
    "id": "006a4f17-3466-4c66-8fa4-a00c4bc3799e",
    "code": "000003",
    "name": "Location 3",
    "description": "This is extra description"
  }
]

IZBRIŠI LOKACIJO

URL: api/locations/{id}
HTTP metoda klica: DELETE
Parametri glave klica (Request headers): FindApiKey, FindApiAuthenticationToken
HTTP koda rezultata: 200, 401, 403, 404
Format vhodnih podatkov: application/json

Vhodni podatki:

• {id}; id lokacije v URL naslovu klica

Primer vhodnih podatkov:

DELETE api/locations/006a4f17-3466-4c66-8fa4-a00c4bc3799e