regis

<back to all web services

RegistrationAvailableRequest

Requires Authentication
Required permission:ReadRegistrationAvailability
The following routes are available for this service:
POST/Registration/{reporting_term}/Available
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type RegistrationAvailableResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val regent_id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val birthdate_exists:Boolean = new Boolean() with get,set
        member val birthdate_matches:Boolean = new Boolean() with get,set
        member val has_regent_login:Boolean = new Boolean() with get,set
        member val is_a_regis_person:Boolean = new Boolean() with get,set
        member val is_a_sugar_person:Boolean = new Boolean() with get,set
        member val term_is_available:Boolean = new Boolean() with get,set
        member val blocked_in_regis:Boolean = new Boolean() with get,set
        member val email_matches:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type RegistrationAvailableRequest() = 
        member val reporting_term:String = null with get,set
        member val first_name:String = null with get,set
        member val last_name:String = null with get,set
        member val email:String = null with get,set
        member val dob:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val regent_id:Nullable<Int32> = new Nullable<Int32>() with get,set

F# RegistrationAvailableRequest 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/{reporting_term}/Available HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	reporting_term: String,
	first_name: String,
	last_name: String,
	email: String,
	dob: 0001-01-01,
	regent_id: 0
}
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
		}
	},
	regent_id: 0,
	birthdate_exists: False,
	birthdate_matches: False,
	has_regent_login: False,
	is_a_regis_person: False,
	is_a_sugar_person: False,
	term_is_available: False,
	blocked_in_regis: False,
	email_matches: False
}