[1.6.4] Książka adresowa

Uwierzytelnianie

Dostęp do zasobu wymaga podania prawidłowego i aktualnego access tokenu.

Struktura

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

Atrybut	Typ	Opis
id	integer	unikalny identyfikator
`name`	string	nazwa wpisu, unikalna w kontekście ogranizacji
`first_name`	string	Imię
`last_name`	string	Nazwisko
`phone`	string	Telefon
`email`	string	Adres e-mail
`organization_id`	integer	identyfikator orgranizacji, która jest właścicielem tego wpisu
`main_address`	object	Adres główny adresata
`delivery_address`	object	Adres dostarczenia przesyłki
`sender_parcel`	boolean	Nadawca przesyłek paczkomatowych
`sender_courier`	boolean	Nadawca przesyłek kurierskich
`sender_letter`	boolean	Nadawca przesyłek listowych
`kind`	string	Rodzaj wpisu
`company_name`	string	Nazwa firmy
`preferred_dropoff_point`	string	Preferowany punkt nadawczy
`created_at`	DateTime	Data utworzenia
`updated_at`	DateTime	Data ostatniej aktualizacji

Przykład zasobu AddressBook w formacie JSON:

Lista adresów w książce adresowej

Lista wszystkich adresów, do których użytkownik ma dostęp

GET /v1/organizations/:id_organizacji/address_books

Uprawnienia

Aby pobrać listę punktów odbioru dla określonej organizacji użytkownik musi być jej członkiem.

Przykładowe zapytanie

GET /v1/organizations/12345/address_books?sort_order=asc&sort_by=last_name&sender_letter=true HTTP/1.1
Host: api-shipx-pl.easypack24.net
Content-Type: application/json
Authorization: Bearer lkfjasd9f70y43ohriw...[ommited for brevity]...

Odpowiedź

HTTP/1.1 200 OK
Content-Type: application/json
 
{  
   "href":"https://api-shipx-pl.easypack24.net/v1/address_books?sender_letter=true\u0026sort_by=last_name\u0026sort_order=asc",
   "count":1,
   "page":1,
   "per_page":30,
   "items":[  
      {  
         "id":5,
         "first_name":"Jan",
         "last_name":"Nowak",
         "email":"jan@nowak.pl",
         "phone":"123456789",
         "created_at":"2016-02-24T09:22:27.212+01:00",
         "updated_at":"2016-02-24T09:22:27.212+01:00",
         "organization_id":1,
         "name":"Nowak Corp",
         "sender_parcel":false,
         "sender_courier":false,
         "sender_letter":true,
		 "kind": "sender",
  		 "company_name": "MyCompanyName",
    	 "preferred_dropoff_point": "KRA120",
		 "main_address":{
			"id": "123",
            "street": "Malborska",
    		"building_number": "130",
            "city":"Warsaw","id": "123",
            "post_code":"33-666",
            "country_code":"PO"
         },
         "delivery_address":{
			"id": "123",
            "street": "Malborska",
    		"building_number": "140",
            "city":"Cracow",
            "post_code":"66-666",
            "country_code":"AZ"
         }
      }
   ]
}

Pobieranie informacji o adresie

Można pobrać informacje o adresie na podstawie jego ID

Parametry

Parametr	Typ	Opis
`id`	integer	Identyfikator adresu

Przykład zapytania

GET /v1/address_books/123

Przykładowa odpowiedź

HTTP/1.1  
Content-Type: application/json; charset=utf-8

{
  "id": 6,
  "first_name": "Jan",
  "last_name": "nowak",
  "email": "jan@nowak.pl",
  "phone": "123456789",
  "created_at": "2016-02-24T09:22:35.032+01:00",
  "updated_at": "2016-02-24T09:22:35.032+01:00",
  "organization_id": 1,
  "name": "Nowak Corp",
  "sender_parcel": true,
  "sender_courier": false,
  "sender_letter": true,
  "kind": "receiver",
  "company_name": "MyCompanyName",
  "preferred_dropoff_point": "KRA120",
  "main_address": {
	"id": "123",
    "street": "Malborska",
    "building_number": "130",
    "city": "Cracow",
    "post_code": "33-666",
    "country_code": "PO"
  },
  "delivery_address": {
	"id": "123",
    "street": "Malborska",
    "building_number": "130",
    "city": "Warsow",
    "post_code": "66-666",
    "country_code": "AZ"
  }
}

Dodawanie nowego adresu

Za pomocą tej metody można dodać nowy adres do organizacji.

Parametry

Parametr	Typ	Opis
`name`	string	Atrybut jest wymagany. Maksymalnie 255 znaków Unikalny w kontekście organizacji
`first_name`	string	Atrybut jest wymagany. Maksymalnie 255 znaków
`last_name`	string	Atrybut jest wymagany. Maksymalnie 255 znaków
`phone`	string	Atrybut jest wymagany. Maksymalnie 255 znaków 9 znaków Wyłącznie cyfry
`email`	string	Atrybut jest wymagany. Maksymalnie 255 znaków Format zgodny ze standardem RFC 5322 oraz RFC 5321
`kind`	string	Atrybut jest wymagany. Maksymalnie 255 znaków Dopuszczalne wartości (`sender, receiver`)
`company_name`	string	Atrybut nie jest wymagany. Maksymalnie 255 znaków
preferred_dropoff_point	string	Atrybut nie jest wymagany. Maksymalnie 255 znaków
`main_address`	Create Address Form	Atrybut jest wymagany.
`delivery_address`	Create Address Form	Atrybut jest wymagany.
`sender_parcel`	boolean	Atrybut nie jest wymagany. Domyślna wartość `false`
`sender_courier`	boolean	Atrybut nie jest wymagany. Domyślna wartość `false`
`sender_letter`	boolean	Atrybut nie jest wymagany. Domyślna wartość `false`

Przykład zapytania

POST http://localhost:3000/v1/organizations/:id_organizacji/address_books HTTP/1.1
Accept: application/json
Content-Length: 517
Content-Type: application/json

{
  "name": "Nowak Corp",
  "first_name": "Jan",
  "last_name": "Nowak",
  "email": "jan@nowak.com",
  "phone": "123456789",
  "sender_parcel": true,
  "sender_letter": true,
  "kind": "sender",
  "company_name": "MyCompanyName",
  "preferred_dropoff_point": "KRA120",
  "main_address": {
    "street": "Malborska",
    "building_number": "130",
    "city": "Warsaw",
    "post_code": "33-666",
    "country_code": "PO"
  },
  "delivery_address": {
 	"street": "Malborska",
    "building_number": "130",
    "city": "Cracow",
    "post_code": "66-666",
    "country_code": "AZ"
  }
}

Przykładowa odpowiedź

HTTP/1.1  
Content-Type: application/json; charset=utf-8

{
  "id": 7,
  "first_name": "Jan",
  "last_name": "Nowak",
  "email": "jan@nowak.com",
  "phone": "123456789",
  "created_at": "2016-02-24T10:38:03.835+01:00",
  "updated_at": "2016-02-24T10:38:03.835+01:00",
  "organization_id": 1,
  "name": "Nowak Corp",
  "sender_parcel": true,
  "sender_courier": false,
  "sender_letter": true,
  "kind": "sender",
  "company_name": "MyCompanyName",
  "preferred_dropoff_point": "KRA120",
  "main_address": {
	"id": "123",
    "street": "Malborska",
    "building_number": "130",
    "city": "Warsaw",
    "post_code": "33-666",
    "country_code": "PO"
  },
  "delivery_address": {
	"id": "123",
    "street": "Malborska",
    "building_number": "130",
    "city": "Cracow",
    "post_code": "66-666",
    "country_code": "AZ"
  }
}

Aktualizacja adresu

Za pomocą tej metody możesz zaktualizować adres. Należy pamiętać, że parametr id jest podawany jako parametr GET.

Parametry

Parametr	Typ	Opis
id	integer	Atrybut nie jest wymagany. Identyfikator adresu
`name`	string	Atrybut jest wymagany. Maksymalnie 255 znaków Unikalny w kontekście organizacji
`first_name`	string	Atrybut jest wymagany. Maksymalnie 255 znaków
`last_name`	string	Atrybut jest wymagany. Maksymalnie 255 znaków
`phone`	string	Atrybut jest wymagany. Maksymalnie 255 znaków 9 znaków Wyłącznie cyfry
`email`	string	Atrybut jest wymagany. Maksymalnie 255 znaków Format zgodny ze standardem RFC 5322 oraz RFC 5321
kind	string	Atrybut jest wymagany. maksymalnie 255 znaków Dopuszczalne wartości (`sender, receiver`)
`company_name`	string	Atrybut nie jest wymagany. Maksymalnie 255 znaków
`preferred_dropoff_point`	string	Atrybut nie jest wymagany. Maksymalnie 255 znaków
`main_address`	Create Address Form	Atrybut jest wymagany.
`delivery_address`	Create Address Form	Atrybut jest wymagany.
`sender_parcel`	boolean	Atrybut nie jest wymagany. Domyślna wartość `false`
`sender_courier`	boolean	Atrybut nie jest wymagany. Domyślna wartość `false`
`sender_letter`	boolean	Atrybut nie jest wymagany. Domyślna wartość `false`

Przykład zapytania

PUT /v1/address_books/1 HTTP/1.1
Content-Type: application/json

{
  "name": "New name",
  "first_name": "John",
  "last_name": "Smith",
  "email": "some@email.pl",
  "phone": "123456798",
  "sender_courier": true,
  "kind": "receiver",
  "company_name": "MyCompanyName",
  "preferred_dropoff_point": "KRA120",
  "main_address": {
	"id": "123",
    "street": "Malborska",
    "building_number": "130",
    "city": "Warsaw",
    "post_code": "33-333",
    "country_code": "PL"
  },
  "delivery_address": {
	"id": "123",
    "street": "Malborska",
    "building_number": "134",
    "city": "Warsaw",
    "post_code": "33-333",
    "country_code": "PL"
  }
}

Przykładowa odpowiedź

HTTP/1.1  
Content-Type: application/json; charset=utf-8

{
  "id": 7,
  "first_name": "Jan",
  "last_name": "Nowak",
  "email": "jan@nowak.com",
  "phone": "123456789",
  "created_at": "2016-02-24T10:38:03.835+01:00",
  "updated_at": "2016-02-24T10:38:03.835+01:00",
  "organization_id": 1,
  "name": "Nowak Corp",
  "sender_parcel": true,
  "sender_courier": false,
  "sender_letter": true,
  "kind": "receiver",
  "company_name": "MyCompanyName",
  "preferred_dropoff_point": "KRA120",
  "main_address": {
	"id": "123",
    "street": "Malborska",
    "building_number": "130",
    "city": "Warsaw",
    "post_code": "33-666",
    "country_code": "PO"
  },
  "delivery_address": {
	"id": "123",
    "street": "Malborska",
    "building_number": "140",
    "city": "Cracow",
    "post_code": "66-666",
    "country_code": "AZ"
  }
}

Usuwanie adresu

Za pomocą tej metody można usunąć wybrany adres z bazy danych.

Parametry

Parametr	Typ	Opis
`id`	integer	Identyfikator adresu

Przykład zapytania

DELETE /v1/address_books/123