Adresář

Download schema

Správa uložených kontaktů.

Seznam kontaktů

GET

https://test.zaslat.cz/api/v1

/contacts/list

x-apikey (header)

Vrátí seznam uložených kontaktů v adresáři.

Seznam kontaktů › Responses

Seznam kontaktů.

status

integer

message

string

Error[]

object

Objekt kontaktů klíčovaný jejich identifikátorem.

GET/contacts/list

curl https://test.zaslat.cz/api/v1/contacts/list \
  --header 'x-apikey: <api-key>'

Example Responses

{
  "status": 200,
  "message": "OK. Found 2 item(s).",
  "data": {
    "1001": {
      "id": 1001,
      "firstname": "Jaroslav",
      "surname": "Novotný",
      "company": "Zaslat s.r.o.",
      "street": "Jindřišská 12/1027",
      "city": "Praha 4",
      "zip": "14000",
      "country": "CZ",
      "phone": "+420777152225",
      "email": "novotny@dummymail.com"
    },
    "1002": {
      "id": 1002,
      "firstname": "Alena",
      "surname": "Šimková",
      "street": "Jánská 42",
      "city": "Brno",
      "zip": "60200",
      "country": "CZ",
      "phone": "+420603001552",
      "email": "simkova.alena@dummymail.com"
    }
  }
}

json

application/json

Přidání kontaktů

POST

https://test.zaslat.cz/api/v1

/contacts/add

x-apikey (header)

Přidá jeden nebo více kontaktů do adresáře.

Přidání kontaktů › Request Body

Contact[] · required

Přidání kontaktů › Responses

Kontakty byly vytvořeny.

ContactIdsResponse

status

integer

message

string

Error[]

data

integer[]

Pole identifikátorů dotčených kontaktů.

POST/contacts/add

curl https://test.zaslat.cz/api/v1/contacts/add \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-apikey: <api-key>' \
  --data '{
  "contacts": [
    {
      "firstname": "Jaroslav",
      "surname": "Novotný",
      "company": "Zaslat s.r.o.",
      "street": "Jindřišská 12/1027",
      "city": "Praha 4",
      "zip": "14000",
      "country": "CZ",
      "phone": "+420777152225",
      "email": "novotny@dummymail.com"
    },
    {
      "firstname": "Alena",
      "surname": "Šimková",
      "street": "Jánská 42",
      "city": "Brno",
      "zip": "60200",
      "country": "CZ",
      "phone": "+420603001552",
      "email": "simkova.alena@dummymail.com"
    }
  ]
}'

Example Request Body

{
  "contacts": [
    {
      "firstname": "Jaroslav",
      "surname": "Novotný",
      "company": "Zaslat s.r.o.",
      "street": "Jindřišská 12/1027",
      "city": "Praha 4",
      "zip": "14000",
      "country": "CZ",
      "phone": "+420777152225",
      "email": "novotny@dummymail.com"
    },
    {
      "firstname": "Alena",
      "surname": "Šimková",
      "street": "Jánská 42",
      "city": "Brno",
      "zip": "60200",
      "country": "CZ",
      "phone": "+420603001552",
      "email": "simkova.alena@dummymail.com"
    }
  ]
}

json

application/json

Example Responses

{
  "status": 200,
  "message": "2 contacts successfuly added.",
  "data": [
    1000,
    1001
  ]
}

json

application/json

Úprava kontaktů

POST

https://test.zaslat.cz/api/v1

/contacts/edit

x-apikey (header)

Upraví existující kontakty podle jejich id.

Úprava kontaktů › Request Body

Contact[] · required

Úprava kontaktů › Responses

Kontakty byly upraveny.

ContactIdsResponse

status

integer

message

string

Error[]

data

integer[]

Pole identifikátorů dotčených kontaktů.

Smazání kontaktů

POST

https://test.zaslat.cz/api/v1

/contacts/delete

x-apikey (header)

Smaže vybrané kontakty z adresáře podle jejich id.

Smazání kontaktů › Request Body

contacts

integer[] · required

Pole identifikátorů kontaktů ke smazání.

Smazání kontaktů › Responses

Kontakty byly smazány.

Základní tvar odpovědi bez datové části.

StatusMessageResponse

status

integer

HTTP stavový kód odpovědi.

Example: 200

message

string

Textová zpráva k provedené akci.

Example: OK

Error[]

Podací a výdejní místa

Přidání kontaktů

POST

https://test.zaslat.cz/api/v1

/contacts/add

x-apikey (header)

Přidá jeden nebo více kontaktů do adresáře.

Přidání kontaktů › Request Body

Contact[] · required

Přidání kontaktů › Responses

Kontakty byly vytvořeny.

ContactIdsResponse

status

integer

message

string

Error[]

data

integer[]

Pole identifikátorů dotčených kontaktů.

Úprava kontaktů

POST

https://test.zaslat.cz/api/v1

/contacts/edit

x-apikey (header)

Upraví existující kontakty podle jejich id.

Úprava kontaktů › Request Body

Contact[] · required

Úprava kontaktů › Responses

Kontakty byly upraveny.

ContactIdsResponse

status

integer

message

string

Error[]

data

integer[]

Pole identifikátorů dotčených kontaktů.

Smazání kontaktů

POST

https://test.zaslat.cz/api/v1

/contacts/delete

x-apikey (header)

Smaže vybrané kontakty z adresáře podle jejich id.

Smazání kontaktů › Request Body

contacts

integer[] · required

Pole identifikátorů kontaktů ke smazání.

Smazání kontaktů › Responses

Kontakty byly smazány.

Základní tvar odpovědi bez datové části.

StatusMessageResponse

status

integer

HTTP stavový kód odpovědi.

Example: 200

message

string

Textová zpráva k provedené akci.

Example: OK

Error[]