Required permission: | CreatePerson |
POST | /person/create |
---|
export class PersonCreateResponse
{
public responseStatus: ResponseStatus;
public regent_id: number;
public uuid: string;
public constructor(init?: Partial<PersonCreateResponse>) { (Object as any).assign(this, init); }
}
export class PersonCreateRequest
{
public first_name: string;
public middle_name: string;
public last_name: string;
public preferred_name: string;
public birth_name: string;
public prefix: string;
public addr1: string;
public addr2: string;
public country: string;
public state: string;
public city: string;
public code: string;
public phone_home: string;
public phone_cell: string;
public phone_bus: string;
public email: string;
public dob?: string;
public citizenship: string;
public citizenship_other: string;
public permanent_resident: string;
public denomination: string;
public occupation: string;
public ethnicity: string;
public gender: string;
public marital_status: string;
public deceased_date?: string;
public do_not_queue_for_crm: boolean;
public authorizing_uuid: string;
public constructor(init?: Partial<PersonCreateRequest>) { (Object as any).assign(this, init); }
}
TypeScript PersonCreateRequest 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
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: application/json
Content-Type: application/json
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: 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"}