regis

PersonSearchRequest

**Requires Authentication**
Required permission:	SearchPerson

The following routes are available for this service:
POST	/person/search/page/{Page}
POST	/person/search

import Foundation
import ServiceStack

public class PersonSearchRequest : Codable
{
    public var page:Int?
    public var regent_id:Int?
    public var regent_login:String
    public var name:String
    public var last_name:String
    public var email:String
    public var phone:String
    public var dob:Date?

    required public init(){}
}

public class PersonSearchResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var persons:[PersonSimpleResponse] = []

    required public init(){}
}

public class PersonSimpleResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int
    public var ubc_id:Int?
    public var uuid:String
    public var regent_login:String
    public var first_name:String
    public var preferred_name:String
    public var middle_name:String
    public var last_name:String
    public var email:String
    public var phone_home:String
    public var phone_cell:String
    public var phone_bus:String
    public var addr1:String
    public var addr2:String
    public var city:String
    public var state:String
    public var country:String
    public var code:String
    public var citizenship:String
    public var citizenship_other:String
    public var permanent_resident:String
    public var dob:Date?
    public var is_student:Bool
    public var is_faculty:Bool
    public var is_vendor:Bool

    required public init(){}
}

Swift PersonSearchRequest 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 /person/search/page/{Page} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PersonSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <Page>0</Page>
  <dob>0001-01-01T00:00:00</dob>
  <email>String</email>
  <last_name>String</last_name>
  <name>String</name>
  <phone>String</phone>
  <regent_id>0</regent_id>
  <regent_login>String</regent_login>
</PersonSearchRequest>

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

<PersonSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <Persons>
    <PersonSimpleResponse>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1: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>
        </d4p1: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>
  </Persons>
  <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>
</PersonSearchResponse>