Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Zasób

Zasób AddressBook

reprezentuję

 reprezentuję książkę adresową.

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

Code Block
GET /v1/organizations/:id_organizacji/address_books

Pojedynczy wpis można pobrać

Code Block
GET /v1/organizations/:id_organizacji/address_books/:id_adresu
Panel
bgColor#f0f0f0
titleBGColor#f0f0f0
titleNa tej stronie

Table of Contents
minLevel2
 

Uwierzytelnianie

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

 

Struktura

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

AtrybutTyp
Opis
 
id
Integer
integerunikalny identyfikator
name
String
string

nazwa wpisu, unikalna w kontekście ogranizacji

first_name
String
stringImię
last_name
String
stringNazwisko
phone
String
stringTelefon
email
String
stringAdres e-mail
organization_id
Integer
integeridentyfikator
organizacji
orgranizacji, która jest właścicielem tego wpisu
main_address
Object
objectAdres główny adresata
delivery_address
Object
objectAdres dostarczenia przesyłki
sender_parcelbooleanNadawca przesyłek paczkomatowych
sender_courierbooleanNadawca przesyłek kurierskich
sender_letterbooleanNadawca przesyłek listowych
kind
String
stringRodzaj 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

Code Block
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

Code Block
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ź

Code Block
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
id
Integer
integerIdentyfikator adresu

Przykład zapytania

Code Block
GET /v1/address_books/123


Przykładowa odpowiedź

Code Block
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
name
String
string

Atrybut jest wymagany.

maksymalnie
  • Maksymalnie 255 znaków
  • Unikalny w kontekście organizacji
first_name
String
string

Atrybut jest wymagany.

maksymalnie
  • Maksymalnie 255 znaków
last_name
String
string

Atrybut jest wymagany.

maksymalnie
  • Maksymalnie 255 znaków
phone
String
string

Atrybut jest wymagany.

maksymalnie
  • Maksymalnie 255 znaków
  • 9 znaków
  • Wyłącznie cyfry
email
String
string

Atrybut jest wymagany.

maksymalnie maksymalnie
  • Maksymalnie 255 znaków
  • Format zgodny ze standardem RFC 5322 oraz RFC 5321
kind
String
  • wymagane
  • string

    Atrybut jest wymagany.

    • Maksymalnie 255 znaków
    dozwolone
    • Dopuszczalne wartości
    : wymagane
    • (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
    Objectwymagane

    Create Address Form

    Atrybut jest wymagany.

    delivery_address
    Object
    Create Address Form

    Atrybut jest wymagany.

    sender_parcel
    Booleandomyślna wartość: domyślna wartość:
    boolean

    Atrybut nie jest wymagany.

    • Domyślna wartość false
    sender_courier
    Boolean
    boolean

    Atrybut nie jest wymagany.

    • Domyślna wartość false
    sender_letter
    Boolean
    • domyślna wartość: false
    boolean

    Atrybut nie jest wymagany.

    • Domyślna wartość false

     

    Przykład zapytania

    Code Block
    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ź

    Code Block
    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 parametr id jest  jest podawany jako parametr GET.

    Parametry

     

       nameString
    • wymagany
    • maksymalnie 255 znaków
    ParametrTypOpis
    id
    Integer
    • identyfikator adresu
    integer

    Atrybut nie jest wymagany.

    • Identyfikator adresu
    namestring

    Atrybut jest wymagany.

    • Maksymalnie 255 znaków
    • Unikalny w kontekście organizacji
    first_name
    String
    string

    Atrybut jest wymagany.

    maksymalnie
    • Maksymalnie 255 znaków
    last_name
    String
    string

    Atrybut jest wymagany.

    maksymalnie
    • Maksymalnie 255 znaków
    phone
    String
    string

    Atrybut jest wymagany.

    maksymalnie
    • Maksymalnie 255 znaków
    • 9 znaków
    • Wyłącznie cyfry
    email
    String
    string

    Atrybut jest wymagany.

    maksymalnie
    • Maksymalnie 255 znaków
    • Format zgodny ze standardem RFC 5322 oraz RFC 5321
    kind
    Stringwymagane
    string

    Atrybut jest wymagany.

    • maksymalnie 255 znaków
    dozwolone
    • Dopuszczalne wartości
    : wymagane
    • (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
    Objectwymagane
    Create Address Form

    Atrybut jest wymagany.

    delivery_address
    Object
    Create Address Form

    Atrybut jest wymagany.

    sender_parcel
    Booleandomyślna wartość: domyślna wartość:
    boolean

    Atrybut nie jest wymagany.

    • Domyślna wartość false
    sender_courier
    Boolean
    boolean

    Atrybut nie jest wymagany.

    • Domyślna wartość false
    sender_letter
    Boolean
    • domyślna wartość: false
    boolean

    Atrybut nie jest wymagany.

    • Domyślna wartość false

     

    Przykład zapytania

    Code Block
    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ź

    Code Block
    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
    id
    Integer
    integerIdentyfikator adresu

    Przykład zapytania

    Code Block
    DELETE /v1/address_books/123