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.*;

public class dtos
{

    public static class PersonRestrictionsRequest
    {
        public String uuid = null;
        
        public String getUuid() { return uuid; }
        public PersonRestrictionsRequest setUuid(String value) { this.uuid = value; return this; }
    }

    public static class PersonRestrictionsResponse
    {
        public ResponseStatus responseStatus = null;
        public Integer regent_id = null;
        public String uuid = null;
        public ArrayList<PersonRestrictionResponse> restrictions = null;
        public ArrayList<RestrictionResponse> valid_restrictions = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public PersonRestrictionsResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public PersonRestrictionsResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getUuid() { return uuid; }
        public PersonRestrictionsResponse setUuid(String value) { this.uuid = value; return this; }
        public ArrayList<PersonRestrictionResponse> getRestrictions() { return restrictions; }
        public PersonRestrictionsResponse setRestrictions(ArrayList<PersonRestrictionResponse> value) { this.restrictions = value; return this; }
        public ArrayList<RestrictionResponse> getValidRestrictions() { return valid_restrictions; }
        public PersonRestrictionsResponse setValidRestrictions(ArrayList<RestrictionResponse> value) { this.valid_restrictions = value; return this; }
    }

    public static class PersonRestrictionResponse
    {
        public Integer id = null;
        public String restriction_code = null;
        public String restriction_description = null;
        public Date start_date = null;
        public Date end_date = null;
        
        public Integer getId() { return id; }
        public PersonRestrictionResponse setId(Integer value) { this.id = value; return this; }
        public String getRestrictionCode() { return restriction_code; }
        public PersonRestrictionResponse setRestrictionCode(String value) { this.restriction_code = value; return this; }
        public String getRestrictionDescription() { return restriction_description; }
        public PersonRestrictionResponse setRestrictionDescription(String value) { this.restriction_description = value; return this; }
        public Date getStartDate() { return start_date; }
        public PersonRestrictionResponse setStartDate(Date value) { this.start_date = value; return this; }
        public Date getEndDate() { return end_date; }
        public PersonRestrictionResponse setEndDate(Date value) { this.end_date = value; return this; }
    }

    public static class RestrictionResponse
    {
        public Integer id = null;
        public String restriction_code = null;
        public String restriction_description = null;
        public Boolean is_active = null;
        
        public Integer getId() { return id; }
        public RestrictionResponse setId(Integer value) { this.id = value; return this; }
        public String getRestrictionCode() { return restriction_code; }
        public RestrictionResponse setRestrictionCode(String value) { this.restriction_code = value; return this; }
        public String getRestrictionDescription() { return restriction_description; }
        public RestrictionResponse setRestrictionDescription(String value) { this.restriction_description = value; return this; }
        public Boolean getIsActive() { return is_active; }
        public RestrictionResponse setIsActive(Boolean value) { this.is_active = value; return this; }
    }

}

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