Download a diploma file

Download a diploma file for a course user using GET. Requires provider ownership verification.

Request

For every API request you make, you'll need to present the API access key in the HTTP Header as X-API-Key to be authenticated.

Parameters

Name	Required	Value	Description
stream	optional	boolean	If true, streams the file inline instead of downloading

Example code in PHP

$request_url = 'https://api.frontcore.com/v2/course-users/:id/diplomas/:diplomaId/download';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $request_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 

curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  'X-API-Key: {your-api-key}',
  'Accept: application/json',
));
$result = curl_exec($ch);
curl_close($ch);
               

Response

If the method is successful it responds with an JSON structure, as it is shown below.

{
    "error": "This user is not owned by you."
}

Unsuccessful response sample:

{
    "error": "Wrong API Key"
}