Skip to main content

Create Enrollments

POST 
/api/web/v2/enrollments/:enrollmentDesignName

Create one or more enrollments. Caller requires the ENROLLMENTS:ADD permission.

Request​

Path Parameters

    enrollmentDesignName stringrequired

    Name of the enrollment design

Body

array

required

  • Array [

    • fields

    object[]

    required

    List of enrollment fields having field name and field value

  • Array [

    • name string

    Name of the enrollment field

    value string

    Value of the enrollment field.
    Accepted Date Formats: YYYY-MM-DD, MM/DD/YYYY, YYYY-MM-DDTHH:MM:SSZ, YYYY-MM-DDTHH:MM:SS

  • ]

    • id string

    Id of the enrollment (Value is required only in the update enrollment request, should be ignored in create enrollment request). Id should be in Base64 string format.

  • ]

Responses​

OK

Schema

  • Array [

    • error string

    Error message for the failed enrollment record (For create/update/delete enrollments request)

    fields

    object[]

    List of enrollment fields having field name and field value (For search enrollments request only)

  • Array [

    • name string

    Name of the enrollment field

    value string

    Value of the enrollment field.
    Accepted Date Formats: YYYY-MM-DD, MM/DD/YYYY, YYYY-MM-DDTHH:MM:SSZ, YYYY-MM-DDTHH:MM:SS

  • ]

    • id string

    Id of the enrollment (In Base64 string format)

    status string

    Status (Success/Failure) of the enrollment record (To check if the requested enrollment is successfully created/updated/deleted or not)

  • ]

Loading...