regis

ProgramsRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Programs

"use strict";
export class ProgramResponse {
    /** @param {{responseStatus?:ResponseStatus,id?:number,program_code?:string,program_pretty_code?:string,program_long_name?:string,available_concentrations?:string,is_active?:boolean,timestamp?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    id;
    /** @type {string} */
    program_code;
    /** @type {string} */
    program_pretty_code;
    /** @type {string} */
    program_long_name;
    /** @type {string} */
    available_concentrations;
    /** @type {boolean} */
    is_active;
    /** @type {string} */
    timestamp;
}
export class ProgramsResponse {
    /** @param {{responseStatus?:ResponseStatus,programs?:ProgramResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {ProgramResponse[]} */
    programs;
}
export class ProgramsRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript ProgramsRequest DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Programs HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	programs: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			id: 0,
			program_code: String,
			program_pretty_code: String,
			program_long_name: String,
			available_concentrations: String,
			is_active: False,
			timestamp: 0001-01-01
		}
	]
}