BusinessApi

<back to all web services

PlaceUploadImageRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
POST/place/upload_image
PlaceUploadImageRequest Parameters:
NameParameterData TypeRequiredDescription
PlaceIdbodylongNo
Base64EncodedImageFrontbodystringNo
PlaceUploadImageResponse Parameters:
NameParameterData TypeRequiredDescription
ImageformCloudBlobYes
ImageUrlsformImageUrlsYes
CloudBlob Parameters:
NameParameterData TypeRequiredDescription
PublicUrlformstringYes
KeyformstringYes
EnvironmentformDeploymentSlot?No
BucketformstringYes
IdentifyingSuffixformstringYes
MimeTypeformstringYes
DeploymentSlot Enum:
Production
Qa
Unstable
Test
Local
Docker
ImageUrls Parameters:
NameParameterData TypeRequiredDescription
PreviewformstringYes
SmallformstringYes
MediumformstringYes
LargeformstringYes

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.

POST /place/upload_image HTTP/1.1 
Host: business-api.brovs.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	placeId: 0,
	base64EncodedImageFront: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	image: 
	{
		publicUrl: String,
		key: String,
		environment: Production,
		bucket: String,
		identifyingSuffix: String,
		mimeType: String
	},
	imageUrls: 
	{
		preview: String,
		small: String,
		medium: String,
		large: String
	}
}