Required permission: | ReadRegistrationAvailability |
POST | /Registration/{reporting_term}/Available |
---|
export class RegistrationAvailableResponse
{
public responseStatus: ResponseStatus;
public regent_id?: number;
public birthdate_exists: boolean;
public birthdate_matches: boolean;
public has_regent_login: boolean;
public is_a_regis_person: boolean;
public is_a_sugar_person: boolean;
public term_is_available: boolean;
public blocked_in_regis: boolean;
public email_matches: boolean;
public constructor(init?: Partial<RegistrationAvailableResponse>) { (Object as any).assign(this, init); }
}
export class RegistrationAvailableRequest
{
public reporting_term: string;
public first_name: string;
public last_name: string;
public email: string;
public dob?: string;
public regent_id?: number;
public constructor(init?: Partial<RegistrationAvailableRequest>) { (Object as any).assign(this, init); }
}
TypeScript RegistrationAvailableRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 }