Enrollments

Get Enrollment

Retrieves a specific enrollment and includes session and teacher details.

GET https://api.speaking-partner.com/v1/enrollments/{enrollmentId}

URL Parameters

Name	Required?	Description
EnrollmentId	Yes	The ID of the enrollment.

Example Request

GET: https://api.speaking-partner.com/v1/enrollments/225

Example Response

{
   "Attended":false,
   "EnrollmentDate":1349300483,
   "EnrollmentId":225,
   "Feedback":{
      "CreationDate":1351641600,
      "Custom":null,
      "Message":"Awesome job!"
   },
   "Session":{
      "CancellationDate":null,
      "EndDate":1349474400,
      "EnrollmentCount":2,
      "MaxSessionEnrollments":3,
      "Name":"Group Session",
      "SessionId":18,
      "StartDate":1349472600,
      "IsSubstituted":false,
      "Billable":true,
      "Teacher":{
         "Biography":null,
         "FirstName":"Walter",
         "LastName":"Bishop",
         "PhotoURL":null,
         "TeacherId":8
      },
      "Metadata":{
         "ValueA":"http://example.com",
         "ValueB":"USA",
         "ValueC":"12345"
      }
   },
   "Student":{
      "Domain":"massive",
      "Email":"examplestudent@example.com",
      "FirstName":"Jim",
      "LastName":"Barnes",
      "Locale":"en-US",
      "NativeName":null,
      "PrimaryPhone":null,
      "PublicName":"Jim Barnes",
      "SecondaryPhone":null,
      "SkypeName":null,
      "Status":"Active",
      "TimeZone":"Mountain Standard Time",
      "Username":"jim"
   }
}

Update Enrollment

Updates a specific enrollment with attendance details.

POST https://api.speaking-partner.com/v1/enrollments/{enrollmentId}

URL Parameters

Name	Required?	Description
EnrollmentId	Yes	The ID of the enrollment.

Request Parameters

Name	Required?	Description
Attended	Yes	Indicates whether the student attended the session. (Can only be changed to true)

Example Request

POST: https://api.speaking-partner.com/v1/enrollments/225

attended=true

Example Response

{
   "Attended":true,
   "EnrollmentDate":1349300483,
   "EnrollmentId":225,
   "Feedback":null,
   "Session":{
      "CancellationDate":null,
      "EndDate":1349474400,
      "EnrollmentCount":2,
      "MaxSessionEnrollments":3,
      "Name":"Group Session",
      "SessionId":18,
      "StartDate":1349472600,
      "IsSubstituted":false,
      "Billable":true,
      "Teacher":{
         "Biography":null,
         "FirstName":"Walter",
         "LastName":"Bishop",
         "PhotoURL":null,
         "TeacherId":8
      },
      "Metadata":{
         "ValueA":"http://example.com",
         "ValueB":"USA",
         "ValueC":"12345"
      }
   },
   "Student":{
      "Domain":"massive",
      "Email":"examplestudent@example.com",
      "FirstName":"Jim",
      "LastName":"Barnes",
      "Locale":"en-US",
      "NativeName":null,
      "PrimaryPhone":null,
      "PublicName":"Jim Barnes",
      "SecondaryPhone":null,
      "SkypeName":null,
      "Status":"Active",
      "TimeZone":"Mountain Standard Time",
      "Username":"jim"
   }
}

Delete Enrollment

If permitted, deletes an enrollment and withdraws a student from a session.

DELETE https://api.speaking-partner.com/v1/enrollments/{enrollmentid}

URL Parameters

Name	Required?	Description
EnrollmentId	Yes	The ID of the enrollment.

Example Request

DELETE: https://api.speaking-partner.com/v1/enrollments/5