GetSuccesfullPrenancies API documentation

Endpoint Overview

Retrieve succesfull pregnancies based on language and year.

HTTP Method

GET

URL

https://api-development.cryosinternational.com/pregnancy/PregnancyReport/pregnancies('{year}/{country}')

Request Details

The request path parameters

Besides you being able to report a succesfull pregnancy, it is also possible to request any succesfull pregnancy based on year and country. The reason behind that it is only based on year and country to minimize the amount of data coming back. There is no need to request all succesfull pregnancy, if you are only interested in one country and a year. This also gives the advange for EMR vendors to easily filter the pregnancies.

Name

In

Required

Type

Example

Description

year

Template

Yes

integer

1999

The year of succesfull pregnancy - please call the endpoint get reported pregnancies before this endpoint for perfomance.

country

Template

Yes

string

Denmark

The country - if no succesfull pregnancy was found in that year, it will tell you.

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