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}
"use strict";
export class UnauthenticatedPersonResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,reporting_term?:string,survey?:string,friend_referral?:string,other_referral?:string,is_returning?:boolean,is_applying?:boolean,is_landlord?:boolean,postsecondary_education_level?:number,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?:string,citizenship?:string,citizenship_other?:string,permanent_resident?:string,denomination?:string,occupation?:string,ethnicity?:string,gender?:string,marital_status?:string,deceased_date?:string,added_by?:string,added_date?:string,last_changed_by?:string,last_changed_date?:string,addr_last_changed_by?:string,addr_last_changed_date?:string,timestamp?:string,submitted_datetime?:string,submitted_by_unauthenticated_person_id?:number,authorized_datetime?:string,authorized_by_person_id?:number,archived_datetime?:string,archived_by_person_id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {?number} */
    regent_id;
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    survey;
    /** @type {string} */
    friend_referral;
    /** @type {string} */
    other_referral;
    /** @type {boolean} */
    is_returning;
    /** @type {boolean} */
    is_applying;
    /** @type {boolean} */
    is_landlord;
    /** @type {number} */
    postsecondary_education_level;
    /** @type {string} */
    uuid;
    /** @type {string} */
    regent_login;
    /** @type {string} */
    first_name;
    /** @type {string} */
    middle_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    preferred_name;
    /** @type {string} */
    birth_name;
    /** @type {string} */
    spouse_name;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    country;
    /** @type {string} */
    state;
    /** @type {string} */
    city;
    /** @type {string} */
    code;
    /** @type {string} */
    phone_home;
    /** @type {string} */
    phone_cell;
    /** @type {string} */
    phone_bus;
    /** @type {string} */
    email;
    /** @type {string} */
    prefix;
    /** @type {?string} */
    dob;
    /** @type {string} */
    citizenship;
    /** @type {string} */
    citizenship_other;
    /** @type {string} */
    permanent_resident;
    /** @type {string} */
    denomination;
    /** @type {string} */
    occupation;
    /** @type {string} */
    ethnicity;
    /** @type {string} */
    gender;
    /** @type {string} */
    marital_status;
    /** @type {?string} */
    deceased_date;
    /** @type {string} */
    added_by;
    /** @type {?string} */
    added_date;
    /** @type {string} */
    last_changed_by;
    /** @type {?string} */
    last_changed_date;
    /** @type {string} */
    addr_last_changed_by;
    /** @type {?string} */
    addr_last_changed_date;
    /** @type {string} */
    timestamp;
    /** @type {?string} */
    submitted_datetime;
    /** @type {?number} */
    submitted_by_unauthenticated_person_id;
    /** @type {?string} */
    authorized_datetime;
    /** @type {?number} */
    authorized_by_person_id;
    /** @type {?string} */
    archived_datetime;
    /** @type {?number} */
    archived_by_person_id;
}
export class UnauthenticatedStudentSectionRegistrationResponse {
    /** @param {{section_uuid?:string,student_section_uuid?:string,course_name?:string,section_code?:string,course_title?:string,amount?:number,is_oncampus?:boolean,is_audit?:boolean,is_provisional?:boolean,is_missing_requisites?:boolean,is_other_restriction?:boolean,added_date?:string,added_by_person_id?:number,changed_date?:string,changed_by_person_id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    section_uuid;
    /** @type {string} */
    student_section_uuid;
    /** @type {string} */
    course_name;
    /** @type {string} */
    section_code;
    /** @type {string} */
    course_title;
    /** @type {number} */
    amount;
    /** @type {boolean} */
    is_oncampus;
    /** @type {boolean} */
    is_audit;
    /** @type {boolean} */
    is_provisional;
    /** @type {boolean} */
    is_missing_requisites;
    /** @type {boolean} */
    is_other_restriction;
    /** @type {?string} */
    added_date;
    /** @type {?number} */
    added_by_person_id;
    /** @type {?string} */
    changed_date;
    /** @type {?number} */
    changed_by_person_id;
}
export class UnauthenticatedRegistrationTransactionResponse {
    /** @param {{responseStatus?:ResponseStatus,transaction_uuid?:string,notes_json?:string,credit_hours?:number,audit_hours?:number,started_datetime?:string,archived_datetime?:string,submitted_datetime?:string,authorized_datetime?:string,person?:UnauthenticatedPersonResponse,registrations?:UnauthenticatedStudentSectionRegistrationResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    transaction_uuid;
    /** @type {string} */
    notes_json;
    /** @type {number} */
    credit_hours;
    /** @type {number} */
    audit_hours;
    /** @type {string} */
    started_datetime;
    /** @type {?string} */
    archived_datetime;
    /** @type {?string} */
    submitted_datetime;
    /** @type {?string} */
    authorized_datetime;
    /** @type {UnauthenticatedPersonResponse} */
    person;
    /** @type {UnauthenticatedStudentSectionRegistrationResponse[]} */
    registrations;
}
export class UnauthenticatedRegistrationTransactionRequest {
    /** @param {{reporting_term?:string,transaction_uuid?:string,authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    transaction_uuid;
    /** @type {string} */
    authorizing_uuid;
}

JavaScript UnauthenticatedRegistrationTransactionRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"reporting_term":"String","transaction_uuid":"String","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"}},"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}]}