| Required role: | Backoffice |
| GET | /place/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 |
|---|---|---|---|---|
| Places | form | List<BackofficePlaceDto> | Yes | |
| Total | form | long | No | |
| Size | form | int | No | |
| Offset | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| Guid | form | Guid | No | |
| Name | form | string | Yes | |
| Longitude | form | float? | No | |
| Latitude | form | float? | No | |
| RootCategory | form | CategoryDto | No | |
| Claimed | form | bool | No | |
| OrganizationNumber | form | string | No | |
| State | form | PlaceState | No | |
| CountryCode | form | string | Yes | |
| Overview | form | string | No | |
| TimeZoneDto | form | TimeZoneDto | No | |
| BusinessId | form | long? | No | |
| Contact | form | PlaceContact | No | |
| Address | form | PlaceAddress | Yes | |
| BackofficeGrantedStaffAccess | form | List<StaffDto> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| Name | form | string | Yes | |
| Slug | form | string | Yes | |
| AbsoluteSlug | form | string | Yes | |
| ParentId | form | long? | No | |
| State | form | string | Yes | |
| Position | form | int | No |
| Draft | |
| Active | |
| Paused | |
| Archived |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BaseUtcOffset | form | TimeSpan | No | |
| DaylightName | form | string | Yes | |
| DisplayName | form | string | Yes | |
| Id | form | string | Yes | |
| StandardName | form | string | Yes | |
| SupportsDaylightSavingTime | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Phone | form | string | No | |
| form | string | No | ||
| Website | form | string | No | |
| WebShop | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Street | form | string | Yes | |
| PostalCode | form | string | Yes | |
| Region | form | string | Yes | |
| CountryCode | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| FirstName | form | string | Yes | |
| LastName | form | string | Yes | |
| form | string | No | ||
| Role | form | StaffRole | No | |
| PlaceId | form | long? | No | |
| BusinessId | form | long? | No | |
| UserId | form | long | No | |
| PlaceName | form | string | No | |
| BusinessName | form | string | No | |
| MobileNumber | form | string | Yes | |
| BusinessRole | form | BusinessRole | No | |
| LastActiveOn | form | DateTimeOffset | No |
| Owner | |
| Admin | |
| Regular |
| Owner | |
| Manager | |
| Sales | |
| Marketing | |
| Other |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /place/search HTTP/1.1 Host: backoffice-api.brovs.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"places":[{"id":0,"name":"String","longitude":0,"latitude":0,"rootCategory":{"id":0,"name":"String","slug":"String","absoluteSlug":"String","parentId":0,"state":"String","position":0},"claimed":false,"organizationNumber":"String","state":"Draft","countryCode":"String","overview":"String","timeZoneDto":{"baseUtcOffset":"PT0S","daylightName":"String","displayName":"String","id":"String","standardName":"String","supportsDaylightSavingTime":false},"businessId":0,"contact":{"phone":"String","email":"String","website":"String","webShop":"String"},"address":{"street":"String","postalCode":"String","region":"String","countryCode":"String"},"backofficeGrantedStaffAccess":[{"id":0,"firstName":"String","lastName":"String","email":"String","role":"Owner","placeId":0,"businessId":0,"userId":0,"placeName":"String","businessName":"String","mobileNumber":"String","businessRole":"Owner","lastActiveOn":"0001-01-01T00:00:00.0000000+00:00"}]}],"total":0,"size":0,"offset":0}