Logo
Resource Fields
| Name | Type | Read-only | Description |
|---|---|---|---|
| name | string | ||
| size | integer | ||
| width | integer | ||
| height | integer | ||
| type | string | ||
| url | string | ||
| thumbnails | Thumbnails |
There will be thumbnails in various dimensions. Variations: 75x16, 113x24, 150x32
|
Thumbnails
RESOURCE FIELDS
| Name | Type | Read-only | Description |
|---|---|---|---|
| name | string | ||
| size | integer | ||
| width | integer | Primary logo width 225 | |
| height | integer | Primary logo height 48 | |
| type | string | Mime-type of the file | |
| url | string | The url to view the thumbnail |
Metadata
| Version | 1.0 |
| Last Updated | July 04, 2016 |
Actions
Render logo
GET /api/v1/logo/render.jsonInformation
| Allowed for | Public |
Arguments
| Name | Type | Mandatory | Description |
|---|---|---|---|
| brand_id | integer | Logo for the brand |
Response
{
"status": 200,
"data": {
"name": "logo.png",
"size": 2954,
"width": 225,
"height": 225,
"type": "image/jpeg",
"url": "https://brewfictus.kayako.com/api/v1/logo/render",
"thumbnails": [
{
"name": "logo-75.png",
"size": 1067,
"width": 75,
"height": 75,
"type": "image/jpeg",
"url": "https://brewfictus.kayako.com/api/v1/logo/render&size=75"
}
]
},
"resource": "logo"
}
Retrieve logo
GET /api/v1/logo.jsonInformation
| Allowed for | Public |
This output/render image to browser.
Arguments
| Name | Type | Mandatory | Description |
|---|---|---|---|
| brand_id | integer | Logo for the brand |
Response
{
"status": 200,
"data": {
"name": "logo.png",
"size": 2954,
"width": 225,
"height": 225,
"type": "image/jpeg",
"url": "https://brewfictus.kayako.com/api/v1/logo/render",
"thumbnails": [
{
"name": "logo-75.png",
"size": 1067,
"width": 75,
"height": 75,
"type": "image/jpeg",
"url": "https://brewfictus.kayako.com/api/v1/logo/render&size=75"
}
]
},
"resource": "logo"
}
Replace logo
PUT /api/v1/logo.jsonInformation
| Allowed for | Admins & Owners |
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| image | multipart/form-data | Large image will be scaled down | |
| brand_id | integer | Logo for the brand |
Response
{
"status": 200,
"data": {
"name": "logo.png",
"size": 2954,
"width": 225,
"height": 225,
"type": "image/jpeg",
"url": "https://brewfictus.kayako.com/api/v1/logo/render",
"thumbnails": [
{
"name": "logo-75.png",
"size": 1067,
"width": 75,
"height": 75,
"type": "image/jpeg",
"url": "https://brewfictus.kayako.com/api/v1/logo/render&size=75"
}
]
},
"resource": "logo"
}
Delete logo
DELETE /api/v1/logo.jsonInformation
| Allowed for | Admins & Owners |
Arguments
| Name | Type | Mandatory | Description |
|---|---|---|---|
| brand_id | integer | Logo for the brand |
Response
{
"status": 200
}