BackofficeApi

<back to all web services

SearchPlaceRequest

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

public class BackofficeApi
{

    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 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 BusinessRole
    {
        Owner,
        Manager,
        Sales,
        Marketing,
        Other;
    }

}

Java SearchPlaceRequest DTOs

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 /place/search HTTP/1.1 
Host: backoffice-api.brovs.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}