| Required role: | REGISUserRole |
| POST | /Directory/Settings/{uuid} |
|---|
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 DirectoryResponse:
directory_uuid: Optional[str] = None
waiver: Optional[str] = None
bday: Optional[datetime.datetime] = None
spouse_bday: Optional[datetime.datetime] = None
spouse_name: Optional[str] = None
wedding_date: Optional[datetime.datetime] = None
kids: Optional[str] = None
home_country: Optional[str] = None
quote: Optional[str] = None
bio: Optional[str] = None
interests: Optional[str] = None
category: Optional[str] = None
field_of_work: Optional[str] = None
church: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DirectoryShareSettingsResponse:
directory_uuid: Optional[str] = None
share_full_name: bool = False
share_bday: bool = False
share_home_phone: bool = False
share_cell_phone: bool = False
share_email: bool = False
share_address: bool = False
share_quote: bool = False
share_bio: bool = False
share_interests: bool = False
share_home_country: bool = False
share_program: bool = False
share_picture: bool = False
share_spouse_name: bool = False
share_spouse_bday: bool = False
share_wedding_date: bool = False
share_kids: bool = False
share_field_of_work: bool = False
share_church: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DirectoryPersonLookupResponse:
directory_uuid: Optional[str] = None
name: Optional[str] = None
is_active: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DirectorySettingsAndPersonLookupResponse:
response_status: Optional[ResponseStatus] = None
regent_id: int = 0
uuid: Optional[str] = None
directory_settings: Optional[DirectoryResponse] = None
directory_share_settings: Optional[DirectoryShareSettingsResponse] = None
person_lookup: Optional[List[DirectoryPersonLookupResponse]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DirectorySettingsAndActivePersonLookupRequest:
uuid: Optional[str] = None
Python DirectorySettingsAndActivePersonLookupRequest 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 /Directory/Settings/{uuid} HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<DirectorySettingsAndActivePersonLookupRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<uuid>String</uuid>
</DirectorySettingsAndActivePersonLookupRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<DirectorySettingsAndPersonLookupResponse 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>
<directory_settings>
<bday>0001-01-01T00:00:00</bday>
<bio>String</bio>
<category>String</category>
<church>String</church>
<directory_uuid>String</directory_uuid>
<field_of_work>String</field_of_work>
<home_country>String</home_country>
<interests>String</interests>
<kids>String</kids>
<quote>String</quote>
<spouse_bday>0001-01-01T00:00:00</spouse_bday>
<spouse_name>String</spouse_name>
<waiver>String</waiver>
<wedding_date>0001-01-01T00:00:00</wedding_date>
</directory_settings>
<directory_share_settings>
<directory_uuid>String</directory_uuid>
<share_address>false</share_address>
<share_bday>false</share_bday>
<share_bio>false</share_bio>
<share_cell_phone>false</share_cell_phone>
<share_church>false</share_church>
<share_email>false</share_email>
<share_field_of_work>false</share_field_of_work>
<share_full_name>false</share_full_name>
<share_home_country>false</share_home_country>
<share_home_phone>false</share_home_phone>
<share_interests>false</share_interests>
<share_kids>false</share_kids>
<share_picture>false</share_picture>
<share_program>false</share_program>
<share_quote>false</share_quote>
<share_spouse_bday>false</share_spouse_bday>
<share_spouse_name>false</share_spouse_name>
<share_wedding_date>false</share_wedding_date>
</directory_share_settings>
<person_lookup>
<DirectoryPersonLookupResponse>
<directory_uuid>String</directory_uuid>
<is_active>false</is_active>
<name>String</name>
</DirectoryPersonLookupResponse>
</person_lookup>
<regent_id>0</regent_id>
<uuid>String</uuid>
</DirectorySettingsAndPersonLookupResponse>