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 Foundation
import ServiceStack

public enum PlaceState : String, Codable
{
    case Draft
    case Active
    case Paused
    case Archived
}

public class TimeZoneDto : Codable
{
    @TimeSpan public var baseUtcOffset:TimeInterval
    public var daylightName:String
    public var displayName:String
    public var id:String
    public var standardName:String
    public var supportsDaylightSavingTime:Bool

    required public init(){}
}

public class PlaceContact : Codable
{
    public var phone:String
    public var email:String
    public var website:String
    public var webShop:String

    required public init(){}
}

public class PlaceAddress : Codable
{
    public var street:String
    public var postalCode:String
    public var region:String
    public var countryCode:String

    required public init(){}
}

public enum BusinessRole : String, Codable
{
    case Owner
    case Manager
    case Sales
    case Marketing
    case Other
}


Swift 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
}