Read enrollment records. Caller requires the ENROLLMENTS:VIEW permission.

POST 
/api/web/v1/enrollment/api/readEnrollments

deprecated

Read enrollment records. Caller requires the ENROLLMENTS:VIEW permission.

Request

application/json

Body

required

enrollmentDesignName stringrequired

Name of the Enrollment Design.

filterCriteria object[]

Filter criteria based on which enrollments records should be fetched. If not provided, all records are fetched based on page size and number.

pageNumber string

Page number of Enrollment records to be fetched. Default is 1.

pageSize string

Maximum number of Enrollment records to be fetched. Default is 50.

Responses

200

OK

application/json

Schema

Schema

enrollmentData object[]required

The Enrollment Data. Primary key field is mandatory in case of Update and Delete.

enrollmentDesignName stringrequired

Name of the Enrollment Design.

Example (from schema)

{
  "enrollmentData": [
    {}
  ],
  "enrollmentDesignName": "string"
}

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...