regis

<back to all web services

StudentSearchRequest

Requires Authentication
Required permission:SearchPerson
The following routes are available for this service:
POST/student/search
POST/student/search/page/{Page}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class StudentSearchRequest
            Public Overridable Property Page As Nullable(Of Integer)
            Public Overridable Property reporting_term As String
        End Class
    End Namespace
End Namespace

VB.NET StudentSearchRequest 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 /student/search HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"page":0,"reporting_term":"String"}
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,"ubc_id":0,"uuid":"String","regent_login":"String","first_name":"String","preferred_name":"String","middle_name":"String","last_name":"String","email":"String","phone_home":"String","phone_cell":"String","phone_bus":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","citizenship":"String","citizenship_other":"String","permanent_resident":"String","dob":"0001-01-01T00:00:00.0000000","is_student":false,"is_faculty":false,"is_vendor":false}]