regis

PersonSearchRequest

**Requires Authentication**
Required permission:	SearchPerson

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;

namespace regis.ClassLibrary.Requests
{
    public partial class PersonSearchRequest
    {
        public virtual int? Page { get; set; }
        public virtual int? regent_id { get; set; }
        public virtual string regent_login { get; set; }
        public virtual string name { get; set; }
        public virtual string last_name { get; set; }
        public virtual string email { get; set; }
        public virtual string phone { get; set; }
        public virtual DateTime? dob { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class PersonSearchResponse
    {
        public PersonSearchResponse()
        {
            Persons = new List<PersonSimpleResponse>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<PersonSimpleResponse> Persons { get; set; }
    }

    public partial class PersonSimpleResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int regent_id { get; set; }
        public virtual int? ubc_id { get; set; }
        public virtual string uuid { get; set; }
        public virtual string regent_login { get; set; }
        public virtual string first_name { get; set; }
        public virtual string preferred_name { get; set; }
        public virtual string middle_name { get; set; }
        public virtual string last_name { get; set; }
        public virtual string email { get; set; }
        public virtual string phone_home { get; set; }
        public virtual string phone_cell { get; set; }
        public virtual string phone_bus { get; set; }
        public virtual string addr1 { get; set; }
        public virtual string addr2 { get; set; }
        public virtual string city { get; set; }
        public virtual string state { get; set; }
        public virtual string country { get; set; }
        public virtual string code { get; set; }
        public virtual string citizenship { get; set; }
        public virtual string citizenship_other { get; set; }
        public virtual string permanent_resident { get; set; }
        public virtual DateTime? dob { get; set; }
        public virtual bool is_student { get; set; }
        public virtual bool is_faculty { get; set; }
        public virtual bool is_vendor { get; set; }
    }

}

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

{
	page: 0,
	regent_id: 0,
	regent_login: String,
	name: String,
	last_name: String,
	email: String,
	phone: String,
	dob: 0001-01-01
}

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
		}
	},
	persons: 
	[
		{
			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
		}
	]
}