regis

<back to all web services

UnauthenticatedPersonUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/UnauthenticatedPerson/{uuid}/Update

export class UnauthenticatedPersonResponse
{
    public responseStatus: ResponseStatus;
    public regent_id?: number;
    public reporting_term: string;
    public survey: string;
    public friend_referral: string;
    public other_referral: string;
    public is_returning: boolean;
    public is_applying: boolean;
    public is_landlord: boolean;
    public postsecondary_education_level: number;
    public uuid: string;
    public regent_login: string;
    public first_name: string;
    public middle_name: string;
    public last_name: string;
    public preferred_name: string;
    public birth_name: string;
    public spouse_name: 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 prefix: 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 added_by: string;
    public added_date?: string;
    public last_changed_by: string;
    public last_changed_date?: string;
    public addr_last_changed_by: string;
    public addr_last_changed_date?: string;
    public timestamp: string;
    public submitted_datetime?: string;
    public submitted_by_unauthenticated_person_id?: number;
    public authorized_datetime?: string;
    public authorized_by_person_id?: number;
    public archived_datetime?: string;
    public archived_by_person_id?: number;

    public constructor(init?: Partial<UnauthenticatedPersonResponse>) { (Object as any).assign(this, init); }
}

export class UnauthenticatedPersonUpdateRequest
{
    public uuid: string;
    public regent_id?: number;
    public is_returning: boolean;
    public is_applying: boolean;
    public is_landlord: boolean;
    public postsecondary_education_level: number;
    public reporting_term: string;
    public survey: string;
    public friend_referral: string;
    public other_referral: string;
    public first_name: string;
    public last_name: string;
    public email: string;
    public dob?: string;
    public middle_name: string;
    public birth_name: string;
    public preferred_name: string;
    public prefix: string;
    public addr1: string;
    public addr2: string;
    public country: string;
    public country_code: string;
    public state: string;
    public city: string;
    public code: string;
    public phone_home: string;
    public gender: string;
    public denomination: string;
    public occupation: string;
    public ethnicity: string;
    public citizenship: string;
    public citizenship_other: string;
    public permanent_resident: string;
    public marital_status: string;
    public is_submitted: boolean;

    public constructor(init?: Partial<UnauthenticatedPersonUpdateRequest>) { (Object as any).assign(this, init); }
}

TypeScript UnauthenticatedPersonUpdateRequest 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 /Registration/UnauthenticatedPerson/{uuid}/Update HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"uuid":"String","regent_id":0,"is_returning":false,"is_applying":false,"is_landlord":false,"postsecondary_education_level":0,"reporting_term":"String","survey":"String","friend_referral":"String","other_referral":"String","first_name":"String","last_name":"String","email":"String","dob":"0001-01-01T00:00:00.0000000","middle_name":"String","birth_name":"String","preferred_name":"String","prefix":"String","addr1":"String","addr2":"String","country":"String","country_code":"String","state":"String","city":"String","code":"String","phone_home":"String","gender":"String","denomination":"String","occupation":"String","ethnicity":"String","citizenship":"String","citizenship_other":"String","permanent_resident":"String","marital_status":"String","is_submitted":false}
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,"reporting_term":"String","survey":"String","friend_referral":"String","other_referral":"String","is_returning":false,"is_applying":false,"is_landlord":false,"postsecondary_education_level":0,"uuid":"String","regent_login":"String","first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","birth_name":"String","spouse_name":"String","addr1":"String","addr2":"String","country":"String","state":"String","city":"String","code":"String","phone_home":"String","phone_cell":"String","phone_bus":"String","email":"String","prefix":"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","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","last_changed_by":"String","last_changed_date":"0001-01-01T00:00:00.0000000","addr_last_changed_by":"String","addr_last_changed_date":"0001-01-01T00:00:00.0000000","timestamp":"0001-01-01T00:00:00.0000000","submitted_datetime":"0001-01-01T00:00:00.0000000","submitted_by_unauthenticated_person_id":0,"authorized_datetime":"0001-01-01T00:00:00.0000000","authorized_by_person_id":0,"archived_datetime":"0001-01-01T00:00:00.0000000","archived_by_person_id":0}