Get DonorForExternalByName

Endpoint Overview

Retrieve donor motility information by providing the donor's unique identifier (key) and providing the donors ejaculateNumber.

HTTP Method

GET

URL

https://api.cryosinternational.com/ecomdev/external/{name}/{languageKey}

Key is the donor ID, either as a alias name like JOHN or a number ID like 12345, and the languageKey is the language like da-DK, en-GB

Request Details

The request path parameters

From this endpoint it is possible to retrieve all the information that is located on our cryosinternational.com website for donors, based on donor name and the languageKey.

Name

In

Required

Type

Example

Description

name

Template

Yes

String

STIG or 12345

Unique identifier for the donor

languageKey

Template

Yes

string

en-GB

The language key for which language your searching in

Headers details.

name

Required

Type

Value

Description

Cache-Control

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 Headers

For each succesful response some response headers will be shown, these headers will be on all the responses that gives 200 ok for all api endpoints on the Cryos API platform.

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