regis

AddressHistoryRequest

**Requires Authentication**
Required role:	REGISUserRole

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

import Foundation
import ServiceStack

public class AddressHistoryRequest : Codable
{
    public var uuid:String

    required public init(){}
}

public class AddressHistoryResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var uuid:String
    public var regent_id:Int
    public var addresses:[AddressPhoneEmailResponse] = []

    required public init(){}
}

public class AddressPhoneEmailResponse : Codable
{
    public var uuid:String
    public var regent_id:Int
    public var address:AddressResponse
    public var phone:PhoneEmailResponse

    required public init(){}
}

public class AddressResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var addr1:String
    public var addr2:String
    public var country:String
    public var country_code:String
    public var state:String
    public var city:String
    public var code:String
    public var start_date:Date?
    public var end_date:Date?
    public var added_by:String
    public var added_date:Date?
    public var changed_by:String
    public var changed_date:Date?

    required public init(){}
}

public class PhoneEmailResponse : Codable
{
    public var phone_home:String
    public var phone_cell:String
    public var phone_bus:String
    public var email:String
    public var start_date:Date?
    public var end_date:Date?
    public var added_by:String
    public var added_date:Date?
    public var changed_by:String
    public var changed_date:Date?

    required public init(){}
}

Swift 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>