| 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 .jsv suffix or ?format=jsv
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: 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,
uuid: String,
directory_settings:
{
directory_uuid: String,
waiver: String,
bday: 0001-01-01,
spouse_bday: 0001-01-01,
spouse_name: String,
wedding_date: 0001-01-01,
kids: String,
home_country: String,
quote: String,
bio: String,
interests: String,
category: String,
field_of_work: String,
church: String
},
directory_share_settings:
{
directory_uuid: String,
share_full_name: False,
share_bday: False,
share_home_phone: False,
share_cell_phone: False,
share_email: False,
share_address: False,
share_quote: False,
share_bio: False,
share_interests: False,
share_home_country: False,
share_program: False,
share_picture: False,
share_spouse_name: False,
share_spouse_bday: False,
share_wedding_date: False,
share_kids: False,
share_field_of_work: False,
share_church: False
},
person_lookup:
[
{
directory_uuid: String,
name: String,
is_active: False
}
]
}