regis

<back to all web services

PhoneEmailHistoryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/admissions/{uuid}/phoneemail/history
PhoneEmailHistoryRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
PhoneEmailHistoryResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
uuidformstringNo
regent_idformintNo
phoneEmailsformList<PhoneEmailResponse>No
PhoneEmailResponse Parameters:
NameParameterData TypeRequiredDescription
phone_homeformstringNo
phone_cellformstringNo
phone_busformstringNo
emailformstringNo
start_dateformDateTime?No
end_dateformDateTime?No
added_byformstringNo
added_dateformDateTime?No
changed_byformstringNo
changed_dateformDateTime?No

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}/phoneemail/history HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<PhoneEmailHistoryResponse 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>
  <phoneEmails>
    <PhoneEmailResponse>
      <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>
    </PhoneEmailResponse>
  </phoneEmails>
  <regent_id>0</regent_id>
  <uuid>String</uuid>
</PhoneEmailHistoryResponse>