Required role: | REGISUserRole |
POST | /admissions/{uuid}/name/history |
---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses
Namespace Global
Namespace regis.ClassLibrary.Requests
Public Partial Class NameHistoryRequest
Public Overridable Property uuid As String
End Class
End Namespace
Namespace regis.ClassLibrary.Responses
Public Partial Class NameHistoryResponse
Public Sub New()
names = New List(Of NameResponse)
End Sub
Public Overridable Property ResponseStatus As ResponseStatus
Public Overridable Property uuid As String
Public Overridable Property regent_id As Integer
Public Overridable Property names As List(Of NameResponse)
End Class
Public Partial Class NameResponse
Public Overridable Property ResponseStatus As ResponseStatus
Public Overridable Property first_name As String
Public Overridable Property last_name As String
Public Overridable Property middle_name As String
Public Overridable Property preferred_name As String
Public Overridable Property prefix As String
Public Overridable Property created_date As Nullable(Of Date)
End Class
End Namespace
End Namespace
VB.NET NameHistoryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
uuid: String
}
HTTP/1.1 200 OK Content-Type: text/jsv 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-01 } ] }