BackofficeApi

<back to all web services

PlaceAddRequest

Backoffice
Requires Authentication
Required role:Backoffice
The following routes are available for this service:
POST/place/add
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class BackofficeApi
{

    public static class PlaceAddress
    {
        public String street = null;
        public String postalCode = null;
        public String region = null;
        public String countryCode = null;
        
        public String getStreet() { return street; }
        public PlaceAddress setStreet(String value) { this.street = value; return this; }
        public String getPostalCode() { return postalCode; }
        public PlaceAddress setPostalCode(String value) { this.postalCode = value; return this; }
        public String getRegion() { return region; }
        public PlaceAddress setRegion(String value) { this.region = value; return this; }
        public String getCountryCode() { return countryCode; }
        public PlaceAddress setCountryCode(String value) { this.countryCode = value; return this; }
    }

    public static enum PlaceState
    {
        Draft,
        Active,
        Paused,
        Archived;
    }

    public static class TimeZoneDto
    {
        public TimeSpan baseUtcOffset = null;
        public String daylightName = null;
        public String displayName = null;
        public String id = null;
        public String standardName = null;
        public Boolean supportsDaylightSavingTime = null;
        
        public TimeSpan getBaseUtcOffset() { return baseUtcOffset; }
        public TimeZoneDto setBaseUtcOffset(TimeSpan value) { this.baseUtcOffset = value; return this; }
        public String getDaylightName() { return daylightName; }
        public TimeZoneDto setDaylightName(String value) { this.daylightName = value; return this; }
        public String getDisplayName() { return displayName; }
        public TimeZoneDto setDisplayName(String value) { this.displayName = value; return this; }
        public String getId() { return id; }
        public TimeZoneDto setId(String value) { this.id = value; return this; }
        public String getStandardName() { return standardName; }
        public TimeZoneDto setStandardName(String value) { this.standardName = value; return this; }
        public Boolean isSupportsDaylightSavingTime() { return supportsDaylightSavingTime; }
        public TimeZoneDto setSupportsDaylightSavingTime(Boolean value) { this.supportsDaylightSavingTime = value; return this; }
    }

    public static class PlaceContact
    {
        public String phone = null;
        public String email = null;
        public String website = null;
        public String webShop = null;
        
        public String getPhone() { return phone; }
        public PlaceContact setPhone(String value) { this.phone = value; return this; }
        public String getEmail() { return email; }
        public PlaceContact setEmail(String value) { this.email = value; return this; }
        public String getWebsite() { return website; }
        public PlaceContact setWebsite(String value) { this.website = value; return this; }
        public String getWebShop() { return webShop; }
        public PlaceContact setWebShop(String value) { this.webShop = value; return this; }
    }

    public static enum BusinessRole
    {
        Owner,
        Manager,
        Sales,
        Marketing,
        Other;
    }

}

Java PlaceAddRequest 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.

POST /place/add HTTP/1.1 
Host: backoffice-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PlaceAddRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BackofficeApi.Dto">
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Common">
    <d2p1:CountryCode>String</d2p1:CountryCode>
    <d2p1:PostalCode>String</d2p1:PostalCode>
    <d2p1:Region>String</d2p1:Region>
    <d2p1:Street>String</d2p1:Street>
  </Address>
  <BusinessId>0</BusinessId>
  <Name>String</Name>
  <OrganizationNumber>String</OrganizationNumber>
  <RootCategoryAbsoluteSlug>String</RootCategoryAbsoluteSlug>
</PlaceAddRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PlaceAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BackofficeApi.Dto">
  <Place>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
      <d3p1:CountryCode>String</d3p1:CountryCode>
      <d3p1:PostalCode>String</d3p1:PostalCode>
      <d3p1:Region>String</d3p1:Region>
      <d3p1:Street>String</d3p1:Street>
    </Address>
    <BackofficeGrantedStaffAccess>
      <StaffDto>
        <BusinessId>0</BusinessId>
        <BusinessName>String</BusinessName>
        <BusinessRole>Owner</BusinessRole>
        <Email>String</Email>
        <FirstName>String</FirstName>
        <Id>0</Id>
        <LastActiveOn xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>0001-01-01T00:00:00Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1: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:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
      <d3p1:Email>String</d3p1:Email>
      <d3p1:Phone>String</d3p1:Phone>
      <d3p1:WebShop>String</d3p1:WebShop>
      <d3p1:Website>String</d3p1: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:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
      <d3p1:BaseUtcOffset>PT0S</d3p1:BaseUtcOffset>
      <d3p1:DaylightName>String</d3p1:DaylightName>
      <d3p1:DisplayName>String</d3p1:DisplayName>
      <d3p1:Id>String</d3p1:Id>
      <d3p1:StandardName>String</d3p1:StandardName>
      <d3p1:SupportsDaylightSavingTime>false</d3p1:SupportsDaylightSavingTime>
    </TimeZoneDto>
  </Place>
</PlaceAddResponse>