regis

<back to all web services

DirectoryPersonRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Directory/{directory_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 DirectoryPersonResponse:
    response_status: Optional[ResponseStatus] = None
    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
    image_base64: Optional[str] = None
    preferred_name: Optional[str] = None
    last_name: Optional[str] = None
    addr1: Optional[str] = None
    addr2: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    country: Optional[str] = None
    code: Optional[str] = None
    email: Optional[str] = None
    phone_home: Optional[str] = None
    phone_cell: Optional[str] = None
    program: Optional[str] = None
    field_of_work: Optional[str] = None
    church: Optional[str] = None
    is_student: bool = False
    is_staff: bool = False
    is_faculty: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DirectoryPersonRequest:
    directory_uuid: Optional[str] = None

Python DirectoryPersonRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Directory/{directory_uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"directory_uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"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","imageBase64":"String","preferred_name":"String","last_name":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","email":"String","phone_home":"String","phone_cell":"String","program":"String","field_of_work":"String","church":"String","is_student":false,"is_staff":false,"is_faculty":false}