Read Enrollments

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

Read one or more enrollments. Caller requires the ENROLLMENTS:VIEW permission.

Request

Path Parameters

enrollmentDesignName stringrequired

Name of the enrollment design

Query Parameters

offset int32

Default value: 1

Page number offset, default value is 1

limit int32

Default value: 50

Page size limit, default value is 50

application/json

Body

array

required

• 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

• ]

Responses

200

OK

application/json

Schema

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)

• ]

Example (from schema)

[
  {
    "error": "The record does not exist",
    "fields": [
      {
        "name": "Bar Code",
        "value": "12345678"
      }
    ],
    "id": "eyJ3b3JrZmxvd0lkIjoiNjE2ZTZiZmItNzI2NC00NjQ0LWE0MWMtMTFhZjE4MWRkZGFkIiwid2hlcmVDbGF1c2UiOnsiUVVJQ0tTVEFSVFBSSU1BUllLRVkiOiIxIn11",
    "status": "Success"
  }
]

400

Bad request

application/json

Schema

Schema

code stringrequired

The server error code

message stringrequired

A human-readable representation of the error

target string

The target of the error

Example (from schema)

{
  "code": "string",
  "message": "string",
  "target": "string"
}

401

Authorization information is missing or invalid

application/json

Schema

Schema

code stringrequired

The server error code

message stringrequired

A human-readable representation of the error

target string

The target of the error

Example (from schema)

{
  "code": "string",
  "message": "string",
  "target": "string"
}

404

The specified resource was not found

application/json

Schema

Schema

code stringrequired

The server error code

message stringrequired

A human-readable representation of the error

target string

The target of the error

Example (from schema)

{
  "code": "string",
  "message": "string",
  "target": "string"
}

500

Unexpected error

application/json

Schema

Schema

code stringrequired

The server error code

message stringrequired

A human-readable representation of the error

target string

The target of the error

Example (from schema)

{
  "code": "string",
  "message": "string",
  "target": "string"
}

Loading...