| Required permission: | ReadPersonBaseValues |
| POST | /person/baseValues |
|---|
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
Imports regis.ClassLibrary.DatabaseModels.REGIS
Namespace Global
Namespace regis.ClassLibrary.DatabaseModels.REGIS
Public Partial Class Denomination
Public Overridable Property id As Integer
Public Overridable Property code As String
Public Overridable Property denomination_name As String
End Class
Public Partial Class Ethnicity
Public Overridable Property id As Integer
Public Overridable Property code As String
Public Overridable Property ethnicity_name As String
End Class
Public Partial Class Occupation
Public Overridable Property id As Integer
Public Overridable Property code As String
Public Overridable Property occupation_name As String
End Class
End Namespace
Namespace regis.ClassLibrary.Requests
Public Partial Class PersonBaseValuesRequest
End Class
End Namespace
Namespace regis.ClassLibrary.Responses
Public Partial Class CountriesAndStatesResponse
Public Sub New()
states = New Dictionary(Of String, String)
End Sub
Public Overridable Property country_code As String
Public Overridable Property country_name As String
Public Overridable Property states As Dictionary(Of String, String)
End Class
Public Partial Class PersonBaseValuesResponse
Public Sub New()
countriesAndStates = New List(Of CountriesAndStatesResponse)
prefixes = New List(Of PrefixResponse)
maritalStatuses = New Dictionary(Of String, String)
denominations = New List(Of Denomination)
occupations = New List(Of Occupation)
ethnicities = New List(Of Ethnicity)
End Sub
Public Overridable Property ResponseStatus As ResponseStatus
Public Overridable Property person As PersonExtendedResponse
Public Overridable Property countriesAndStates As List(Of CountriesAndStatesResponse)
Public Overridable Property prefixes As List(Of PrefixResponse)
Public Overridable Property maritalStatuses As Dictionary(Of String, String)
Public Overridable Property denominations As List(Of Denomination)
Public Overridable Property occupations As List(Of Occupation)
Public Overridable Property ethnicities As List(Of Ethnicity)
End Class
Public Partial Class PersonExtendedResponse
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 spouse_regent_id As Nullable(Of Integer)
Public Overridable Property uuid As String
Public Overridable Property regent_login As String
Public Overridable Property spouse_rwl 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 birth_name As String
Public Overridable Property override_transcript_name As String
Public Overridable Property spouse_name As String
Public Overridable Property addr1 As String
Public Overridable Property addr2 As String
Public Overridable Property country As String
Public Overridable Property state As String
Public Overridable Property city As String
Public Overridable Property code 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 email As String
Public Overridable Property prefix 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 denomination As String
Public Overridable Property occupation As String
Public Overridable Property ethnicity As String
Public Overridable Property gender As String
Public Overridable Property marital_status As String
Public Overridable Property deceased_date As Nullable(Of Date)
Public Overridable Property is_donor As Boolean
Public Overridable Property is_vendor As Boolean
Public Overridable Property is_gp_customer As Boolean
Public Overridable Property crm_student_status As String
Public Overridable Property crm_assigned As String
Public Overridable Property last_registered_term As String
Public Overridable Property is_regent_staff As Boolean
Public Overridable Property regent_title As String
Public Overridable Property regent_department As String
Public Overridable Property regent_faculty_profile_url As String
Public Overridable Property regent_image_url As String
Public Overridable Property include_on_website As Boolean
Public Overridable Property added_by As String
Public Overridable Property added_date As Nullable(Of Date)
Public Overridable Property last_changed_by As String
Public Overridable Property last_changed_date As Nullable(Of Date)
Public Overridable Property addr_last_changed_by As String
Public Overridable Property addr_last_changed_date As Nullable(Of Date)
Public Overridable Property tax_number As String
Public Overridable Property regent_current_program As String
Public Overridable Property regent_degrees As String
End Class
Public Partial Class PrefixResponse
Public Overridable Property prefix_code As String
Public Overridable Property prefix_name As String
End Class
End Namespace
End Namespace
VB.NET PersonBaseValuesRequest 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/baseValues HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
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
}
},
person:
{
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,
spouse_regent_id: 0,
uuid: String,
regent_login: String,
spouse_rwl: String,
first_name: String,
middle_name: String,
last_name: String,
preferred_name: String,
birth_name: String,
override_transcript_name: String,
spouse_name: String,
addr1: String,
addr2: String,
country: String,
state: String,
city: String,
code: String,
phone_home: String,
phone_cell: String,
phone_bus: String,
email: String,
prefix: String,
dob: 0001-01-01,
citizenship: String,
citizenship_other: String,
permanent_resident: String,
denomination: String,
occupation: String,
ethnicity: String,
gender: String,
marital_status: String,
deceased_date: 0001-01-01,
is_donor: False,
is_vendor: False,
is_gp_customer: False,
crm_student_status: String,
crm_assigned: String,
last_registered_term: String,
is_regent_staff: False,
regent_title: String,
regent_department: String,
regent_faculty_profile_url: String,
regent_image_url: String,
include_on_website: False,
added_by: String,
added_date: 0001-01-01,
last_changed_by: String,
last_changed_date: 0001-01-01,
addr_last_changed_by: String,
addr_last_changed_date: 0001-01-01,
tax_number: String,
regent_current_program: String,
regent_degrees: String
},
countriesAndStates:
[
{
country_code: String,
country_name: String,
states:
{
String: String
}
}
],
prefixes:
[
{
prefix_code: String,
prefix_name: String
}
],
maritalStatuses:
{
String: String
},
denominations:
[
{
id: 0,
code: String,
denomination_name: String
}
],
occupations:
[
{
id: 0,
code: String,
occupation_name: String
}
],
ethnicities:
[
{
id: 0,
code: String,
ethnicity_name: String
}
]
}