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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","regent_id":0,"names":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"first_name":"String","last_name":"String","middle_name":"String","preferred_name":"String","prefix":"String","created_date":"0001-01-01T00:00:00.0000000"}]}