regis

PersonRestrictionsRequest

**Requires Authentication**
Required role:	REGISUserRole

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


export class PersonRestrictionResponse
{
    public id: number;
    public restriction_code: string;
    public restriction_description: string;
    public start_date?: string;
    public end_date?: string;

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

export class RestrictionResponse
{
    public id: number;
    public restriction_code: string;
    public restriction_description: string;
    public is_active: boolean;

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

export class PersonRestrictionsResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public uuid: string;
    public restrictions: PersonRestrictionResponse[];
    public valid_restrictions: RestrictionResponse[];

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

export class PersonRestrictionsRequest
{
    public uuid: string;

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

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