BackofficeApi

<back to all web services

SearchPlaceRequest

Backoffice
Requires Authentication
Required role:Backoffice
The following routes are available for this service:
GET/place/search
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BackofficeApi

Namespace Global

    Namespace BackofficeApi

        Public Enum BusinessRole
            Owner
            Manager
            Sales
            Marketing
            Other
        End Enum

        Public Partial Class PlaceAddress
            Public Property Street As String
            Public Property PostalCode As String
            Public Property Region As String
            Public Property CountryCode As String
        End Class

        Public Partial Class PlaceContact
            Public Property Phone As String
            Public Property Email As String
            Public Property Website As String
            Public Property WebShop As String
        End Class

        Public Enum PlaceState
            Draft
            Active
            Paused
            Archived
        End Enum

        Public Partial Class TimeZoneDto
            Public Property BaseUtcOffset As TimeSpan
            Public Property DaylightName As String
            Public Property DisplayName As String
            Public Property Id As String
            Public Property StandardName As String
            Public Property SupportsDaylightSavingTime As Boolean
        End Class
    End Namespace
End Namespace

VB.NET 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
}