regis

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';
import 'dart:typed_data';

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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<StudentSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <Page>0</Page>
  <reporting_term>String</reporting_term>
</StudentSearchRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfPersonSimpleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <PersonSimpleResponse>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <addr1>String</addr1>
    <addr2>String</addr2>
    <citizenship>String</citizenship>
    <citizenship_other>String</citizenship_other>
    <city>String</city>
    <code>String</code>
    <country>String</country>
    <dob>0001-01-01T00:00:00</dob>
    <email>String</email>
    <first_name>String</first_name>
    <is_faculty>false</is_faculty>
    <is_student>false</is_student>
    <is_vendor>false</is_vendor>
    <last_name>String</last_name>
    <middle_name>String</middle_name>
    <permanent_resident>String</permanent_resident>
    <phone_bus>String</phone_bus>
    <phone_cell>String</phone_cell>
    <phone_home>String</phone_home>
    <preferred_name>String</preferred_name>
    <regent_id>0</regent_id>
    <regent_login>String</regent_login>
    <state>String</state>
    <ubc_id>0</ubc_id>
    <uuid>String</uuid>
  </PersonSimpleResponse>
</ArrayOfPersonSimpleResponse>