BackofficeApi

SearchPlaceRequest

Backoffice

**Requires Authentication**
Required role:	Backoffice

The following routes are available for this service:
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 .xml suffix or ?format=xml

HTTP + XML

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/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SearchPlaceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BackofficeApi.Dto">
  <Offset>0</Offset>
  <Places>
    <BackofficePlaceDto>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:CountryCode>String</d4p1:CountryCode>
        <d4p1:PostalCode>String</d4p1:PostalCode>
        <d4p1:Region>String</d4p1:Region>
        <d4p1:Street>String</d4p1:Street>
      </Address>
      <BackofficeGrantedStaffAccess>
        <StaffDto>
          <BusinessId>0</BusinessId>
          <BusinessName>String</BusinessName>
          <BusinessRole>Owner</BusinessRole>
          <Email>String</Email>
          <FirstName>String</FirstName>
          <Id>0</Id>
          <LastActiveOn xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
            <d6p1:DateTime>0001-01-01T00:00:00Z</d6p1:DateTime>
            <d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
          </LastActiveOn>
          <LastName>String</LastName>
          <MobileNumber>String</MobileNumber>
          <PlaceId>0</PlaceId>
          <PlaceName>String</PlaceName>
          <Role>Owner</Role>
          <UserId>0</UserId>
        </StaffDto>
      </BackofficeGrantedStaffAccess>
      <BusinessId>0</BusinessId>
      <Claimed>false</Claimed>
      <Contact xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:Email>String</d4p1:Email>
        <d4p1:Phone>String</d4p1:Phone>
        <d4p1:WebShop>String</d4p1:WebShop>
        <d4p1:Website>String</d4p1:Website>
      </Contact>
      <CountryCode>String</CountryCode>
      <Guid>00000000-0000-0000-0000-000000000000</Guid>
      <Id>0</Id>
      <Latitude>0</Latitude>
      <Longitude>0</Longitude>
      <Name>String</Name>
      <OrganizationNumber>String</OrganizationNumber>
      <Overview>String</Overview>
      <RootCategory>
        <AbsoluteSlug>String</AbsoluteSlug>
        <Id>0</Id>
        <Name>String</Name>
        <ParentId>0</ParentId>
        <Position>0</Position>
        <Slug>String</Slug>
        <State>String</State>
      </RootCategory>
      <State>Draft</State>
      <TimeZoneDto xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:BaseUtcOffset>PT0S</d4p1:BaseUtcOffset>
        <d4p1:DaylightName>String</d4p1:DaylightName>
        <d4p1:DisplayName>String</d4p1:DisplayName>
        <d4p1:Id>String</d4p1:Id>
        <d4p1:StandardName>String</d4p1:StandardName>
        <d4p1:SupportsDaylightSavingTime>false</d4p1:SupportsDaylightSavingTime>
      </TimeZoneDto>
    </BackofficePlaceDto>
  </Places>
  <Size>0</Size>
  <Total>0</Total>
</SearchPlaceResponse>