regis

PersonRestrictionsRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Person/{uuid}/Restrictions

"use strict";
export class PersonRestrictionResponse {
    /** @param {{id?:number,restriction_code?:string,restriction_description?:string,start_date?:string,end_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    restriction_code;
    /** @type {string} */
    restriction_description;
    /** @type {?string} */
    start_date;
    /** @type {?string} */
    end_date;
}
export class RestrictionResponse {
    /** @param {{id?:number,restriction_code?:string,restriction_description?:string,is_active?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    restriction_code;
    /** @type {string} */
    restriction_description;
    /** @type {boolean} */
    is_active;
}
export class PersonRestrictionsResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,restrictions?:PersonRestrictionResponse[],valid_restrictions?:RestrictionResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {PersonRestrictionResponse[]} */
    restrictions;
    /** @type {RestrictionResponse[]} */
    valid_restrictions;
}
export class PersonRestrictionsRequest {
    /** @param {{uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
}

JavaScript PersonRestrictionsRequest 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 /Person/{uuid}/Restrictions HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String
}

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
		}
	},
	regent_id: 0,
	uuid: String,
	restrictions: 
	[
		{
			id: 0,
			restriction_code: String,
			restriction_description: String,
			start_date: 0001-01-01,
			end_date: 0001-01-01
		}
	],
	valid_restrictions: 
	[
		{
			id: 0,
			restriction_code: String,
			restriction_description: String,
			is_active: False
		}
	]
}