Create Donors

POST

/v3/ingest/donors/

curl --request POST \
  --url https://example.com/v3/ingest/donors/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[ { "cause_of_death": "Died of cancer", "date_alive_after_lost_to_followup": { "day_interval": 1, "month_interval": 1 }, "date_of_birth": { "day_interval": 1, "month_interval": 1 }, "date_of_death": { "day_interval": 1, "month_interval": 1 }, "date_resolution": "example", "gender": "Man", "is_deceased": "Yes", "lost_to_followup_after_clinical_event_identifier": "example", "lost_to_followup_reason": "Completed study", "program_id": "example", "sex_at_birth": "Male", "submitter_donor_id": "example", "uuid": "example" } ]'

Authorizations

• IngestAuth
• ServiceTokenAuth

Request Body ^required

Media type application/json

Payload

Array<object>

DonorIngestSchema

object

cause_of_death

Any of:

CauseOfDeathEnum

CauseOfDeathEnum

string

Allowed values: Died of cancer Died of other reasons Not available

null

null

date_alive_after_lost_to_followup

Any of:

DateInterval

DateInterval

object

day_interval

Any of:

integer

integer

null

null

month_interval

required

Month Interval

Number of months since first diagnosis

integer

null

null

date_of_birth

Any of:

DateInterval

DateInterval

object

day_interval

Any of:

integer

integer

null

null

month_interval

required

Month Interval

Number of months since first diagnosis

integer

null

null

date_of_death

Any of:

DateInterval

DateInterval

object

day_interval

Any of:

integer

integer

null

null

month_interval

required

Month Interval

Number of months since first diagnosis

integer

null

null

date_resolution

Any of:

string

string

<= 32 characters

null

null

gender

Any of:

GenderEnum

GenderEnum

string

Allowed values: Man Woman Non-binary Other Prefer not to disclose Not available

null

null

is_deceased

Any of:

uBooleanEnum

uBooleanEnum

string

Allowed values: Yes No Not available

null

null

lost_to_followup_after_clinical_event_identifier

Any of:

string

string

<= 255 characters

null

null

lost_to_followup_reason

Any of:

LostToFollowupReasonEnum

LostToFollowupReasonEnum

string

Allowed values: Completed study Discharged to palliative care Lost contact Not available Withdrew from study Discharged from follow-up

null

null

program_id

required

Program Id

string

sex_at_birth

Any of:

SexAtBirthEnum

SexAtBirthEnum

string

Allowed values: Male Female Other Not available

null

null

submitter_donor_id

required

Submitter Donor Id

string

<= 64 characters /^[A-Za-z0-9\-\._]{1,64}$/

uuid

Any of:

string

string

null

null

Responses

200

OK