Viviot.Api

<back to all web services

UpdateServiceImage

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, MarketplaceAdmin
The following routes are available for this service:
PUT/service/imageUpdates the image depicting a service.
UpdateServiceImage Parameters:
NameParameterData TypeRequiredDescription
ServiceIdbodystringYesService Id (GUID)
ImagebodyImageDtoYesImage object for setting image name, content and mime type.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
ImageDto Parameters:
NameParameterData TypeRequiredDescription
FileNameformstringNo
ContentformstringNo
MimeTypeformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /service/image HTTP/1.1 
Host: api.4spaces.io 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"serviceId":"00000000000000000000000000000000","image":{"fileName":"String","content":"String","mimeType":"String"},"version":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}