regis

<back to all web services

DirectorySettingsAndActivePersonLookupRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","spouse_bday":"0001-01-01T00:00:00.0000000","spouse_name":"String","wedding_date":"0001-01-01T00:00:00.0000000","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}]}