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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class RegistrationAvailableRequest
            Public Overridable Property reporting_term As String
            Public Overridable Property first_name As String
            Public Overridable Property last_name As String
            Public Overridable Property email As String
            Public Overridable Property dob As Nullable(Of Date)
            Public Overridable Property regent_id As Nullable(Of Integer)
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class RegistrationAvailableResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property regent_id As Nullable(Of Integer)
            Public Overridable Property birthdate_exists As Boolean
            Public Overridable Property birthdate_matches As Boolean
            Public Overridable Property has_regent_login As Boolean
            Public Overridable Property is_a_regis_person As Boolean
            Public Overridable Property is_a_sugar_person As Boolean
            Public Overridable Property term_is_available As Boolean
            Public Overridable Property blocked_in_regis As Boolean
            Public Overridable Property email_matches As Boolean
        End Class
    End Namespace
End Namespace

VB.NET RegistrationAvailableRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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: application/json
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}