regis

<back to all web services

UnauthenticatedPersonRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/UnauthenticatedPerson/{uuid}

export class UnauthenticatedPersonResponse
{
    public responseStatus: ResponseStatus;
    public regent_id?: number;
    public reporting_term: string;
    public survey: string;
    public friend_referral: string;
    public other_referral: string;
    public is_returning: boolean;
    public is_applying: boolean;
    public is_landlord: boolean;
    public postsecondary_education_level: number;
    public uuid: string;
    public regent_login: string;
    public first_name: string;
    public middle_name: string;
    public last_name: string;
    public preferred_name: string;
    public birth_name: string;
    public spouse_name: string;
    public addr1: string;
    public addr2: string;
    public country: string;
    public state: string;
    public city: string;
    public code: string;
    public phone_home: string;
    public phone_cell: string;
    public phone_bus: string;
    public email: string;
    public prefix: string;
    public dob?: string;
    public citizenship: string;
    public citizenship_other: string;
    public permanent_resident: string;
    public denomination: string;
    public occupation: string;
    public ethnicity: string;
    public gender: string;
    public marital_status: string;
    public deceased_date?: string;
    public added_by: string;
    public added_date?: string;
    public last_changed_by: string;
    public last_changed_date?: string;
    public addr_last_changed_by: string;
    public addr_last_changed_date?: string;
    public timestamp: string;
    public submitted_datetime?: string;
    public submitted_by_unauthenticated_person_id?: number;
    public authorized_datetime?: string;
    public authorized_by_person_id?: number;
    public archived_datetime?: string;
    public archived_by_person_id?: number;

    public constructor(init?: Partial<UnauthenticatedPersonResponse>) { (Object as any).assign(this, init); }
}

export class UnauthenticatedPersonRequest
{
    public uuid: string;

    public constructor(init?: Partial<UnauthenticatedPersonRequest>) { (Object as any).assign(this, init); }
}

TypeScript UnauthenticatedPersonRequest 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 /Registration/UnauthenticatedPerson/{uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UnauthenticatedPersonRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <uuid>String</uuid>
</UnauthenticatedPersonRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UnauthenticatedPersonResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <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>
  <added_by>String</added_by>
  <added_date>0001-01-01T00:00:00</added_date>
  <addr1>String</addr1>
  <addr2>String</addr2>
  <addr_last_changed_by>String</addr_last_changed_by>
  <addr_last_changed_date>0001-01-01T00:00:00</addr_last_changed_date>
  <archived_by_person_id>0</archived_by_person_id>
  <archived_datetime>0001-01-01T00:00:00</archived_datetime>
  <authorized_by_person_id>0</authorized_by_person_id>
  <authorized_datetime>0001-01-01T00:00:00</authorized_datetime>
  <birth_name>String</birth_name>
  <citizenship>String</citizenship>
  <citizenship_other>String</citizenship_other>
  <city>String</city>
  <code>String</code>
  <country>String</country>
  <deceased_date>0001-01-01T00:00:00</deceased_date>
  <denomination>String</denomination>
  <dob>0001-01-01T00:00:00</dob>
  <email>String</email>
  <ethnicity>String</ethnicity>
  <first_name>String</first_name>
  <friend_referral>String</friend_referral>
  <gender>String</gender>
  <is_applying>false</is_applying>
  <is_landlord>false</is_landlord>
  <is_returning>false</is_returning>
  <last_changed_by>String</last_changed_by>
  <last_changed_date>0001-01-01T00:00:00</last_changed_date>
  <last_name>String</last_name>
  <marital_status>String</marital_status>
  <middle_name>String</middle_name>
  <occupation>String</occupation>
  <other_referral>String</other_referral>
  <permanent_resident>String</permanent_resident>
  <phone_bus>String</phone_bus>
  <phone_cell>String</phone_cell>
  <phone_home>String</phone_home>
  <postsecondary_education_level>0</postsecondary_education_level>
  <preferred_name>String</preferred_name>
  <prefix>String</prefix>
  <regent_id>0</regent_id>
  <regent_login>String</regent_login>
  <reporting_term>String</reporting_term>
  <spouse_name>String</spouse_name>
  <state>String</state>
  <submitted_by_unauthenticated_person_id>0</submitted_by_unauthenticated_person_id>
  <submitted_datetime>0001-01-01T00:00:00</submitted_datetime>
  <survey>String</survey>
  <timestamp>0001-01-01T00:00:00</timestamp>
  <uuid>String</uuid>
</UnauthenticatedPersonResponse>