regis

<back to all web services

SectionTARequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Sections/TA/{uuid}

export class PersonSimpleResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public ubc_id?: number;
    public uuid: string;
    public regent_login: string;
    public first_name: string;
    public preferred_name: string;
    public middle_name: string;
    public last_name: string;
    public email: string;
    public phone_home: string;
    public phone_cell: string;
    public phone_bus: string;
    public addr1: string;
    public addr2: string;
    public city: string;
    public state: string;
    public country: string;
    public code: string;
    public citizenship: string;
    public citizenship_other: string;
    public permanent_resident: string;
    public dob?: string;
    public is_student: boolean;
    public is_faculty: boolean;
    public is_vendor: boolean;

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

export class SectionTAResponse
{
    public uuid: string;
    public course_name: string;
    public title: string;
    public term: string;
    public reporting_term: string;
    public taList: PersonSimpleResponse[];

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

export class SectionTARequest
{
    public uuid: string;

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

TypeScript SectionTARequest 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 /Sections/TA/{uuid} 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

{
	uuid: String,
	course_name: String,
	title: String,
	term: String,
	reporting_term: String,
	taList: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			regent_id: 0,
			ubc_id: 0,
			uuid: String,
			regent_login: String,
			first_name: String,
			preferred_name: String,
			middle_name: String,
			last_name: String,
			email: String,
			phone_home: String,
			phone_cell: String,
			phone_bus: String,
			addr1: String,
			addr2: String,
			city: String,
			state: String,
			country: String,
			code: String,
			citizenship: String,
			citizenship_other: String,
			permanent_resident: String,
			dob: 0001-01-01,
			is_student: False,
			is_faculty: False,
			is_vendor: False
		}
	]
}