regis

<back to all web services

RegistrationInProgressSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/InProgress/{uuid}/Term/{reporting_term}/Submit
"use strict";
export class RegistrationInProgressSubmitResponse {
    /** @param {{responseStatus?:ResponseStatus,email?:string,first_name?:string,preferred_name?:string,last_name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    email;
    /** @type {string} */
    first_name;
    /** @type {string} */
    preferred_name;
    /** @type {string} */
    last_name;
}
export class RegistrationInProgressSubmitRequest {
    /** @param {{transaction_uuid?:string,uuid?:string,reporting_term?:string,rates_opted_in?:number[],authorizing_uuid?:string,casl_optin?:boolean,ams_optin?:boolean,rcsa_locker_optin?:boolean,appliedForDEReentryBenefit?:boolean,appliedForSpousalAuditBenefit?:boolean,appliedForSpousalCreditBenefit?:boolean,notes?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    transaction_uuid;
    /** @type {string} */
    uuid;
    /** @type {string} */
    reporting_term;
    /** @type {number[]} */
    rates_opted_in;
    /** @type {string} */
    authorizing_uuid;
    /** @type {boolean} */
    casl_optin;
    /** @type {boolean} */
    ams_optin;
    /** @type {boolean} */
    rcsa_locker_optin;
    /** @type {boolean} */
    appliedForDEReentryBenefit;
    /** @type {boolean} */
    appliedForSpousalAuditBenefit;
    /** @type {boolean} */
    appliedForSpousalCreditBenefit;
    /** @type {string} */
    notes;
}

JavaScript RegistrationInProgressSubmitRequest 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/InProgress/{uuid}/Term/{reporting_term}/Submit HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"transaction_uuid":"String","uuid":"String","reporting_term":"String","rates_opted_in":[0],"authorizing_uuid":"String","casl_optin":false,"ams_optin":false,"rcsa_locker_optin":false,"appliedForDEReentryBenefit":false,"appliedForSpousalAuditBenefit":false,"appliedForSpousalCreditBenefit":false,"notes":"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"}},"email":"String","first_name":"String","preferred_name":"String","last_name":"String"}