regis

<back to all web services

RegistrationDocumentSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/Document/{uuid}/Term/{reporting_term}/Submit
"use strict";
export class RegistrationDocumentSubmitRequest {
    /** @param {{uuid?:string,authorizing_uuid?:string,section_uuid?:string,reporting_term?:string,document_code?:string,document_json?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    authorizing_uuid;
    /** @type {string} */
    section_uuid;
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    document_code;
    /** @type {string} */
    document_json;
}

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

{
	uuid: String,
	authorizing_uuid: String,
	section_uuid: String,
	reporting_term: String,
	document_code: String,
	document_json: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}