regis

<back to all web services

RegistrationInProgressSummaryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/InProgressSummary/{uuid}/Term/{reporting_term}
POST/Registration/InProgressSummary/{uuid}/Term/{reporting_term}/{transaction_uuid}
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 RegistrationInProgressSummaryRequest
    {
        public virtual string uuid { get; set; }
        public virtual string transaction_uuid { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual bool online_only { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class RegistrationDocumentResponse
    {
        public virtual string uuid { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string first_name { get; set; }
        public virtual string last_name { get; set; }
        public virtual string gender { get; set; }
        public virtual string email { get; set; }
        public virtual string program { get; set; }
        public virtual string concentration { get; set; }
        public virtual string section_uuid { get; set; }
        public virtual string course_name { get; set; }
        public virtual string course_title { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual string document_code { get; set; }
        public virtual string document_json { get; set; }
        public virtual string document_name { get; set; }
        public virtual string document_description { get; set; }
        public virtual DateTime? added_date { get; set; }
        public virtual DateTime? changed_date { get; set; }
    }

    public partial class RegistrationInProgressSummaryResponse
    {
        public RegistrationInProgressSummaryResponse()
        {
            requiredDocuments = new List<RegistrationDocumentResponse>{};
            completedDocuments = new List<RegistrationDocumentResponse>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string transaction_uuid { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string uuid { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual int numberOfStudentSections { get; set; }
        public virtual decimal amountOwing { get; set; }
        public virtual bool mustPayBeforeRegistering { get; set; }
        public virtual List<RegistrationDocumentResponse> requiredDocuments { get; set; }
        public virtual List<RegistrationDocumentResponse> completedDocuments { get; set; }
        public virtual bool isLate { get; set; }
    }

}

C# RegistrationInProgressSummaryRequest DTOs

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

HTTP + JSV

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

POST /Registration/InProgressSummary/{uuid}/Term/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	transaction_uuid: String,
	reporting_term: String,
	online_only: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	transaction_uuid: String,
	regent_id: 0,
	uuid: String,
	reporting_term: String,
	numberOfStudentSections: 0,
	amountOwing: 0,
	mustPayBeforeRegistering: False,
	requiredDocuments: 
	[
		{
			uuid: String,
			regent_id: 0,
			first_name: String,
			last_name: String,
			gender: String,
			email: String,
			program: String,
			concentration: String,
			section_uuid: String,
			course_name: String,
			course_title: String,
			reporting_term: String,
			document_code: String,
			document_json: String,
			document_name: String,
			document_description: String,
			added_date: 0001-01-01,
			changed_date: 0001-01-01
		}
	],
	completedDocuments: 
	[
		{
			uuid: String,
			regent_id: 0,
			first_name: String,
			last_name: String,
			gender: String,
			email: String,
			program: String,
			concentration: String,
			section_uuid: String,
			course_name: String,
			course_title: String,
			reporting_term: String,
			document_code: String,
			document_json: String,
			document_name: String,
			document_description: String,
			added_date: 0001-01-01,
			changed_date: 0001-01-01
		}
	],
	isLate: False
}