regis

<back to all web services

RegistrationActivityRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/registration/activity
"use strict";
export class RegistrationActivityRequest {
    /** @param {{uuid?:string,reporting_term?:string,from_date?:string,to_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    from_date;
    /** @type {string} */
    to_date;
}

JavaScript RegistrationActivityRequest 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 /registration/activity HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	reporting_term: String,
	from_date: 0001-01-01,
	to_date: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		regent_id: 0,
		uuid: String,
		student_name: String,
		email: String,
		course_name: String,
		section_code: String,
		amount: 0,
		is_change: False,
		is_drop: False,
		is_add: False,
		is_provisional: False,
		is_audit: False,
		reporting_term: String,
		transaction_uuid: String,
		transaction_notes: String,
		invoice_notes: String,
		documents: 
		[
			{
				uuid: String,
				regent_id: 0,
				first_name: String,
				last_name: String,
				gender: String,
				email: String,
				program: String,
				concentration: String,
				section_uuid: String,
				course_name: String,
				course_title: String,
				reporting_term: String,
				document_code: String,
				document_json: String,
				document_name: String,
				document_description: String,
				added_date: 0001-01-01,
				changed_date: 0001-01-01
			}
		],
		transaction_started: 0001-01-01,
		transaction_finished: 0001-01-01,
		is_admin: False,
		transaction_by: String
	}
]