| Required role: | Backoffice |
| GET | /place/search |
|---|
export module BackofficeApi
{
// @ts-nocheck
export enum PlaceState
{
Draft = 'Draft',
Active = 'Active',
Paused = 'Paused',
Archived = 'Archived',
}
export class TimeZoneDto
{
public baseUtcOffset?: string;
public daylightName: string;
public displayName: string;
public id: string;
public standardName: string;
public supportsDaylightSavingTime?: boolean;
public constructor(init?: Partial<TimeZoneDto>) { (Object as any).assign(this, init); }
}
export class PlaceContact
{
public phone?: string;
public email?: string;
public website?: string;
public webShop?: string;
public constructor(init?: Partial<PlaceContact>) { (Object as any).assign(this, init); }
}
export class PlaceAddress
{
public street: string;
public postalCode: string;
public region: string;
public countryCode: string;
public constructor(init?: Partial<PlaceAddress>) { (Object as any).assign(this, init); }
}
export enum BusinessRole
{
Owner = 'Owner',
Manager = 'Manager',
Sales = 'Sales',
Marketing = 'Marketing',
Other = 'Other',
}
}
TypeScript SearchPlaceRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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}