Logos
You can configure a logo, a graphical image representing e.g. the company, for a Teamwire organisation. Clients will show this logo at various places.
Manage organisation logos
Set an organisation logo
POST /v<api_version>/admin/organisationlogo/<organisation_id>/
Access restrictions
- Admins and Superadmins must have the allow_modify_settings permission.
- Admins can set a logo for their own organisation only.
- Superadmins can set a log for any organisation.
URL parameters
The following parameters are specified as part of the URL, i.e. /<parameter>/:
| Name | Type | Optional | For use by | Description |
|---|---|---|---|---|
| api_version | String | No | All admins | The Enterprise API version targeted. |
| organisation_id | Number | Yes | All admins | The ID of the organisation to set the logo for. |
POST data
The request’s POST data must contain an image in the PNG file format whose dimensions must match a ratio between 4:1 and 4:1.5.
Result
The following return values indicate the outcome of the API call:
| HTTP status code | Description |
|---|---|
| 200 (OK) | The request was successful. The supplied image has been set as organisation logo. |
| 400 (Bad request) | The request failed because no image has been supplied. |
| 401 (Unauthorized) | The request failed because the caller failed to first login to the Enterprise API or her session expired. Login to obtain a new session and repeat the request. |
| 403 (Forbidden) | The request failed because either a.) the calling admin’s organisation has been disabled or b.) an organisation ID was specified and the calling admin is not a Superadmin. |
| 404 (Not found) | The request failed because the organisation could not be found. |
| 409 (Conflict) | The request failed because the organisation has been disabled. |
Get any currently set logo
GET /v<api_version>/admin/organisationlogo/<organisation_id>/
Access restrictions
- Admins and Superadmins must have the allow_view_settings permission.
- Admins can request the logo of their own organisation only.
- Superadmins can request the logo of any organisation.
URL parameters
The following parameters are specified as part of the URL, i.e. /<parameter>/:
| Name | Type | Optional | For use by | Description |
|---|---|---|---|---|
| api_version | String | No | All admins | The Enterprise API version targeted. |
| organisation_id | Number | Yes | All admins | The ID of the organisation to return the logo for. |
Result
The following return values indicate the outcome of the API call:
| HTTP status code | Description |
|---|---|
| 200 (OK) | The request was successful. The currently set logo will be returned as a PNG image. |
| 401 (Unauthorized) | The request failed because the caller failed to first login to the Enterprise API or her session expired. Login to obtain a new session and repeat the request. |
| 403 (Forbidden) | The request failed because either a.) the calling admin’s organisation has been disabled or b.) an organisation ID was specified and the calling admin is not a Superadmin. |
| 404 (Not found) | The request failed because either a.) the organisation could not be found or b.) there is currently no logo set. |
| 409 (Conflict) | The request failed because the organisation has been disabled. |
Delete any currently set logo
DELETE /v<api_version>/admin/organisationlogo/<organisation_id>/
Access restrictions
- Admins and Superadmins must have the allow_modify_settings permission.
- Admins can delete the logo of their own organisation only.
- Superadmins can delete the logo of any organisation.
URL parameters
The following parameters are specified as part of the URL, i.e. /<parameter>/:
| Name | Type | Optional | For use by | Description |
|---|---|---|---|---|
| api_version | String | No | All admins | The Enterprise API version targeted. |
| organisation_id | Number | Yes | All admins | The ID of the organisation whose logo is to be deleted. |
Result
The following return values indicate the outcome of the API call:
| HTTP status code | Description |
|---|---|
| 200 (OK) | The request was successful. The previously set logo has been deleted. |
| 400 (Bad request) | The request was successful but there was no logo to delete. |
| 401 (Unauthorized) | The request failed because the caller failed to first login to the Enterprise API or her session expired. Login to obtain a new session and repeat the request. |
| 403 (Forbidden) | The request failed because either a.) the calling admin’s organisation has been disabled or b.) an organisation ID was specified and the calling admin is not a Superadmin. |
| 404 (Not found) | The request failed because either a.) the organisation could not be found or b.) there is currently no logo set. |
| 409 (Conflict) | The request failed because the organisation has been disabled. |