Skip to content
/
List 'Address'

Common (2.0.0)

The 'Common' application of the Core API

Download OpenAPI description
Download Postman Collection
Download OpenAPI Specification (json)
Download OpenAPI Specification (yaml)
Languages
Servers
https://{environment}.pigello.io

Swedishreferencerate

Operations

Address

Operations

Bulk write 'Address'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Bodyapplication/jsonArray [
streetstring<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ \d\(\)\.\-:’']+$'required
postal_codestring<= 16 characters'^[A-Za-z0-9 \-]{3,10}$'required
citystring<= 255 charactersrequired
countrystring<= 255 charactersrequired
longitudenumber or null(float)[ -180 .. 180 ]
street_numberstring or null<= 255 characters'^\d+(\d*-\d+)*[A-Za-zÅÄÖåäö]*$'
care_ofstring or null<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ0-9()/&'#., -]+$'
attentionstring or null<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ0-9()/&'#., -]+$'
latitudenumber or null(float)[ -90 .. 90 ]
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
]
curl -i -X POST \
  https://dev.api.pigello.io/common/address/list/ \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '[
    {
      "longitude": -180,
      "street_number": "string",
      "care_of": "string",
      "street": "string",
      "postal_code": "string",
      "attention": "string",
      "latitude": -90,
      "custom_id": "string",
      "city": "string",
      "country": "string",
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

streetstring<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ \d\(\)\.\-:’']+$'required
postal_codestring<= 16 characters'^[A-Za-z0-9 \-]{3,10}$'required
citystring<= 255 charactersrequired
countrystring<= 255 charactersrequired
longitudenumber or null(float)[ -180 .. 180 ]
created_atstring(date-time)read-only
street_numberstring or null<= 255 characters'^\d+(\d*-\d+)*[A-Za-zÅÄÖåäö]*$'
care_ofstring or null<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ0-9()/&'#., -]+$'
attentionstring or null<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ0-9()/&'#., -]+$'
latitudenumber or null(float)[ -90 .. 90 ]
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
]
Response
application/json
[
  {
    "longitude": -180,
    "created_at": "2019-08-24T14:15:22Z",
    "street_number": "string",
    "care_of": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "street": "string",
    "postal_code": "string",
    "attention": "string",
    "latitude": -90,
    "custom_id": "string",
    "city": "string",
    "country": "string",
    "organization": { … }
  }
]

List 'Address'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Query
_jsonlboolean
_order_byArray of strings
Example: _order_by=field_a,-field_b
_pageinteger(int32)>= 1

Additional Validation Information:

This value must be set together with the following fields: _page_size

_page_sizeinteger(int32)

Additional Validation Information:

This value must be set together with the following fields: _page

_searchstring
_slimboolean
_statisticsboolean
buildingsArray of objects
global_realestatesArray of objects
global_segmentsArray of objects
outdoor_areasArray of objects
parking_lotsArray of objects
attentionany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

care_ofany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

cityany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

countryany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

created_atany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

custom_idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

latitudeany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

longitudeany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

organizationany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

postal_codeany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

streetany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

street_numberany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

curl -i -X GET \
  'https://dev.api.pigello.io/common/address/list/?_jsonl=true&_order_by=field_a%2C-field_b&_page=1&_page_size=0&_search=string&_slim=true&_statistics=true' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful query

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

streetstring<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ \d\(\)\.\-:’']+$'required
postal_codestring<= 16 characters'^[A-Za-z0-9 \-]{3,10}$'required
citystring<= 255 charactersrequired
countrystring<= 255 charactersrequired
longitudenumber or null(float)[ -180 .. 180 ]
created_atstring(date-time)read-only
street_numberstring or null<= 255 characters'^\d+(\d*-\d+)*[A-Za-zÅÄÖåäö]*$'
care_ofstring or null<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ0-9()/&'#., -]+$'
attentionstring or null<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ0-9()/&'#., -]+$'
latitudenumber or null(float)[ -90 .. 90 ]
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
]
Response
application/json
[
  {
    "longitude": -180,
    "created_at": "2019-08-24T14:15:22Z",
    "street_number": "string",
    "care_of": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "street": "string",
    "postal_code": "string",
    "attention": "string",
    "latitude": -90,
    "custom_id": "string",
    "city": "string",
    "country": "string",
    "organization": { … }
  }
]

Create 'Address'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Bodyapplication/json
streetstring<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ \d\(\)\.\-:’']+$'required
postal_codestring<= 16 characters'^[A-Za-z0-9 \-]{3,10}$'required
citystring<= 255 charactersrequired
countrystring<= 255 charactersrequired
longitudenumber or null(float)[ -180 .. 180 ]
street_numberstring or null<= 255 characters'^\d+(\d*-\d+)*[A-Za-zÅÄÖåäö]*$'
care_ofstring or null<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ0-9()/&'#., -]+$'
attentionstring or null<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ0-9()/&'#., -]+$'
latitudenumber or null(float)[ -90 .. 90 ]
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
curl -i -X POST \
  https://dev.api.pigello.io/common/address/ \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '{
    "longitude": -180,
    "street_number": "string",
    "care_of": "string",
    "street": "string",
    "postal_code": "string",
    "attention": "string",
    "latitude": -90,
    "custom_id": "string",
    "city": "string",
    "country": "string",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful creation

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

streetstring<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ \d\(\)\.\-:’']+$'required
postal_codestring<= 16 characters'^[A-Za-z0-9 \-]{3,10}$'required
citystring<= 255 charactersrequired
countrystring<= 255 charactersrequired
longitudenumber or null(float)[ -180 .. 180 ]
created_atstring(date-time)read-only
street_numberstring or null<= 255 characters'^\d+(\d*-\d+)*[A-Za-zÅÄÖåäö]*$'
care_ofstring or null<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ0-9()/&'#., -]+$'
attentionstring or null<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ0-9()/&'#., -]+$'
latitudenumber or null(float)[ -90 .. 90 ]
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
Response
application/json
{
  "longitude": -180,
  "created_at": "2019-08-24T14:15:22Z",
  "street_number": "string",
  "care_of": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "street": "string",
  "postal_code": "string",
  "attention": "string",
  "latitude": -90,
  "custom_id": "string",
  "city": "string",
  "country": "string",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Get 'Address'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
curl -i -X GET \
  'https://dev.api.pigello.io/common/address/{pk}/' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful selection

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

streetstring<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ \d\(\)\.\-:’']+$'required
postal_codestring<= 16 characters'^[A-Za-z0-9 \-]{3,10}$'required
citystring<= 255 charactersrequired
countrystring<= 255 charactersrequired
longitudenumber or null(float)[ -180 .. 180 ]
created_atstring(date-time)read-only
street_numberstring or null<= 255 characters'^\d+(\d*-\d+)*[A-Za-zÅÄÖåäö]*$'
care_ofstring or null<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ0-9()/&'#., -]+$'
attentionstring or null<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ0-9()/&'#., -]+$'
latitudenumber or null(float)[ -90 .. 90 ]
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
Response
application/json
{
  "longitude": -180,
  "created_at": "2019-08-24T14:15:22Z",
  "street_number": "string",
  "care_of": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "street": "string",
  "postal_code": "string",
  "attention": "string",
  "latitude": -90,
  "custom_id": "string",
  "city": "string",
  "country": "string",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Delete 'Address'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
curl -i -X DELETE \
  'https://dev.api.pigello.io/common/address/{pk}/' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful deletion

Response
No content

Update 'Address'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
Bodyapplication/json
streetstring<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ \d\(\)\.\-:’']+$'required
postal_codestring<= 16 characters'^[A-Za-z0-9 \-]{3,10}$'required
citystring<= 255 charactersrequired
countrystring<= 255 charactersrequired
longitudenumber or null(float)[ -180 .. 180 ]
street_numberstring or null<= 255 characters'^\d+(\d*-\d+)*[A-Za-zÅÄÖåäö]*$'
care_ofstring or null<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ0-9()/&'#., -]+$'
attentionstring or null<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ0-9()/&'#., -]+$'
latitudenumber or null(float)[ -90 .. 90 ]
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
curl -i -X PATCH \
  'https://dev.api.pigello.io/common/address/{pk}/' \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '{
    "longitude": -180,
    "street_number": "string",
    "care_of": "string",
    "street": "string",
    "postal_code": "string",
    "attention": "string",
    "latitude": -90,
    "custom_id": "string",
    "city": "string",
    "country": "string",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful update

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

streetstring<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ \d\(\)\.\-:’']+$'required
postal_codestring<= 16 characters'^[A-Za-z0-9 \-]{3,10}$'required
citystring<= 255 charactersrequired
countrystring<= 255 charactersrequired
longitudenumber or null(float)[ -180 .. 180 ]
created_atstring(date-time)read-only
street_numberstring or null<= 255 characters'^\d+(\d*-\d+)*[A-Za-zÅÄÖåäö]*$'
care_ofstring or null<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ0-9()/&'#., -]+$'
attentionstring or null<= 255 characters'^[A-Za-zÀ-ÖØ-öø-ÿ0-9()/&'#., -]+$'
latitudenumber or null(float)[ -90 .. 90 ]
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
Response
application/json
{
  "longitude": -180,
  "created_at": "2019-08-24T14:15:22Z",
  "street_number": "string",
  "care_of": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "street": "string",
  "postal_code": "string",
  "attention": "string",
  "latitude": -90,
  "custom_id": "string",
  "city": "string",
  "country": "string",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Eventlog

Operations

Swedishpricebasevalue

Operations
© Pigello. All rights reserved.