regis

<back to all web services

PersonCreateRequest

Requires Authentication
Required permission:CreatePerson
The following routes are available for this service:
POST/person/create
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class PersonCreateRequest
    {
        public String first_name = null;
        public String middle_name = null;
        public String last_name = null;
        public String preferred_name = null;
        public String birth_name = null;
        public String prefix = null;
        public String addr1 = null;
        public String addr2 = null;
        public String country = null;
        public String state = null;
        public String city = null;
        public String code = null;
        public String phone_home = null;
        public String phone_cell = null;
        public String phone_bus = null;
        public String email = null;
        public Date dob = null;
        public String citizenship = null;
        public String citizenship_other = null;
        public String permanent_resident = null;
        public String denomination = null;
        public String occupation = null;
        public String ethnicity = null;
        public String gender = null;
        public String marital_status = null;
        public Date deceased_date = null;
        public Boolean do_not_queue_for_crm = null;
        public String authorizing_uuid = null;
        
        public String getFirstName() { return first_name; }
        public PersonCreateRequest setFirstName(String value) { this.first_name = value; return this; }
        public String getMiddleName() { return middle_name; }
        public PersonCreateRequest setMiddleName(String value) { this.middle_name = value; return this; }
        public String getLastName() { return last_name; }
        public PersonCreateRequest setLastName(String value) { this.last_name = value; return this; }
        public String getPreferredName() { return preferred_name; }
        public PersonCreateRequest setPreferredName(String value) { this.preferred_name = value; return this; }
        public String getBirthName() { return birth_name; }
        public PersonCreateRequest setBirthName(String value) { this.birth_name = value; return this; }
        public String getPrefix() { return prefix; }
        public PersonCreateRequest setPrefix(String value) { this.prefix = value; return this; }
        public String getAddr1() { return addr1; }
        public PersonCreateRequest setAddr1(String value) { this.addr1 = value; return this; }
        public String getAddr2() { return addr2; }
        public PersonCreateRequest setAddr2(String value) { this.addr2 = value; return this; }
        public String getCountry() { return country; }
        public PersonCreateRequest setCountry(String value) { this.country = value; return this; }
        public String getState() { return state; }
        public PersonCreateRequest setState(String value) { this.state = value; return this; }
        public String getCity() { return city; }
        public PersonCreateRequest setCity(String value) { this.city = value; return this; }
        public String getCode() { return code; }
        public PersonCreateRequest setCode(String value) { this.code = value; return this; }
        public String getPhoneHome() { return phone_home; }
        public PersonCreateRequest setPhoneHome(String value) { this.phone_home = value; return this; }
        public String getPhoneCell() { return phone_cell; }
        public PersonCreateRequest setPhoneCell(String value) { this.phone_cell = value; return this; }
        public String getPhoneBus() { return phone_bus; }
        public PersonCreateRequest setPhoneBus(String value) { this.phone_bus = value; return this; }
        public String getEmail() { return email; }
        public PersonCreateRequest setEmail(String value) { this.email = value; return this; }
        public Date getDob() { return dob; }
        public PersonCreateRequest setDob(Date value) { this.dob = value; return this; }
        public String getCitizenship() { return citizenship; }
        public PersonCreateRequest setCitizenship(String value) { this.citizenship = value; return this; }
        public String getCitizenshipOther() { return citizenship_other; }
        public PersonCreateRequest setCitizenshipOther(String value) { this.citizenship_other = value; return this; }
        public String getPermanentResident() { return permanent_resident; }
        public PersonCreateRequest setPermanentResident(String value) { this.permanent_resident = value; return this; }
        public String getDenomination() { return denomination; }
        public PersonCreateRequest setDenomination(String value) { this.denomination = value; return this; }
        public String getOccupation() { return occupation; }
        public PersonCreateRequest setOccupation(String value) { this.occupation = value; return this; }
        public String getEthnicity() { return ethnicity; }
        public PersonCreateRequest setEthnicity(String value) { this.ethnicity = value; return this; }
        public String getGender() { return gender; }
        public PersonCreateRequest setGender(String value) { this.gender = value; return this; }
        public String getMaritalStatus() { return marital_status; }
        public PersonCreateRequest setMaritalStatus(String value) { this.marital_status = value; return this; }
        public Date getDeceasedDate() { return deceased_date; }
        public PersonCreateRequest setDeceasedDate(Date value) { this.deceased_date = value; return this; }
        public Boolean isDoNotQueueForCrm() { return do_not_queue_for_crm; }
        public PersonCreateRequest setDoNotQueueForCrm(Boolean value) { this.do_not_queue_for_crm = value; return this; }
        public String getAuthorizingUuid() { return authorizing_uuid; }
        public PersonCreateRequest setAuthorizingUuid(String value) { this.authorizing_uuid = value; return this; }
    }

    public static class PersonCreateResponse
    {
        public ResponseStatus responseStatus = null;
        public Integer regent_id = null;
        public String uuid = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public PersonCreateResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public PersonCreateResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getUuid() { return uuid; }
        public PersonCreateResponse setUuid(String value) { this.uuid = value; return this; }
    }

}

Java PersonCreateRequest 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/create HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	first_name: String,
	middle_name: String,
	last_name: String,
	preferred_name: String,
	birth_name: String,
	prefix: String,
	addr1: String,
	addr2: String,
	country: String,
	state: String,
	city: String,
	code: String,
	phone_home: String,
	phone_cell: String,
	phone_bus: String,
	email: String,
	dob: 0001-01-01,
	citizenship: String,
	citizenship_other: String,
	permanent_resident: String,
	denomination: String,
	occupation: String,
	ethnicity: String,
	gender: String,
	marital_status: String,
	deceased_date: 0001-01-01,
	do_not_queue_for_crm: False,
	authorizing_uuid: 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,
	uuid: String
}