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}
import 'package:servicestack/servicestack.dart';

class StudentSearchRequest implements IConvertible
{
    int? page;
    String? reporting_term;

    StudentSearchRequest({this.page,this.reporting_term});
    StudentSearchRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        page = json['page'];
        reporting_term = json['reporting_term'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'page': page,
        'reporting_term': reporting_term
    };

    getTypeName() => "StudentSearchRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'StudentSearchRequest': TypeInfo(TypeOf.Class, create:() => StudentSearchRequest()),
});

Dart StudentSearchRequest DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	page: 0,
	reporting_term: String
}
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,
		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-01,
		is_student: False,
		is_faculty: False,
		is_vendor: False
	}
]