The current API provides support for the addition of a single
- image for a Client
+ image for entities like Client (URL pattern /clients) and Staff (URL pattern /staff)
Allowed formats: JPEG (.jpg or .jpeg), GIF (.gif) and PNG (.png)
The API supports two different Approaches for manipulating Client Images +
The API supports two different Approaches for manipulating Images
Optional arguments are identical to those of Get Client Image (Binary file)
+Optional arguments are identical to those of Get Image associated with an Entity (Binary file)
Example Requests:
-POST clients/1/images
+GET clients/1/images
Accept: application/octet-stream
@@ -4803,7 +4824,7 @@ Accept: application/octet-stream
- Upload an Image for a Client (Data URI)
+ Upload an Image for an Entity (Data URI)
@@ -4831,7 +4852,7 @@ P9/AFGGFyjOXZtQAAAAAElFTkSuQmCC
- Upload an Image for a Client (Multi-part Form data)
+ Upload an Image for an Entity (Multi-part Form data)
Mandatory Fields
@@ -4871,7 +4892,7 @@ Request Body: Not shown
- Update a Client Image (Data URI)
+ Update a Image associated with an Entity (Data URI)
@@ -4899,7 +4920,7 @@ P9/AFGGFyjOXZtQAAAAAElFTkSuQmCC
- Update a Client Image (Multi-part Form data)
+ Update an Entity's Image (Multi-part Form data)
Mandatory Fields
@@ -4932,7 +4953,7 @@ Request Body: Not shown
- Delete a Client Image
+ Delete an Entity's Image
@@ -16767,252 +16788,7 @@ Request Body:
-
-
-
- Staff Images
- The current API provides support for the addition of a single
- image for a Staff Member
- Allowed formats: JPEG (.jpg or .jpeg), GIF (.gif) and PNG (.png)
-
- The API supports two different Approaches for manipulating Staff Images
-
- - Data URI's:
- For easier manipulation by Javascript clients etc in supported Browsers.
-
- -
- Multi-part form data:
- Images can be uploaded using Multi part forms and downloaded as regular binary files
-
-
-
-
-
-
-
- Upload an Image for a Staff (Data URI)
-
-
-
-POST https://DomainName/api/v1/staff/{staffId}/images
-
-
-POST staff/1/images
-Content-Type: text/plain
-Request Body:
-data:image/png;base64,iVBORw0KGgoAA
-AANSUhEUgAAABAAAAAQAQMAAAAlPW0iAAAABlBMVEUAAAD///+l2Z/dAAAAM0l
-EQVR4nGP4/5/h/1+G/58ZDrAz3D/McH8yw83NDDeNGe4Ug9C9zwz3gVLMDA/A6
-P9/AFGGFyjOXZtQAAAAAElFTkSuQmCC
-
-
-{
- "resourceId": 1,
- "changes": {},
- "resourceIdentifier": "1"
-}
-
-
-
-
-
-
- Upload an Image for a Staff Member (Multi-part Form data)
-
-
- Mandatory Fields
-
-
- file
-
-
-
-
- The form should contain a required named body part with the
- name "file".
- If you are using a HTML form, a snippet like
- <input type="file" name="file"></input>
- can be used for uploading the image file
-
-
-
-
-POST https://DomainName/api/v1/staff/{staffId}/images
-
-
-POST staff/1/images
-Content-Type: multipart/form-data
-Request Body: Not shown
-
-
-{
- "resourceId": 1,
- "changes": {},
- "resourceIdentifier": "1"
-}
-
-
-
-
-
-
-
- Get Staff Image (DATA URI)
- Optional arguments are identical to those of Get Staff Image (Binary file)
- Example Requests:
- staff/1/images
-
-
-
-
-GET https://DomainName/api/v1/staff/{staffId}/images
-Accept: text/plain
-
-
-
-data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJ
-bWFnZVJlYWR5ccllPAAAAJ1JREFUeNpi+P//PwMIA4E9EG8E4idQDGLbw+WhiiqA+D8OXAFVAzbp
-DxBvB2JLIGaGYkuoGEjOhhFIHAbij0BdPgxYACMj42ogJQpifwBiXSDeC8JIbt4LxSC5DyxQjTeB
-+BeaYb+Q5EBOAVutCzMJHUNNPADzzDokiYdAfAmJvwLkGeTgWQfyKZICS6hYBTwc0QL8ORSjBDhA
-gAEAOg13B6R/SAgAAAAASUVORK5CYII=
-
-
-
-
-
-
-
- Get Staff 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/staff/{staffId}/images
-Accept: application/octet-stream
-
-
-POST staff/1/images
-Accept: application/octet-stream
-
-
-Not shown: The corresponding binary (image) file
-
-
-
-
-
-
-
- Update a Staff Image (Data URI)
-
-
-
-PUT https://DomainName/api/v1/staff/{staffId}/images
-
-
-PUT staff/1/images
-Content-Type: text/plain
-Request Body:
-data:image/png;base64,iVBORw0KGgoAA
-AANSUhEUgAAABAAAAAQAQMAAAAlPW0iAAAABlBMVEUAAAD///+l2Z/dAAAAM0l
-EQVR4nGP4/5/h/1+G/58ZDrAz3D/McH8yw83NDDeNGe4Ug9C9zwz3gVLMDA/A6
-P9/AFGGFyjOXZtQAAAAAElFTkSuQmCC
-
-
-{
- "resourceId": 1,
- "changes": {},
- "resourceIdentifier": "1"
-}
-
-
-
-
-
-
-
- Update a Staff Member Image (Multi-part Form data)
-
-
- Mandatory Fields
-
-
- file
-
-
-
-
- The form should contain a required named body part with the
- name "file".
- If you are using a HTML form, a snippet like
- <input type="file" name="file"></input>
- can be used for uploading the image file
-
-
-
-
-PUT https://DomainName/api/v1/staff/{staffId}/images
-
-
-PUT staff/1/images
-Content-Type: multipart/form-data
-Request Body: Not shown
-
-
-
-
-
-
-
- Delete a Staff Image
-
-
-
-DELETE https://DomainName/api/v1/staff/{staffId}/images
-
-
-DELETE staff/1/images
-Content-Type: application/json
-No Request Body:
-
-
-{
- "resourceId": 1,
- "changes": {},
- "resourceIdentifier": "1"
-}
-
-
-
-
@@ -19705,7 +19481,6 @@ Content-Type: application/json
Optional: If provided, used along with lockinPeriodFrequencyType to indicate the length of time that the recurring deposit account is 'locked in' and premature closure is not allowed. e.g. 2 Months lockinPeriodFrequencyType Optional: If provided, used along with lockinPeriodFrequency to indicate the length of time that the recurring deposit account is 'locked in' and premature closure is not allowed. 0=Days, 1=Weeks, 2=Months, 3=Years
e.g. 2 Months recurringDepositFrequency
- Staff Images
+ Staff Images
staff/{staffId}/images
- Upload an Image for a Staff Member (as DATA URI)
- Get Staff Image (DATA URI)
- Update Staff Image (DATA URI)
- Delete Staff Image
+ Upload an Image for a Staff Member (as DATA URI)
+ Get Staff Image (DATA URI)
+ Update Staff Image (DATA URI)
+ Delete Staff Image
+
Upload an Image for a Staff Member (Multi-part form data)
- Get Staff Image (Binary file)
-
+ Get Staff Image (Binary file)
+
Update Staff Image (Multi-part form data)