regis

<back to all web services

InstitutionCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/Institution/Create

export class InstitutionResponse
{
    public responseStatus: ResponseStatus;
    public institution_id: number;
    public institution_name: string;
    public institution_previous_names: string;
    public institution_other_names: string;
    public institution_type: string;
    public accreditation_status: string;
    public accreditation_status_notes: string;
    public related_institutions: string[];
    public accreditation_status_changed_date?: string;
    public gpa_conversion: string;
    public credit_hour_conversion: string;
    public addr1: string;
    public addr2: string;
    public city: string;
    public state: string;
    public country: string;
    public zip: string;

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

export class InstitutionCreateRequest
{
    public institution_name: string;
    public institution_other_names: string;
    public institution_previous_names: string;
    public institution_type: string;
    public accreditation_status: string;
    public accreditation_status_notes: string;
    public accreditation_status_changed_date?: string;
    public gpa_conversion: string;
    public credit_hour_conversion: string;
    public authorizing_uuid: string;

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

TypeScript 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"}