regis

<back to all web services

UnauthenticatedRegistrationTransactionRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/Unauthenticated/{reporting_term}/{transaction_uuid}

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 UnauthenticatedStudentSectionRegistrationResponse
{
    public section_uuid: string;
    public student_section_uuid: string;
    public course_name: string;
    public section_code: string;
    public course_title: string;
    public amount: number;
    public is_oncampus: boolean;
    public is_audit: boolean;
    public is_provisional: boolean;
    public is_missing_requisites: boolean;
    public is_other_restriction: boolean;
    public added_date?: string;
    public added_by_person_id?: number;
    public changed_date?: string;
    public changed_by_person_id?: number;

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

export class UnauthenticatedRegistrationTransactionResponse
{
    public responseStatus: ResponseStatus;
    public transaction_uuid: string;
    public notes_json: string;
    public credit_hours: number;
    public audit_hours: number;
    public started_datetime: string;
    public archived_datetime?: string;
    public submitted_datetime?: string;
    public authorized_datetime?: string;
    public person: UnauthenticatedPersonResponse;
    public registrations: UnauthenticatedStudentSectionRegistrationResponse[];

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

export class UnauthenticatedRegistrationTransactionRequest
{
    public reporting_term: string;
    public transaction_uuid: string;
    public authorizing_uuid: string;

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

TypeScript UnauthenticatedRegistrationTransactionRequest 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 /Registration/Unauthenticated/{reporting_term}/{transaction_uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"reporting_term":"String","transaction_uuid":"String","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"}},"transaction_uuid":"String","notes_json":"String","credit_hours":0,"audit_hours":0,"started_datetime":"0001-01-01T00:00:00.0000000","archived_datetime":"0001-01-01T00:00:00.0000000","submitted_datetime":"0001-01-01T00:00:00.0000000","authorized_datetime":"0001-01-01T00:00:00.0000000","person":{"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},"registrations":[{"section_uuid":"String","student_section_uuid":"String","course_name":"String","section_code":"String","course_title":"String","amount":0,"is_oncampus":false,"is_audit":false,"is_provisional":false,"is_missing_requisites":false,"is_other_restriction":false,"added_date":"0001-01-01T00:00:00.0000000","added_by_person_id":0,"changed_date":"0001-01-01T00:00:00.0000000","changed_by_person_id":0}]}