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

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

Zasób AddressBook reprezentuję książkę adresową.

Książka adresowa dla Organizacji dostępna jest pod

GET /v1/organizations/:id_organizacji/address_books

Pojedynczy wpis można pobrać

GET /v1/organizations/:id_organizacji/address_books/:id_adresu
Na tej stronie

 

Uwierzytelnianie

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

 

Struktura

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

AtrybutTyp 
idintegerunikalny identyfikator
namestring

nazwa wpisu, unikalna w kontekście ogranizacji

first_namestringImię
last_namestringNazwisko
phonestringTelefon
emailstringAdres e-mail
organization_idintegeridentyfikator orgranizacji, która jest właścicielem tego wpisu
main_addressobjectAdres główny adresata
delivery_addressobjectAdres dostarczenia przesyłki
sender_parcelbooleanNadawca przesyłek paczkomatowych
sender_courierbooleanNadawca przesyłek kurierskich
sender_letterbooleanNadawca przesyłek listowych
kindstringRodzaj wpisu
company_namestringNazwa firmy
preferred_dropoff_pointstringPreferowany punkt nadawczy
created_atDateTimeData utworzenia
updated_atDateTimeData 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":"http://localhost:3000/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

ParametrTypOpis
idintegerIdentyfikator 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

ParametrTypOpis
namestring

Atrybut jest wymagany.

  • Maksymalnie 255 znaków
  • Unikalny w kontekście organizacji
first_namestring

Atrybut jest wymagany.

  • Maksymalnie 255 znaków
last_namestring

Atrybut jest wymagany.

  • Maksymalnie 255 znaków
phonestring

Atrybut jest wymagany.

  • Maksymalnie 255 znaków
  • 9 znaków
  • Wyłącznie cyfry
emailstring

Atrybut jest wymagany.

  • Maksymalnie 255 znaków
  • Format zgodny ze standardem RFC 5322 oraz RFC 5321
kindstring

Atrybut jest wymagany.

  • Maksymalnie 255 znaków
  • Dopuszczalne wartości (sender, receiver)
company_namestring

Atrybut nie jest wymagany.

  • Maksymalnie 255 znaków
preferred_dropoff_pointstring

Atrybut nie jest wymagany.

  • Maksymalnie 255 znaków
main_address

Create Address Form

Atrybut jest wymagany.

delivery_addressCreate Address Form

Atrybut jest wymagany.

sender_parcelboolean

Atrybut nie jest wymagany.

  • Domyślna wartość false
sender_courierboolean

Atrybut nie jest wymagany.

  • Domyślna wartość false
sender_letterboolean

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

ParametrTypOpis
idinteger

Atrybut nie jest wymagany.

  • Identyfikator adresu
namestring

Atrybut jest wymagany.

  • Maksymalnie 255 znaków
  • Unikalny w kontekście organizacji
first_namestring

Atrybut jest wymagany.

  • Maksymalnie 255 znaków
last_namestring

Atrybut jest wymagany.

  • Maksymalnie 255 znaków
phonestring

Atrybut jest wymagany.

  • Maksymalnie 255 znaków
  • 9 znaków
  • Wyłącznie cyfry
emailstring

Atrybut jest wymagany.

  • Maksymalnie 255 znaków
  • Format zgodny ze standardem RFC 5322 oraz RFC 5321
kindstring

Atrybut jest wymagany.

  • maksymalnie 255 znaków
  • Dopuszczalne wartości (sender, receiver)
company_namestring

Atrybut nie jest wymagany.

  • Maksymalnie 255 znaków
preferred_dropoff_pointstring

Atrybut nie jest wymagany.

  • Maksymalnie 255 znaków
main_addressCreate Address Form

Atrybut jest wymagany.

delivery_addressCreate Address Form

Atrybut jest wymagany.

sender_parcelboolean

Atrybut nie jest wymagany.

  • Domyślna wartość false
sender_courierboolean

Atrybut nie jest wymagany.

  • Domyślna wartość false
sender_letterboolean

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

ParametrTypOpis
idintegerIdentyfikator adresu

Przykład zapytania

DELETE /v1/address_books/123
  • No labels