Required role: | REGISUserRole |
POST | /person/{uuid}/addressandbio/update |
---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddressAndBioUpdateResponse:
response_status: Optional[ResponseStatus] = None
update_success: bool = False
messages: Optional[List[str]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddressAndBioUpdateRequest:
uuid: Optional[str] = None
spouse_regent_id: Optional[int] = None
first_name: Optional[str] = None
middle_name: Optional[str] = None
last_name: Optional[str] = None
preferred_name: Optional[str] = None
birth_name: Optional[str] = None
addr1: Optional[str] = None
addr2: Optional[str] = None
country: Optional[str] = None
state: Optional[str] = None
city: Optional[str] = None
code: Optional[str] = None
phone_home: Optional[str] = None
phone_cell: Optional[str] = None
phone_bus: Optional[str] = None
email: Optional[str] = None
prefix: Optional[str] = None
dob: Optional[datetime.datetime] = None
citizenship: Optional[str] = None
citizenship_other: Optional[str] = None
permanent_resident: Optional[str] = None
denomination: Optional[str] = None
occupation: Optional[str] = None
ethnicity: Optional[str] = None
gender: Optional[str] = None
marital_status: Optional[str] = None
deceased_date: Optional[datetime.datetime] = None
tax_number: Optional[str] = None
update_re_and_sugar: bool = False
regent_title: Optional[str] = None
regent_department: Optional[str] = None
regent_faculty_profile_url: Optional[str] = None
regent_image_url: Optional[str] = None
include_on_website: bool = False
authorizing_uuid: Optional[str] = None
Python AddressAndBioUpdateRequest 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}/addressandbio/update HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
uuid: String,
spouse_regent_id: 0,
first_name: String,
middle_name: String,
last_name: String,
preferred_name: String,
birth_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,
tax_number: String,
update_re_and_sugar: False,
regent_title: String,
regent_department: String,
regent_faculty_profile_url: String,
regent_image_url: String,
include_on_website: False,
authorizing_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 } }, update_success: False, messages: [ String ] }