diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index f03c3b2ef..67aeb99e3 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -3846,6 +3846,7 @@ No Request Body:

Get Client Image (DATA URI)

+

Optional arguments are identical to those of Get Client Image (Binary file)

Example Requests:

clients/1/images

@@ -3853,6 +3854,8 @@ No Request Body:
GET https://DomainName/api/v1/clients/{clientId}/images +Accept: text/plain + data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJ @@ -3869,10 +3872,37 @@ gAEAOg13B6R/SAgAAAAASUVORK5CYII=

Get Client Image (Binary file)

+
Optional Arguments
+
+
output
+
+ String optional one of octet or inline_octet +
+
The query parameter overrides the "Accept" Header and sets the Media Type to "application/octet-stream"
+ octet : Returns the image binary file as an attachment. The Content-Disposition header is set to attachment;filename=somefile.ext
+ inline_octet :The Content-Disposition header is set to inline;filename=somefile.ext +
+
maxWidth
+
+ Integer optional +
+
Triggers resizing of the image to the defined width
+ +
maxHeight
+
+
+ Integer optional +
+ +
Triggers resizing of the image to the defined height
+ + +
GET https://DomainName/api/v1/clients/{clientId}/images +Accept: application/octet-stream POST clients/1/images