Page tree
Skip to end of metadata
Go to start of metadata

Zasób User reprezentuje obiekt użytkownika, który uzyskuje dostęp do danych platformy Ship X.

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

Na tej stronie

 

Uwierzytelnianie

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

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

AtrybutTypOpis
hrefStringAbsolutny URL do zasobu.
idIntegerUnikalny identyfikator użytkownika (InPost ID).
emailStringAdres e-mail przypisany do konta użytkownika.
first_nameStringImię użytkownika.
last_nameStringNazwisko użytkownika.
statusStringStatus użytkownika
updated_atDateTimeOstatnia aktualizacja profilu użytkownika.
created_atDateTimeData utworzenia profilu użytkownika.

Przykład zasobu User w formacie JSON:

{
	"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 Organizacji

Pobieranie listy użytkowników Organizacji:

GET /v1/organizations/:id_organizacji/users

(info) Zasób jest stronicowany. 

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.

Parametry

ParametrOpis
sort_byOkreśla atrybut po którym mają zostać posortowane wyniki.
Domyślnie: id
Możliwe: id, email, phone, full_name, created_at 
sort_orderOkreśla rodzaj sortowania - w kolejności malejącej (desc) lub rosnącej (asc).
Domyślnie: rosnąco (asc)
Możliwe: asc, desc
qPozwala na wyszukiwanie użytkowników po zadanej frazie.


Przykład zapytania

$ curl https://axa.shipx.pl.easypack24.net/v1/users \
	-H 'Authorization: Bearer lkfjasd9f70y43ohriw...[ommited for brevity]...'

Odpowiedź

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

HTTP/1.1 200 OK
Content-Type: application/json
 
{
	"href": "https://axa.shipx.pl.easypack24.net/v1/users",
	"count": 123,
	"page": 1,
	"per_page": 30,
	"items": [
		{
			"href": "https://axa.shipx.pl.easypack24.net/v1/users/1",
			"id": 1,
			... other User's attributes omitted for brevity ...
		},
		{
			"href": "https://axa.shipx.pl.easypack24.net/v1/users/2",
			"id": 2,
			... other User's attributes omitted for brevity ...
		}
		... other collection's items omitted for brevity ...
	]
}
  • No labels