regis

<back to all web services

PersonKeysRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/person/keys/all

export class PersonKeyResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public re_id: number;
    public sugar_id: string;
    public uuid: string;
    public student_id?: number;
    public regent_login: string;

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

export class PersonKeysResponse
{
    public responseStatus: ResponseStatus;
    public personKeyResponses: PersonKeyResponse[];

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

export class PersonKeysRequest
{

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

TypeScript PersonKeysRequest 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/keys/all HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}
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
		}
	},
	personKeyResponses: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			regent_id: 0,
			re_id: 0,
			sugar_id: String,
			uuid: String,
			student_id: 0,
			regent_login: String
		}
	]
}