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 Foundation
import ServiceStack

public class NameHistoryRequest : Codable
{
    public var uuid:String

    required public init(){}
}

public class NameHistoryResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var uuid:String
    public var regent_id:Int
    public var names:[NameResponse] = []

    required public init(){}
}

public class NameResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var first_name:String
    public var last_name:String
    public var middle_name:String
    public var preferred_name:String
    public var `prefix`:String
    public var created_date:Date?

    required public init(){}
}


Swift NameHistoryRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}]}