regis

<back to all web services

PersonExtendedRequest

Requires Authentication
Required permission:SearchPerson
The following routes are available for this service:
POST/person/{uuid}/extended
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class PersonExtendedRequest
            Public Overridable Property uuid As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class PersonExtendedResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property regent_id As Integer
            Public Overridable Property ubc_id As Nullable(Of Integer)
            Public Overridable Property spouse_regent_id As Nullable(Of Integer)
            Public Overridable Property uuid As String
            Public Overridable Property regent_login As String
            Public Overridable Property spouse_rwl As String
            Public Overridable Property first_name As String
            Public Overridable Property middle_name As String
            Public Overridable Property last_name As String
            Public Overridable Property preferred_name As String
            Public Overridable Property birth_name As String
            Public Overridable Property override_transcript_name As String
            Public Overridable Property spouse_name As String
            Public Overridable Property addr1 As String
            Public Overridable Property addr2 As String
            Public Overridable Property country As String
            Public Overridable Property state As String
            Public Overridable Property city As String
            Public Overridable Property code As String
            Public Overridable Property phone_home As String
            Public Overridable Property phone_cell As String
            Public Overridable Property phone_bus As String
            Public Overridable Property email As String
            Public Overridable Property prefix As String
            Public Overridable Property dob As Nullable(Of Date)
            Public Overridable Property citizenship As String
            Public Overridable Property citizenship_other As String
            Public Overridable Property permanent_resident As String
            Public Overridable Property denomination As String
            Public Overridable Property occupation As String
            Public Overridable Property ethnicity As String
            Public Overridable Property gender As String
            Public Overridable Property marital_status As String
            Public Overridable Property deceased_date As Nullable(Of Date)
            Public Overridable Property is_donor As Boolean
            Public Overridable Property is_vendor As Boolean
            Public Overridable Property is_gp_customer As Boolean
            Public Overridable Property crm_student_status As String
            Public Overridable Property crm_assigned As String
            Public Overridable Property last_registered_term As String
            Public Overridable Property added_by As String
            Public Overridable Property added_date As Nullable(Of Date)
            Public Overridable Property last_changed_by As String
            Public Overridable Property last_changed_date As Nullable(Of Date)
            Public Overridable Property addr_last_changed_by As String
            Public Overridable Property addr_last_changed_date As Nullable(Of Date)
            Public Overridable Property tax_number As String
            Public Overridable Property regent_current_program As String
            Public Overridable Property regent_degrees As String
        End Class
    End Namespace
End Namespace

VB.NET PersonExtendedRequest 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/{uuid}/extended HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<PersonExtendedResponse 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>
  <birth_name>String</birth_name>
  <citizenship>String</citizenship>
  <citizenship_other>String</citizenship_other>
  <city>String</city>
  <code>String</code>
  <country>String</country>
  <crm_assigned>String</crm_assigned>
  <crm_student_status>String</crm_student_status>
  <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>
  <gender>String</gender>
  <is_donor>false</is_donor>
  <is_gp_customer>false</is_gp_customer>
  <is_vendor>false</is_vendor>
  <last_changed_by>String</last_changed_by>
  <last_changed_date>0001-01-01T00:00:00</last_changed_date>
  <last_name>String</last_name>
  <last_registered_term>String</last_registered_term>
  <marital_status>String</marital_status>
  <middle_name>String</middle_name>
  <occupation>String</occupation>
  <override_transcript_name>String</override_transcript_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>
  <prefix>String</prefix>
  <regent_current_program>String</regent_current_program>
  <regent_degrees>String</regent_degrees>
  <regent_id>0</regent_id>
  <regent_login>String</regent_login>
  <spouse_name>String</spouse_name>
  <spouse_regent_id>0</spouse_regent_id>
  <spouse_rwl>String</spouse_rwl>
  <state>String</state>
  <tax_number>String</tax_number>
  <ubc_id>0</ubc_id>
  <uuid>String</uuid>
</PersonExtendedResponse>