Medias GetFile

Endpoint Overview

The Cryos Ecom Medias WenAPI Is a set of endpoints to retrieve photos, files and audio samples from donors

HTTP Method

GET

URL

https://api.cryosinternational.com/Ecom-API-Medias/api/Medias/{donorGuid}/{fileName}[?width][&height]

Key is the donor ID, either as a alias name like JOHN or a number ID like 12345.

Request Details

In order to request a specific file based on filename and the Donor GUID, you'll first need to request donor data from using the endpoint https://api-development.cryosinternational.com/ecomdev/external/{name}/{languageKey} - From that response you will need to locate the file that has the URL defined as api/Medias/{donorGuid}/{fileName} like for example
Donor lavender in the en-gb language under the field basicInfoDocuments

Parameters

Headers.

name

Required

Type

Value

Description

Cache-Control

no

string

No-cache

Prevents caching of the request.

Ocp-Apim-Subscription-Key

Yes

string

Primary Key: Guid

API subscription key for authentication. Will be filled in automatically

Response details - status codes

Status Codes

  • 200 OK: Request was successful, and the donor details are returned.

  • 400 Bad Request: Missing or invalid parameters.

    {"code": 400, "message": "The query specified in the URI is not valid. Invalid value 'three' for $top query option found. The $top query option requires a non-negative integer value." }

  • 401 Unauthorized: Invalid or missing subscription key.

    { "code": 401, "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." }

  • 404 Not Found: No donor found with the provided key.

    { "code": 404, "message": "Resource not found" }

  • 429 Too many request: The request limit is reached.

    { "code": 429, "message": "Rate limit is exceeded. Try again in 9 seconds, you have reached the limit of 60 calls." }

  • 500 Internal server error: Something went wrong.

    { "code": 500, "message": "The following causes to HTTP 500 can be the following, ExpressionValueEvaluationFailure(Expression evaluation failed. Object reference not set to an instance of an object.) or OperationNotFound(Unable to match incoming request to an operation) or timeout" }

Response Format

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true