BackofficeApi

<back to all web services

BusinessSearchRequest

Backoffice
Requires Authentication
Required role:Backoffice
The following routes are available for this service:
GET/business/search
BusinessSearchRequest Parameters:
NameParameterData TypeRequiredDescription
QueryquerystringYes
Sizequeryint?No
Offsetqueryint?No
BusinessSearchResponse Parameters:
NameParameterData TypeRequiredDescription
BusinessesformList<BusinessDto>Yes
TotalformlongNo
SizeformintNo
OffsetformintNo
BusinessDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
NameformstringYes
OrganizationNumberformstringNo
PostalAddressformstringYes
PostalCodeformstringYes
CityformstringYes
CountryformstringYes
ContactformBusinessContactNo
BusinessContact Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringYes
LastNameformstringYes
PositionformstringYes
PhoneformstringNo
EmailformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
}