regis

<back to all web services

AcademicSummaryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/{uuid}/Summary
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;

namespace regis.ClassLibrary.Requests
{
    public partial class AcademicSummaryRequest
    {
        public virtual string uuid { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class AcademicSummaryResponse
    {
        public AcademicSummaryResponse()
        {
            student_programs = new List<StudentProgramSimpleResponse>{};
            messages = new List<string>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string uuid { get; set; }
        public virtual decimal? gpa { get; set; }
        public virtual List<StudentProgramSimpleResponse> student_programs { get; set; }
        public virtual string unofficial_undergraduate_degree_description { get; set; }
        public virtual List<string> messages { get; set; }
    }

    public partial class StudentProgramSimpleResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string uuid { get; set; }
        public virtual int program_id { get; set; }
        public virtual string program_code { get; set; }
        public virtual string program_name { get; set; }
        public virtual string concentration_code { get; set; }
        public virtual string concentration_name { get; set; }
        public virtual DateTime? start_date { get; set; }
        public virtual DateTime? end_date { get; set; }
        public virtual string catalog { get; set; }
        public virtual bool is_active { get; set; }
        public virtual bool is_graduated { get; set; }
    }

}

C# AcademicSummaryRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Academic/{uuid}/Summary HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"uuid":"String","gpa":0,"student_programs":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"uuid":"String","program_id":0,"program_code":"String","program_name":"String","concentration_code":"String","concentration_name":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","catalog":"String","is_active":false,"is_graduated":false}],"unofficial_undergraduate_degree_description":"String","messages":["String"]}