regis

<back to all web services

PersonRestrictionsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Person/{uuid}/Restrictions
import java.math.*
import java.util.*
import net.servicestack.client.*


open class PersonRestrictionsRequest
{
    var uuid:String? = null
}

open class PersonRestrictionsResponse
{
    var responseStatus:ResponseStatus? = null
    var regent_id:Int? = null
    var uuid:String? = null
    var restrictions:ArrayList<PersonRestrictionResponse> = ArrayList<PersonRestrictionResponse>()
    var valid_restrictions:ArrayList<RestrictionResponse> = ArrayList<RestrictionResponse>()
}

open class PersonRestrictionResponse
{
    var id:Int? = null
    var restriction_code:String? = null
    var restriction_description:String? = null
    var start_date:Date? = null
    var end_date:Date? = null
}

open class RestrictionResponse
{
    var id:Int? = null
    var restriction_code:String? = null
    var restriction_description:String? = null
    var is_active:Boolean? = null
}

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