| Required role: | Backoffice |
| GET | /business/search |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Query | query | string | Yes | |
| Size | query | int? | No | |
| Offset | query | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Businesses | form | List<BusinessDto> | Yes | |
| Total | form | long | No | |
| Size | form | int | No | |
| Offset | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| Name | form | string | Yes | |
| OrganizationNumber | form | string | No | |
| PostalAddress | form | string | Yes | |
| PostalCode | form | string | Yes | |
| City | form | string | Yes | |
| Country | form | string | Yes | |
| Contact | form | BusinessContact | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FirstName | form | string | Yes | |
| LastName | form | string | Yes | |
| Position | form | string | Yes | |
| Phone | form | string | No | |
| form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /business/search HTTP/1.1 Host: backoffice-api.brovs.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
businesses:
[
{
id: 0,
name: String,
organizationNumber: String,
postalAddress: String,
postalCode: String,
city: String,
country: String,
contact:
{
firstName: String,
lastName: String,
position: String,
phone: String,
email: String
}
}
],
total: 0,
size: 0,
offset: 0
}