Required role: | REGISUserRole |
POST | /person/{uuid}/addressandbio/update |
---|
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 AddressAndBioUpdateRequest
Public Overridable Property uuid As String
Public Overridable Property spouse_regent_id As Nullable(Of Integer)
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 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 tax_number As String
Public Overridable Property update_re_and_sugar 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 authorizing_uuid As String
End Class
End Namespace
Namespace regis.ClassLibrary.Responses
Public Partial Class AddressAndBioUpdateResponse
Public Sub New()
messages = New List(Of String)
End Sub
Public Overridable Property ResponseStatus As ResponseStatus
Public Overridable Property update_success As Boolean
Public Overridable Property messages As List(Of String)
End Class
End Namespace
End Namespace
VB.NET AddressAndBioUpdateRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /person/{uuid}/addressandbio/update HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AddressAndBioUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<addr1>String</addr1>
<addr2>String</addr2>
<authorizing_uuid>String</authorizing_uuid>
<birth_name>String</birth_name>
<citizenship>String</citizenship>
<citizenship_other>String</citizenship_other>
<city>String</city>
<code>String</code>
<country>String</country>
<deceased_date>0001-01-01T00:00:00</deceased_date>
<denomination>String</denomination>
<dob>0001-01-01T00:00:00</dob>
<email>String</email>
<ethnicity>String</ethnicity>
<first_name>String</first_name>
<gender>String</gender>
<include_on_website>false</include_on_website>
<last_name>String</last_name>
<marital_status>String</marital_status>
<middle_name>String</middle_name>
<occupation>String</occupation>
<permanent_resident>String</permanent_resident>
<phone_bus>String</phone_bus>
<phone_cell>String</phone_cell>
<phone_home>String</phone_home>
<preferred_name>String</preferred_name>
<prefix>String</prefix>
<regent_department>String</regent_department>
<regent_faculty_profile_url>String</regent_faculty_profile_url>
<regent_image_url>String</regent_image_url>
<regent_title>String</regent_title>
<spouse_regent_id>0</spouse_regent_id>
<state>String</state>
<tax_number>String</tax_number>
<update_re_and_sugar>false</update_re_and_sugar>
<uuid>String</uuid>
</AddressAndBioUpdateRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <AddressAndBioUpdateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses"> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>String</d2p1:string> </messages> <update_success>false</update_success> </AddressAndBioUpdateResponse>