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
Request Body - application/json ()
  • application/json
Root Schema : schema
Match All
Show Source
  • RegistrantsRequest
    Title: RegistrantsRequest
  • Example: { "first_name":"Jeremy", "middle_name":null, "last_name":"Smith", "contact_method":"EMAIL", "calling_code_phone":null, "phone":null, "email":"jeremy_smith@test.com", "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
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
Back to Top

Response

200 Response

Back to Top