regis

<back to all web services

NameHistoryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/admissions/{uuid}/name/history
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class NameHistoryRequest
    {
        public String uuid = null;
        
        public String getUuid() { return uuid; }
        public NameHistoryRequest setUuid(String value) { this.uuid = value; return this; }
    }

    public static class NameHistoryResponse
    {
        public ResponseStatus responseStatus = null;
        public String uuid = null;
        public Integer regent_id = null;
        public ArrayList<NameResponse> names = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public NameHistoryResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public String getUuid() { return uuid; }
        public NameHistoryResponse setUuid(String value) { this.uuid = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public NameHistoryResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public ArrayList<NameResponse> getNames() { return names; }
        public NameHistoryResponse setNames(ArrayList<NameResponse> value) { this.names = value; return this; }
    }

    public static class NameResponse
    {
        public ResponseStatus responseStatus = null;
        public String first_name = null;
        public String last_name = null;
        public String middle_name = null;
        public String preferred_name = null;
        public String prefix = null;
        public Date created_date = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public NameResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public String getFirstName() { return first_name; }
        public NameResponse setFirstName(String value) { this.first_name = value; return this; }
        public String getLastName() { return last_name; }
        public NameResponse setLastName(String value) { this.last_name = value; return this; }
        public String getMiddleName() { return middle_name; }
        public NameResponse setMiddleName(String value) { this.middle_name = value; return this; }
        public String getPreferredName() { return preferred_name; }
        public NameResponse setPreferredName(String value) { this.preferred_name = value; return this; }
        public String getPrefix() { return prefix; }
        public NameResponse setPrefix(String value) { this.prefix = value; return this; }
        public Date getCreatedDate() { return created_date; }
        public NameResponse setCreatedDate(Date value) { this.created_date = value; return this; }
    }

}

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

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

<NameHistoryResponse 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>
  <names>
    <NameResponse>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1: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>
        </d4p1:Meta>
      </ResponseStatus>
      <created_date>0001-01-01T00:00:00</created_date>
      <first_name>String</first_name>
      <last_name>String</last_name>
      <middle_name>String</middle_name>
      <preferred_name>String</preferred_name>
      <prefix>String</prefix>
    </NameResponse>
  </names>
  <regent_id>0</regent_id>
  <uuid>String</uuid>
</NameHistoryResponse>