Jump to

• Request
• Response

Create a registrant

post

https://{domain_name}.ohms.oracle.com/ords/esi_api/api/v1/registrants

Creates a registrant in Oracle Health Immunization Management Cloud Service. Required and optional fields vary, depending on the tenant configuration. This method ignores populated fields that the calling tenant does not use.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

• application/json

Root Schema : schema

Match All

Show Source

• object RegistrantsRequest
  Title: RegistrantsRequest
• Example: { "first_name":"Jeremy", "middle_name":null, "last_name":"Smith", "contact_method":"EMAIL", "calling_code_phone":null, "phone":null, "email":"[e-mail]", "address_1":null, "address_2":null, "address_3":"address_3", "address_4":"address_4", "postal_city":"BAKEL", "postal_zone":"DAKAR", "sub_zone":"KOLDA", "postal_code":null, "country_code":"SN", "dob":"1977-07-21T00:00:00", "biological_sex":null, "gender":null, "race":null, "ethnicity":null, "indigenous_status":null, "external_id":"1223444", "group_code":null, "registrant_documents":{ "document_type":"NUMERO_PASSEPORT/CARTE_D'IDENT", "document_subtype":"PASSPORT", "document_uid":"12345678916" } }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/RegistrantsRequest"
        },
        {
            "example":{
                "first_name":"Jeremy",
                "middle_name":null,
                "last_name":"Smith",
                "contact_method":"EMAIL",
                "calling_code_phone":null,
                "phone":null,
                "email":"[e-mail]",
                "address_1":null,
                "address_2":null,
                "address_3":"address_3",
                "address_4":"address_4",
                "postal_city":"BAKEL",
                "postal_zone":"DAKAR",
                "sub_zone":"KOLDA",
                "postal_code":null,
                "country_code":"SN",
                "dob":"1977-07-21T00:00:00",
                "biological_sex":null,
                "gender":null,
                "race":null,
                "ethnicity":null,
                "indigenous_status":null,
                "external_id":"1223444",
                "group_code":null,
                "registrant_documents":{
                    "document_type":"NUMERO_PASSEPORT/CARTE_D'IDENT",
                    "document_subtype":"PASSPORT",
                    "document_uid":"12345678916"
                }
            }
        }
    ]
}

Nested Schema : RegistrantsRequest

Type: object

Title: RegistrantsRequest

Show Source

• biological_sex_lv_code(required): string
• calling_code_phone(required): string
• contact_method(required): string
• dob(required): string
• email(required): string
• ethnicity_lv_code(required): string
• external_id(required): string
• first_name(required): string
• gender_lv_code(required): string
• indigenous_status_lv_code(required): string
• last_name(required): string
• loc_address1(required): string
• loc_address2(required): string
• loc_address3(required): string
• loc_address4(required): string
• loc_address_key(required): string
• loc_city(required): string
• loc_country_code(required): string
• loc_postal_code(required): string
• loc_sub_zone(required): string
• loc_zone(required): string
• middle_name(required): string
• phone(required): string
• race_lv_code(required): string

{
    "title":"RegistrantsRequest",
    "required":[
        "first_name",
        "middle_name",
        "last_name",
        "contact_method",
        "calling_code_phone",
        "phone",
        "email",
        "loc_address1",
        "loc_address2",
        "loc_address3",
        "loc_address4",
        "loc_city",
        "loc_zone",
        "loc_sub_zone",
        "loc_postal_code",
        "loc_country_code",
        "loc_address_key",
        "dob",
        "biological_sex_lv_code",
        "gender_lv_code",
        "race_lv_code",
        "ethnicity_lv_code",
        "indigenous_status_lv_code",
        "external_id"
    ],
    "type":"object",
    "properties":{
        "first_name":{
            "type":"string",
            "nullable":true
        },
        "middle_name":{
            "type":"string"
        },
        "last_name":{
            "type":"string",
            "nullable":true
        },
        "contact_method":{
            "type":"string"
        },
        "calling_code_phone":{
            "type":"string",
            "nullable":true
        },
        "phone":{
            "type":"string",
            "nullable":true
        },
        "email":{
            "type":"string",
            "nullable":true
        },
        "loc_address1":{
            "type":"string",
            "nullable":true
        },
        "loc_address2":{
            "type":"string",
            "nullable":true
        },
        "loc_address3":{
            "type":"string",
            "nullable":true
        },
        "loc_address4":{
            "type":"string",
            "nullable":true
        },
        "loc_city":{
            "type":"string",
            "nullable":true
        },
        "loc_zone":{
            "type":"string",
            "nullable":true
        },
        "loc_sub_zone":{
            "type":"string",
            "nullable":true
        },
        "loc_postal_code":{
            "type":"string",
            "nullable":true
        },
        "loc_country_code":{
            "type":"string",
            "nullable":true
        },
        "loc_address_key":{
            "type":"string",
            "nullable":true
        },
        "dob":{
            "type":"string",
            "nullable":true
        },
        "biological_sex_lv_code":{
            "type":"string",
            "nullable":true
        },
        "gender_lv_code":{
            "type":"string",
            "nullable":true
        },
        "race_lv_code":{
            "type":"string",
            "nullable":true
        },
        "ethnicity_lv_code":{
            "type":"string",
            "nullable":true
        },
        "indigenous_status_lv_code":{
            "type":"string",
            "nullable":true
        },
        "external_id":{
            "type":"string",
            "nullable":true
        }
    },
    "example":{
        "first_name":null,
        "middle_name":"DSDSSSdd",
        "last_name":null,
        "contact_method":"EMAIL",
        "calling_code_phone":null,
        "phone":null,
        "email":null,
        "loc_address1":null,
        "loc_address2":null,
        "loc_address3":null,
        "loc_address4":null,
        "loc_city":null,
        "loc_zone":null,
        "loc_sub_zone":null,
        "loc_postal_code":null,
        "loc_country_code":null,
        "loc_address_key":null,
        "dob":null,
        "biological_sex_lv_code":null,
        "gender_lv_code":null,
        "race_lv_code":null,
        "ethnicity_lv_code":null,
        "indigenous_status_lv_code":null,
        "external_id":null
    }
}

Example:

{
    "first_name":null,
    "middle_name":"DSDSSSdd",
    "last_name":null,
    "contact_method":"EMAIL",
    "calling_code_phone":null,
    "phone":null,
    "email":null,
    "loc_address1":null,
    "loc_address2":null,
    "loc_address3":null,
    "loc_address4":null,
    "loc_city":null,
    "loc_zone":null,
    "loc_sub_zone":null,
    "loc_postal_code":null,
    "loc_country_code":null,
    "loc_address_key":null,
    "dob":null,
    "biological_sex_lv_code":null,
    "gender_lv_code":null,
    "race_lv_code":null,
    "ethnicity_lv_code":null,
    "indigenous_status_lv_code":null,
    "external_id":null
}

Security

• bearer(required): http
  Type: http

Back to Top

Response

200 Response

Back to Top