Cryos API documentation - Pregnancy Report API

This document contains a brief description of the Cryos International Pregnancy API and a few illustrative examples that demonstrate how Pregnancy Report, represented as JSON objects, are retrieved from the API. The Pregnancy Report API is an OData RESTful API that enables 3rd party developers to easily put new pregnancy reports into the job que on behalf of the clinic you as a developer is working for.

As this document only goes through one PUT example, if need for a more comprehensive description of how the API works and what will be putted into the job que, please look at the developer portal with you account at https://platform.cryosinternational.com/api-details#api=pregnancyreport-test.

For testing purposes please use the following link where we have created some mock data that simulates a real-life scenario. Reason for this is the PUT request will put data to a job que if it was done on production, and a customer care team that will treat the data coming to production as real production data.

Accessing the Pregnancy Report API

To successfully access the API, you will need to use the following URL and add your subscription key in the request header: https://platform.cryosinternational.com/pregnancy/PregnancyReport

An API key has already been defined and encrypted into the API – the only key you as a developer need is the subscription key, which is generated once Cryos has assigned you to the appropriate product group.

The Pregnancy Report API Entity Set

The pregnancy report API only has one operation which PUT new pregnancy report resource into a storage account which is then handled by the cryos customer care team. On the developer portal we have added the request body with the needed data you need to provide in order to get a 200 success HTTP code in return.

HTTP Request Example

You as the developer need to know the data that should be put in, but to give a short example of how this could look please use the example below as a form of guideline.

Please note that this a simplified example and you have to enter the correct Donor ID, TE-Number, TEName, reference and details yourself. Always if in doubt contact the clinic for these kinds of information,

since they know exactly what the data means regarding these fields. The report field can have one of three values – these are pregnancy, miscarriage or completed. The exact documentation can be found on the developer portal and have description for each field as well as the JSON file formatting.