regis

<back to all web services

InstitutionCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/Institution/Create
"use strict";
export class InstitutionResponse {
    /** @param {{responseStatus?:ResponseStatus,institution_id?:number,institution_name?:string,institution_previous_names?:string,institution_other_names?:string,institution_type?:string,accreditation_status?:string,accreditation_status_notes?:string,related_institutions?:string[],accreditation_status_changed_date?:string,gpa_conversion?:string,credit_hour_conversion?:string,addr1?:string,addr2?:string,city?:string,state?:string,country?:string,zip?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    institution_id;
    /** @type {string} */
    institution_name;
    /** @type {string} */
    institution_previous_names;
    /** @type {string} */
    institution_other_names;
    /** @type {string} */
    institution_type;
    /** @type {string} */
    accreditation_status;
    /** @type {string} */
    accreditation_status_notes;
    /** @type {string[]} */
    related_institutions;
    /** @type {?string} */
    accreditation_status_changed_date;
    /** @type {string} */
    gpa_conversion;
    /** @type {string} */
    credit_hour_conversion;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    city;
    /** @type {string} */
    state;
    /** @type {string} */
    country;
    /** @type {string} */
    zip;
}
export class InstitutionCreateRequest {
    /** @param {{institution_name?:string,institution_other_names?:string,institution_previous_names?:string,institution_type?:string,accreditation_status?:string,accreditation_status_notes?:string,accreditation_status_changed_date?:string,gpa_conversion?:string,credit_hour_conversion?:string,authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    institution_name;
    /** @type {string} */
    institution_other_names;
    /** @type {string} */
    institution_previous_names;
    /** @type {string} */
    institution_type;
    /** @type {string} */
    accreditation_status;
    /** @type {string} */
    accreditation_status_notes;
    /** @type {?string} */
    accreditation_status_changed_date;
    /** @type {string} */
    gpa_conversion;
    /** @type {string} */
    credit_hour_conversion;
    /** @type {string} */
    authorizing_uuid;
}

JavaScript InstitutionCreateRequest 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 /Academic/Institution/Create HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"institution_name":"String","institution_other_names":"String","institution_previous_names":"String","institution_type":"String","accreditation_status":"String","accreditation_status_notes":"String","accreditation_status_changed_date":"0001-01-01T00:00:00.0000000","gpa_conversion":"String","credit_hour_conversion":"String","authorizing_uuid":"String"}

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"}},"institution_id":0,"institution_name":"String","institution_previous_names":"String","institution_other_names":"String","institution_type":"String","accreditation_status":"String","accreditation_status_notes":"String","related_institutions":["String"],"accreditation_status_changed_date":"0001-01-01T00:00:00.0000000","gpa_conversion":"String","credit_hour_conversion":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","zip":"String"}