[1.6.0] Użytkownicy

Zasób User reprezentuje obiekt użytkownika, który uzyskuje dostęp do danych API ShipX.

Użytkownik identyfikowany jest za pomocą unikalnego numeru, zwanego InPost ID. Numer ten jest niezmienny. 

Uwierzytelnianie

Dostęp do zasobu wymaga podania prawidłowego i ważnego access tokenu dla Organizacji.

 

Struktura

Zasób User posiada następujące atrybuty:

Atrybut

Typ

Opis

Atrybut

Typ

Opis

id

Integer

Unikalny identyfikator użytkownika (InPost ID).

email

String

Adres e-mail przypisany do konta użytkownika.

first_name

String

Imię użytkownika.

last_name

String

Nazwisko użytkownika.

status

String

Status użytkownika

updated_at

DateTime

Ostatnia aktualizacja profilu użytkownika.

created_at

DateTime

Data utworzenia profilu użytkownika.

Przykład zasobu User w formacie JSON:

1 2 3 4 5 6 7 8 9 10 { "href": "https://api-shipx-pl.easypack24.net/v1/users/1", "id": 1, "email": "example@email.com", "first_name": "Bogus", "last_name": "Name", "status": "active", "updated_at": "2015-09-29T15:22:00.000+02:00", "created_at": "2015-09-29T15:22:00.000+02:00" }

 

Lista użytkowników

Pobieranie listy użytkowników Organizacji.

Dostęp do zasobu:

  • Właściciel organizacji ma dostęp do pełnej listy użytkowników

  • Zwykły użytkownik organizacji widzi na liście tylko siebie

 

Zasób jest stronicowany. Więcej informacji na stronie https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/11731055

1 GET /v1/organizations/:id_organizacji/users

Kryteria wyszukiwania

Parametr

Opis

Parametr

Opis

q

Pozwala na wyszukiwanie użytkowników po zadanej frazie.

Sortowanie wyników

Parametr

Opis

Parametr

Opis

sort_by

Określa atrybut po którym mają zostać posortowane wyniki.
Domyślnie: id
Możliwe: id, email, phone, full_name, created_at 

sort_order

Określa rodzaj sortowania - w kolejności malejącej (desc) lub rosnącej (asc).
Domyślnie: rosnąco (asc)
Możliwe: asc, desc

Przykład zapytania

1 curl -X GET https://api-shipx-pl.easypack24.net/v1/users -H 'Authorization: Bearer token' -H 'Content-Type: application/json'

Odpowiedź

W odpowiedzi na przesłane zapytanie serwer zwróci kolekcję z listą obiektów zasobu User.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 HTTP/1.1 200 OK Content-Type: application/json { "href": "https://api-shipx-pl.easypack24.net/v1/users", "count": 123, "page": 1, "per_page": 30, "items": [ { "href": "https://api-shipx-pl.easypack24.net/v1/users/1", "id": 1, "email": "example@email.com", "first_name": "Bogus", "last_name": "Name", "status": "active", "updated_at": "2015-09-29T15:22:00.000+02:00", "created_at": "2015-09-29T15:22:00.000+02:00" }, {...} ] }