Jump to

• Request
• Response

Update registrant data

put

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

Updates the data for a registrant that exists in Oracle Health Immunization Management Cloud Service.

Request

Query Parameters

• registrant_code(required): string
  The code for the registrant.

Supported Media Types

• application/json

Request Body - application/json ()

• application/json

Root Schema : schema

Match All

Show Source

• object RegistrantsRequest1
  Title: RegistrantsRequest1
• Example: { "first_name":"Jane", "middle_name":"Mark", "last_name":"Jones", "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":"DAKAR", "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":"OKTGP55", "registrant_documents":{ "document_type":"NUMERO_PASSEPORT/CARTE_D'IDENT", "document_subtype":"NATIONAL_ID", "document_uid":"12345678916" } }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/RegistrantsRequest1"
        },
        {
            "example":{
                "first_name":"Jane",
                "middle_name":"Mark",
                "last_name":"Jones",
                "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":"DAKAR",
                "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":"OKTGP55",
                "registrant_documents":{
                    "document_type":"NUMERO_PASSEPORT/CARTE_D'IDENT",
                    "document_subtype":"NATIONAL_ID",
                    "document_uid":"12345678916"
                }
            }
        }
    ]
}

Nested Schema : RegistrantsRequest1

Type: object

Title: RegistrantsRequest1

Show Source

• contact_method(required): string
• first_name(required): string
• last_name(required): string
• loc_country_code(required): string
• middle_name(required): string
• registrant_code(required): string

{
    "title":"RegistrantsRequest1",
    "required":[
        "registrant_code",
        "first_name",
        "middle_name",
        "last_name",
        "contact_method",
        "loc_country_code"
    ],
    "type":"object",
    "properties":{
        "registrant_code":{
            "type":"string"
        },
        "first_name":{
            "type":"string"
        },
        "middle_name":{
            "type":"string"
        },
        "last_name":{
            "type":"string"
        },
        "contact_method":{
            "type":"string"
        },
        "loc_country_code":{
            "type":"string"
        }
    },
    "example":{
        "registrant_code":"SEN-33565-02309",
        "first_name":"First",
        "middle_name":"Middle",
        "last_name":"Last",
        "contact_method":"[e-mail]",
        "loc_country_code":"SN"
    }
}

Example:

{
    "registrant_code":"SEN-33565-02309",
    "first_name":"First",
    "middle_name":"Middle",
    "last_name":"Last",
    "contact_method":"[e-mail]",
    "loc_country_code":"SN"
}

Security

• bearer(required): http
  Type: http

Back to Top

Response

200 Response

Back to Top