Required permission: | ReadRegistrationAvailability |
POST | /Registration/{reporting_term}/Available |
---|
import Foundation
import ServiceStack
public class RegistrationAvailableRequest : Codable
{
public var reporting_term:String
public var first_name:String
public var last_name:String
public var email:String
public var dob:Date?
public var regent_id:Int?
required public init(){}
}
public class RegistrationAvailableResponse : Codable
{
public var responseStatus:ResponseStatus
public var regent_id:Int?
public var birthdate_exists:Bool
public var birthdate_matches:Bool
public var has_regent_login:Bool
public var is_a_regis_person:Bool
public var is_a_sugar_person:Bool
public var term_is_available:Bool
public var blocked_in_regis:Bool
public var email_matches:Bool
required public init(){}
}
Swift 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 }