regis

<back to all web services

PersonCreateRequest

Requires Authentication
Required permission:CreatePerson
The following routes are available for this service:
POST/person/create
import Foundation
import ServiceStack

public class PersonCreateRequest : Codable
{
    public var first_name:String
    public var middle_name:String
    public var last_name:String
    public var preferred_name:String
    public var birth_name:String
    public var `prefix`:String
    public var addr1:String
    public var addr2:String
    public var country:String
    public var state:String
    public var city:String
    public var code:String
    public var phone_home:String
    public var phone_cell:String
    public var phone_bus:String
    public var email:String
    public var dob:Date?
    public var citizenship:String
    public var citizenship_other:String
    public var permanent_resident:String
    public var denomination:String
    public var occupation:String
    public var ethnicity:String
    public var gender:String
    public var marital_status:String
    public var deceased_date:Date?
    public var do_not_queue_for_crm:Bool
    public var authorizing_uuid:String

    required public init(){}
}

public class PersonCreateResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int
    public var uuid:String

    required public init(){}
}


Swift PersonCreateRequest 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 /person/create HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
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/csv
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"}