GetDonorMotility API documentation

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/donor/donor/Donors('{donorId}')/ejaculateNumber('{ejaculateNumber}')

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

Request Details

The request path parameters

The ejaculate number is something you can get from the DeliveryNote API endpoint - this is typical something that is a bit more sensitive data and therefore you can only get access to that data if you also have a clinic api key for the use of the DeliveryNote API. If you are in the need of this DonorMotility endpoint but not the use of deliveryNote - then please reach out and we will make a workable solution suitable for you.

Name

In

Required

Type

Example

Description

DonorId

Template

Yes

String

STIG or 12345

Unique identifier for the donor

EjaculateNumber

Template

Yes

Integer

The ejaculate number of the wanted donor

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 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