Required permission: | CreatePerson |
POST | /person/create |
---|
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 PersonCreateResponse:
response_status: Optional[ResponseStatus] = None
regent_id: int = 0
uuid: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PersonCreateRequest:
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
prefix: 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
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
do_not_queue_for_crm: bool = False
authorizing_uuid: Optional[str] = None
Python PersonCreateRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /person/create HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","birth_name":"String","prefix":"String","addr1":"String","addr2":"String","country":"String","state":"String","city":"String","code":"String","phone_home":"String","phone_cell":"String","phone_bus":"String","email":"String","dob":"0001-01-01T00:00:00.0000000","citizenship":"String","citizenship_other":"String","permanent_resident":"String","denomination":"String","occupation":"String","ethnicity":"String","gender":"String","marital_status":"String","deceased_date":"0001-01-01T00:00:00.0000000","do_not_queue_for_crm":false,"authorizing_uuid":"String"}
HTTP/1.1 200 OK Content-Type: text/jsonl 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"}