Logos can be uploaded per Account basis. If a sub-account does not have a Logo, the GET method returns the parent Account’s Logos by default. Header Logos are used in the portal to display a Logo at the top of the pages. Footer Logos are used to display an image a the bottom of the pages. Report Logos are used in the header of the generated PDF reports. Small Report Logos are used as footers of the generated PDF reports.
If a sub-account does not have a Logo, the GET method returns the parent Account’s Logos by default. All Logos, regardless of their sizes during upload, are returned with a maximum width of 1080 and a maximum height of 960.
Note: The GET URL is different from the POST, PUT and DELETE URLs. Once the POST, PUT and DELETE methods are used, the parent Account’s Logos are overridden permanently for that particular sub-account.
Header Logo
| EXAMPLE GET: |
/branding/applicationLogo?image=header&useDefault=true |
| API POST/PUT/DELETE PATH: |
/api/v2/logo/application/header |
| EXAMPLE POST: |
---------------------------acebdf13572468
Content-Disposition: form-data; name="logo"; filename="Header_logo.jpg"
Content-Type: image/jpeg
<@INCLUDE *C:\Users\User1\Desktop\1702\Header_logo.jpg*@>
---------------------------acebdf13572468--
|
Footer Logo
| EXAMPLE GET: |
/branding/applicationLogo?image=footer&useDefault=true |
| API POST/PUT/DELETE PATH: |
/api/v2/logo/application/footer |
| EXAMPLE POST: |
---------------------------acebdf13572468
Content-Disposition: form-data; name="logo"; filename="Footer_logo.jpg"
Content-Type: image/jpeg
<@INCLUDE *C:\Users\User1\Desktop\1702\Footer_logo.jpg*@>
---------------------------acebdf13572468--
|
Report Logo
| EXAMPLE GET: |
/branding/reportLogo |
| API POST/PUT/DELETE PATH: |
/api/v2/logo/report |
| EXAMPLE POST: |
---------------------------acebdf13572468
Content-Disposition: form-data; name="logo"; filename="Report_logo.jpg"
Content-Type: image/jpeg
<@INCLUDE *C:\Users\User1\Desktop\1702\Report_logo.jpg*@>
---------------------------acebdf13572468--
|
Report Logo (small)
| EXAMPLE GET: |
/branding/reportLogoSmall |
| API POST/PUT/DELETE PATH: |
/api/v2/logo/report/small |
| EXAMPLE POST: |
---------------------------acebdf13572468
Content-Disposition: form-data; name="logo"; filename="Report_logo_small.jpg"
Content-Type: image/jpeg
<@INCLUDE *C:\Users\User1\Desktop\1702\Report_logo_small.jpg*@>
---------------------------acebdf13572468--
|
