POST Logo
Overview
The following table contains important information about the POST method in regards to posting a logo for the player.
| POST Logo | |
|---|---|
| Method | POST |
| URL or Endpoint | /api/projects/projectId/players/logo |
| Headers | Authorization |
| Parameters | projectId |
| Body | file |
The description of the URL parameter is as follows:
| projectId URL Parameter | |
|---|---|
| URL Parameter Name | projectId |
| Mandatory | Yes |
| Type | string |
| Description | Unique Id of the project. |
Request Body
The body of this method requests that you upload an image which will be the logo of your player.
Response
{
"success": true,
"errors": [],
"messages": [],
"result": {
"path": "https://vp-dev.gjirafa.net/vps/logo/f8ec980b-f911-41e8-927e-3f351406eab5.png"
},
"resultInfo": null,
"statusCode": 200
}
Information about the fields that appear when you receive the response are displayed in the table below.
| Field Name | Type | Description |
|---|---|---|
| success | bool | If the response is successful it will return true. Otherwise will return false. |
| errors | array[] | Indicates if there was an error. |
| messages | array[] | Returns the response message from back-end. |
| result | array[Object] | Returns the response object. |
| path | string | The URL of the uploaded logo. |
| resultInfo | string | Returns extra information about the result. |
| statusCode | integer($int32) | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed