regis

AddressHistoryRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/admissions/{uuid}/address/history

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 AddressHistoryRequest
            Public Overridable Property uuid As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class AddressHistoryResponse
            Public Sub New()
                addresses = New List(Of AddressPhoneEmailResponse)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property uuid As String
            Public Overridable Property regent_id As Integer
            Public Overridable Property addresses As List(Of AddressPhoneEmailResponse)
        End Class

        Public Partial Class AddressPhoneEmailResponse
            Public Overridable Property uuid As String
            Public Overridable Property regent_id As Integer
            Public Overridable Property address As AddressResponse
            Public Overridable Property phone As PhoneEmailResponse
        End Class

        Public Partial Class AddressResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property addr1 As String
            Public Overridable Property addr2 As String
            Public Overridable Property country As String
            Public Overridable Property country_code As String
            Public Overridable Property state As String
            Public Overridable Property city As String
            Public Overridable Property code As String
            Public Overridable Property start_date As Nullable(Of Date)
            Public Overridable Property end_date As Nullable(Of Date)
            Public Overridable Property added_by As String
            Public Overridable Property added_date As Nullable(Of Date)
            Public Overridable Property changed_by As String
            Public Overridable Property changed_date As Nullable(Of Date)
        End Class

        Public Partial Class PhoneEmailResponse
            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 start_date As Nullable(Of Date)
            Public Overridable Property end_date As Nullable(Of Date)
            Public Overridable Property added_by As String
            Public Overridable Property added_date As Nullable(Of Date)
            Public Overridable Property changed_by As String
            Public Overridable Property changed_date As Nullable(Of Date)
        End Class
    End Namespace
End Namespace

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

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

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

<AddressHistoryResponse 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>
  <addresses>
    <AddressPhoneEmailResponse>
      <address>
        <ResponseStatus xmlns:d5p1="http://schemas.servicestack.net/types">
          <d5p1:ErrorCode>String</d5p1:ErrorCode>
          <d5p1:Message>String</d5p1:Message>
          <d5p1:StackTrace>String</d5p1:StackTrace>
          <d5p1:Errors>
            <d5p1:ResponseError>
              <d5p1:ErrorCode>String</d5p1:ErrorCode>
              <d5p1:FieldName>String</d5p1:FieldName>
              <d5p1:Message>String</d5p1:Message>
              <d5p1:Meta xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:KeyValueOfstringstring>
                  <d8p1:Key>String</d8p1:Key>
                  <d8p1:Value>String</d8p1:Value>
                </d8p1:KeyValueOfstringstring>
              </d5p1:Meta>
            </d5p1:ResponseError>
          </d5p1:Errors>
          <d5p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d5p1:Meta>
        </ResponseStatus>
        <added_by>String</added_by>
        <added_date>0001-01-01T00:00:00</added_date>
        <addr1>String</addr1>
        <addr2>String</addr2>
        <changed_by>String</changed_by>
        <changed_date>0001-01-01T00:00:00</changed_date>
        <city>String</city>
        <code>String</code>
        <country>String</country>
        <country_code>String</country_code>
        <end_date>0001-01-01T00:00:00</end_date>
        <start_date>0001-01-01T00:00:00</start_date>
        <state>String</state>
      </address>
      <phone>
        <added_by>String</added_by>
        <added_date>0001-01-01T00:00:00</added_date>
        <changed_by>String</changed_by>
        <changed_date>0001-01-01T00:00:00</changed_date>
        <email>String</email>
        <end_date>0001-01-01T00:00:00</end_date>
        <phone_bus>String</phone_bus>
        <phone_cell>String</phone_cell>
        <phone_home>String</phone_home>
        <start_date>0001-01-01T00:00:00</start_date>
      </phone>
      <regent_id>0</regent_id>
      <uuid>String</uuid>
    </AddressPhoneEmailResponse>
  </addresses>
  <regent_id>0</regent_id>
  <uuid>String</uuid>
</AddressHistoryResponse>