SchooxSharp.Api.Clients.Dashboard.GetEnrolledUsersInCurriculum C# (CSharp) Method

GetEnrolledUsersInCurriculum() public method

Returns a list of enrolled users in a curriculum with a summary of information for every user (e.g. enrollment date, total time spent on the curriculum and total progress).
public GetEnrolledUsersInCurriculum ( int curriculumId, string role, int regionId = null, int locationId = null, int jobId = null, string letter = null, int start = null, int limit = null, string sort = null ) : SchooxResponse>
curriculumId int Curriculum identifier.
role string User's role
regionId int Region identifier.
locationId int Location identifier.
jobId int Job identifier.
letter string Lastname's starting letter
start int List's starting position
limit int Number of users to return per request, up to maximum of 1,000. Default to 100
sort string Sorting criteria
return SchooxResponse>
        public SchooxResponse<List<User>> GetEnrolledUsersInCurriculum(int curriculumId, string role, int? regionId = null, 
            int? locationId = null, int? jobId = null, string letter = null, int? start = null,
            int? limit = null, string sort = null)
        {
            //GET /dashboard/curriculums/:curriculumid
            var request = SService.GenerateBaseRequest("/dashboard/curriculums/{curriculumId}");
            request.Method = Method.GET;

            request.AddUrlSegment("curriculumId", curriculumId.ToString(CultureInfo.InvariantCulture));

            request.AddNonBlankQueryString ("role", role);
            request.AddNonBlankQueryString ("regionId", regionId);
            request.AddNonBlankQueryString ("locationId", locationId);
            request.AddNonBlankQueryString ("jobId", jobId);
            request.AddNonBlankQueryString ("letter", letter);
            request.AddNonBlankQueryString ("start", start);
            request.AddNonBlankQueryString ("limit", limit);
            request.AddNonBlankQueryString ("sort", sort);

            return Execute<List<User>>(request);
        }