Upload Success
Overview
The following table contains important information about the POST method when the action is successful in regards to the upload process.
| POST Method | |
|---|---|
| Method | POST |
| URL or Endpoint | /api/projects/projectId/uploads/success/requestKey |
| Headers | Authorization |
| Parameters | projectId, requestKey |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Description |
|---|---|---|---|
projectId | Yes | string | Project specifier property. |
requestKey | Yes | string | Key that is provided after a successful upload. |
Request Body
After a succesful upload, the POST method doesn't require a request body.
Response
{
"success": true,
"statusCode": 200,
"result": {
"downloadPath": "http://blob.gjirafa.com/vps/cnc/uploads/b5b786fdba364e3d8da54f2f322ce8d6/file.mp4"
},
"resultInfo": null,
"errors": [],
"messages": []
}
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 |
| statusCode | integer | Returns the HTTP Status Code |
| result | array[Object] | Returns the response object |
result.downloadPath | string | Returns the downloadPath of the video |
| resultInfo | string | Returns extra information about the result |
| errors | array[string] | Indicates if there was an error |
| messages | array[string] | Returns the response message from the encode endpoints |
info
If the action is successful, the service responds with an HTTP 200 or 201 status code.
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: Service Unavailable