GET api/Enrolment/GetEnrolements?franchiseeId={franchiseeId}
Gets list of enrolements for franchisee
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
franchiseeId |
franchiseeId |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of BO.Models.Enrolments.EnrolmentBasicName | Description | Type | Additional information |
---|---|---|---|
EnrolmentId | integer |
None. |
|
FranchiseeId | integer |
Required |
|
ProgramId | integer |
Required |
|
StudentId | integer |
Required |
Response Formats
application/json, text/json
Sample:
[ { "$id": "2", "EnrolmentId": 1, "FranchiseeId": 2, "ProgramId": 3, "StudentId": 4 }, { "$ref": "2" } ]
application/xml, text/xml
Sample:
<ArrayOfEnrolmentBasic xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BO.Models.Enrolments"> <EnrolmentBasic> <EnrolmentId>1</EnrolmentId> <FranchiseeId>2</FranchiseeId> <ProgramId>3</ProgramId> <StudentId>4</StudentId> </EnrolmentBasic> <EnrolmentBasic> <EnrolmentId>1</EnrolmentId> <FranchiseeId>2</FranchiseeId> <ProgramId>3</ProgramId> <StudentId>4</StudentId> </EnrolmentBasic> </ArrayOfEnrolmentBasic>