API Documentation

GetClassEnrollment

The GetClassEnrollment command retreives class enrollment information using an ID.

Instructiosn:

Id Integer (Required)

The ID of the class enrollment to retrieve.

				
					{
  "missing"
}

Success Boolean(Not Nullable)

Indicates the status of the API request

Message String(Nullable)

Success or failure message

Data ClassEnrollment(Not Nullable)

See ClassEnrollment type below

				
					{
  "missing"
}

Property	Type	Nullable	Note
Id	Integer	Not Nullable	The class enrollment’s unique identifier
ExternalId	String	Nullable	The class enrollment’s external ID, usually a unique identifier from the calling system
UserId	Integer	Not Nullable	The Id of the related user
ClassId	Integer	Not Nullable	The Id of the related class
EnrollmentStatusId	Integer	Not Nullable	Indicates the status of the class enrollment 0 = Request 10 = Cancel 20 = Waitlist 30 = Approve 40 = Deny 50 = Audit 60 = Enroll
CompletionStatusId	Integer	Not Nullable	Indicates the completion status of the class enrollment 0 = Unknown 10 = Attending 20 = Complete 30 = Incomplete 40 = NoShow 50 = Failed