regis

RegistrationAvailableRequest

**Requires Authentication**
Required permission:	ReadRegistrationAvailability

The following routes are available for this service:
POST	/Registration/{reporting_term}/Available

"use strict";
export class RegistrationAvailableResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,birthdate_exists?:boolean,birthdate_matches?:boolean,has_regent_login?:boolean,is_a_regis_person?:boolean,is_a_sugar_person?:boolean,term_is_available?:boolean,blocked_in_regis?:boolean,email_matches?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {?number} */
    regent_id;
    /** @type {boolean} */
    birthdate_exists;
    /** @type {boolean} */
    birthdate_matches;
    /** @type {boolean} */
    has_regent_login;
    /** @type {boolean} */
    is_a_regis_person;
    /** @type {boolean} */
    is_a_sugar_person;
    /** @type {boolean} */
    term_is_available;
    /** @type {boolean} */
    blocked_in_regis;
    /** @type {boolean} */
    email_matches;
}
export class RegistrationAvailableRequest {
    /** @param {{reporting_term?:string,first_name?:string,last_name?:string,email?:string,dob?:string,regent_id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    first_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    email;
    /** @type {?string} */
    dob;
    /** @type {?number} */
    regent_id;
}

JavaScript RegistrationAvailableRequest DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"reporting_term":"String","first_name":"String","last_name":"String","email":"String","dob":"0001-01-01T00:00:00.0000000","regent_id":0}

HTTP/1.1 200 OK
Content-Type: text/csv
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}