GET api/CompanyAddress?id_id={id_id}&id_company={id_company}&sort={sort}&search={search}&skip={skip}&take={take}

Returns the list of Company category with filter applied.

Request Information

URI Parameters

Name	Description	Type	Additional information
id_id		integer	None.
id_company		integer	None.
sort		string	None.
search	Possible search - "seria", "number".	string	None.
skip	Sets the SKIP number of records returned	integer	None.
take	Sets the TAKE number records returned	integer	None.

Body Parameters

None.

Response Information

Resource Description

Collection of ApiCompanyAddress

Name	Description	Type	Additional information
id		integer	None.
street_number		string	None.
route		string	None.
locality		string	None.
aal1		string	None.
aal2		string	None.
country		string	None.
postal_code		string	None.
is_main		boolean	None.
is_default_billing		boolean	None.
is_default_delivery		boolean	None.
id_company		integer	None.
company	read only	Object	None.
comment		string	None.
date		date	None.
verification		boolean	None.
is_subscribed		boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "street_number": "sample string 2",
    "route": "sample string 3",
    "locality": "sample string 4",
    "aal1": "sample string 5",
    "aal2": "sample string 6",
    "country": "sample string 7",
    "postal_code": "sample string 8",
    "is_main": true,
    "is_default_billing": true,
    "is_default_delivery": true,
    "id_company": 1,
    "company": {},
    "comment": "sample string 13",
    "date": "2024-11-16T05:05:42.5130612+00:00",
    "verification": true,
    "is_subscribed": true
  },
  {
    "id": 1,
    "street_number": "sample string 2",
    "route": "sample string 3",
    "locality": "sample string 4",
    "aal1": "sample string 5",
    "aal2": "sample string 6",
    "country": "sample string 7",
    "postal_code": "sample string 8",
    "is_main": true,
    "is_default_billing": true,
    "is_default_delivery": true,
    "id_company": 1,
    "company": {},
    "comment": "sample string 13",
    "date": "2024-11-16T05:05:42.5130612+00:00",
    "verification": true,
    "is_subscribed": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfApiCompanyAddress xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ApiCompanyAddress>
    <id>1</id>
    <street_number>sample string 2</street_number>
    <route>sample string 3</route>
    <locality>sample string 4</locality>
    <aal1>sample string 5</aal1>
    <aal2>sample string 6</aal2>
    <country>sample string 7</country>
    <postal_code>sample string 8</postal_code>
    <is_main>true</is_main>
    <is_default_billing>true</is_default_billing>
    <is_default_delivery>true</is_default_delivery>
    <id_company>1</id_company>
    <company />
    <comment>sample string 13</comment>
    <date>2024-11-16T05:05:42.5130612+00:00</date>
    <verification>true</verification>
    <is_subscribed>true</is_subscribed>
  </ApiCompanyAddress>
  <ApiCompanyAddress>
    <id>1</id>
    <street_number>sample string 2</street_number>
    <route>sample string 3</route>
    <locality>sample string 4</locality>
    <aal1>sample string 5</aal1>
    <aal2>sample string 6</aal2>
    <country>sample string 7</country>
    <postal_code>sample string 8</postal_code>
    <is_main>true</is_main>
    <is_default_billing>true</is_default_billing>
    <is_default_delivery>true</is_default_delivery>
    <id_company>1</id_company>
    <company />
    <comment>sample string 13</comment>
    <date>2024-11-16T05:05:42.5130612+00:00</date>
    <verification>true</verification>
    <is_subscribed>true</is_subscribed>
  </ApiCompanyAddress>
</ArrayOfApiCompanyAddress>