REST - Client - Logo

REST-Interface

Back to overview

Get file

Loading logo of current client.
URL
GET <application-url>/api/client/logo

Query parameter

  • size
    possible values: s, l, t
    s - small (400px width)
    l - large (800px width)
    t - thumbnail (200px width)

Produces
File as stream

  • 200 OK
  • 204 NO CONTENT
  • 404 NOT FOUND
  • 500 INTERNAL_SERVER_ERROR

Permission
Login

Sample
GET http://localhost:8080/mtr-backend/api/client/logo?size=t


Update logo and skin

URL
PUT <application-url>/api/client/logo

Query parameter

  • contextToken
    This token is used to identify the temporarily uploaded file (logo)

Consumes

application/json
application/xml

com.matterial.mtr.api.object.Client

You should only fill the three skinColours, that you want to store:

{ 
  "jsonType": "Client",
  "skinColourButton": "red",
  "skinColourNotification": "blue",
  "skinColourLabel": "orange"
}

Produces

application/json
application/xml

com.matterial.mtr.api.object.Client

  • 200 OK
  • 400 BAD_REQUEST
  • 500 INTERNAL_SERVER_ERROR

Permission
instanceOwnerRequired

Sample
PUT http://localhost:8080/mtr-backend/api/client/logo?contextToken=5b3f2a1c-4a7d-49a3-bfeb-41d0e1e3835d


Remove logo

Remove the logo from current client: Removes the cas-file and the casid from db.
URL
DELETE <application-url>/api/client/logo

Produces

text/plain

Integer - count

  • 200 OK
  • 400 BAD_REQUEST
  • 500 INTERNAL_SERVER_ERROR

Permission
instanceOwnerRequired

Sample
DELETE http://localhost:8080/mtr-backend/api/client/logo

×