regis

<back to all web services

ProvisionalRegistrationsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/Provisional
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 ProvisionalRegistrationsRequest
    {
        public virtual string reporting_term { get; set; }
        public virtual string authorizing_uuid { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class ProvisionalRegistrationResponse
    {
        public ProvisionalRegistrationResponse()
        {
            documents = new List<RegistrationDocumentResponse>{};
        }

        public virtual string uuid { get; set; }
        public virtual int? regent_id { get; set; }
        public virtual string student_name { get; set; }
        public virtual string email { get; set; }
        public virtual string section_uuid { get; set; }
        public virtual string student_section_uuid { get; set; }
        public virtual string course_name { get; set; }
        public virtual string section_code { get; set; }
        public virtual string title { get; set; }
        public virtual string term { get; set; }
        public virtual decimal amount { get; set; }
        public virtual bool is_audit { get; set; }
        public virtual bool is_waitlist { get; set; }
        public virtual bool is_missing_requisites { get; set; }
        public virtual bool is_other_restriction { get; set; }
        public virtual List<RegistrationDocumentResponse> documents { get; set; }
        public virtual DateTime requested_date { get; set; }
    }

    public partial class ProvisionalRegistrationsResponse
    {
        public ProvisionalRegistrationsResponse()
        {
            provisional_registrations = new List<ProvisionalRegistrationResponse>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<ProvisionalRegistrationResponse> provisional_registrations { get; set; }
    }

    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; }
    }

}

C# ProvisionalRegistrationsRequest 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/Provisional HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	reporting_term: String,
	authorizing_uuid: String
}
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
		}
	},
	provisional_registrations: 
	[
		{
			uuid: String,
			regent_id: 0,
			student_name: String,
			email: String,
			section_uuid: String,
			student_section_uuid: String,
			course_name: String,
			section_code: String,
			title: String,
			term: String,
			amount: 0,
			is_audit: False,
			is_waitlist: False,
			is_missing_requisites: False,
			is_other_restriction: False,
			documents: 
			[
				{
					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
				}
			],
			requested_date: 0001-01-01
		}
	]
}