Required role: | REGISUserRole |
POST | /person/{uuid}/sidebar |
---|
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 PersonSideBarRequest
Public Overridable Property uuid As String
End Class
End Namespace
Namespace regis.ClassLibrary.Responses
Public Partial Class PersonSideBarResponse
Public Sub New()
programs = New List(Of StudentProgramSimpleResponse)
End Sub
Public Overridable Property ResponseStatus As ResponseStatus
Public Overridable Property regent_id As Integer
Public Overridable Property ubc_id As Nullable(Of Integer)
Public Overridable Property regent_login As String
Public Overridable Property uuid As String
Public Overridable Property first_name As String
Public Overridable Property middle_name As String
Public Overridable Property last_name As String
Public Overridable Property preferred_name As String
Public Overridable Property dob As Nullable(Of Date)
Public Overridable Property citizenship As String
Public Overridable Property citizenship_other As String
Public Overridable Property permanent_resident As String
Public Overridable Property addr1 As String
Public Overridable Property addr2 As String
Public Overridable Property city As String
Public Overridable Property state As String
Public Overridable Property code As String
Public Overridable Property country As String
Public Overridable Property email As String
Public Overridable Property phone_home As String
Public Overridable Property phone_cell As String
Public Overridable Property phone_bus As String
Public Overridable Property imageBase64 As String
Public Overridable Property tax_number As String
Public Overridable Property programs As List(Of StudentProgramSimpleResponse)
End Class
Public Partial Class StudentProgramSimpleResponse
Public Overridable Property ResponseStatus As ResponseStatus
Public Overridable Property regent_id As Integer
Public Overridable Property uuid As String
Public Overridable Property program_id As Integer
Public Overridable Property program_code As String
Public Overridable Property program_name As String
Public Overridable Property concentration_code As String
Public Overridable Property concentration_name As String
Public Overridable Property start_date As Nullable(Of Date)
Public Overridable Property end_date As Nullable(Of Date)
Public Overridable Property catalog As String
Public Overridable Property is_active As Boolean
Public Overridable Property is_graduated As Boolean
End Class
End Namespace
End Namespace
VB.NET PersonSideBarRequest 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 /person/{uuid}/sidebar 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 } }, regent_id: 0, ubc_id: 0, regent_login: String, uuid: String, first_name: String, middle_name: String, last_name: String, preferred_name: String, dob: 0001-01-01, citizenship: String, citizenship_other: String, permanent_resident: String, addr1: String, addr2: String, city: String, state: String, code: String, country: String, email: String, phone_home: String, phone_cell: String, phone_bus: String, imageBase64: String, tax_number: String, programs: [ { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, regent_id: 0, uuid: String, program_id: 0, program_code: String, program_name: String, concentration_code: String, concentration_name: String, start_date: 0001-01-01, end_date: 0001-01-01, catalog: String, is_active: False, is_graduated: False } ] }