regis

<back to all web services

PersonAuthRequest

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

public class dtos
{

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

    public static class PersonAuthResponse
    {
        public ResponseStatus responseStatus = null;
        public Integer regent_id = null;
        public String uuid = null;
        public String first_name = null;
        public String last_name = null;
        public String preferred_name = null;
        public ArrayList<String> roles = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public PersonAuthResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public PersonAuthResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getUuid() { return uuid; }
        public PersonAuthResponse setUuid(String value) { this.uuid = value; return this; }
        public String getFirstName() { return first_name; }
        public PersonAuthResponse setFirstName(String value) { this.first_name = value; return this; }
        public String getLastName() { return last_name; }
        public PersonAuthResponse setLastName(String value) { this.last_name = value; return this; }
        public String getPreferredName() { return preferred_name; }
        public PersonAuthResponse setPreferredName(String value) { this.preferred_name = value; return this; }
        public ArrayList<String> getRoles() { return roles; }
        public PersonAuthResponse setRoles(ArrayList<String> value) { this.roles = value; return this; }
    }

}

Java PersonAuthRequest 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}/auth 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,
	first_name: String,
	last_name: String,
	preferred_name: String,
	roles: 
	[
		String
	]
}