GetDonors API documentation

Endpoint Overview

Retrieve all donors or some donor information by providing the donor's unique identifier (key), and optional Odata filtering.

HTTP Method

GET

URL

https://api.cryosinternational.com/donor/Donors[?filter][&orderBy][&top][&format][&skip][&count]

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

Request Details

The request path parameters is as following:

name

In

Required

Example

type

Description

$Filter

query

no

BloodType eq 'A+'

string

Filters the collection of resources addressed by the request URL.

$orderBy

query

no

id asc

string

Orders the collection in a specific order (e.g., ascending or descending).

$top

query

no

10

integer

Selects the top results of the input (e.g., top 10 donors).

$format

query

no

$format=verbosejson

string

Specifies the response format (e.g., JSON).

$skip

query

no

5

integer

Skips a certain number of rows from the results.

$count

query

no

true

boolean

Returns the total number of rows in the response.

Request Headers

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