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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<RegistrationAvailableRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<dob>0001-01-01T00:00:00</dob>
<email>String</email>
<first_name>String</first_name>
<last_name>String</last_name>
<regent_id>0</regent_id>
<reporting_term>String</reporting_term>
</RegistrationAvailableRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <RegistrationAvailableResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses"> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <birthdate_exists>false</birthdate_exists> <birthdate_matches>false</birthdate_matches> <blocked_in_regis>false</blocked_in_regis> <email_matches>false</email_matches> <has_regent_login>false</has_regent_login> <is_a_regis_person>false</is_a_regis_person> <is_a_sugar_person>false</is_a_sugar_person> <regent_id>0</regent_id> <term_is_available>false</term_is_available> </RegistrationAvailableResponse>