regis

<back to all web services

ProvisionalRegistrationsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/Provisional

export class RegistrationDocumentResponse
{
    public uuid: string;
    public regent_id: number;
    public first_name: string;
    public last_name: string;
    public gender: string;
    public email: string;
    public program: string;
    public concentration: string;
    public section_uuid: string;
    public course_name: string;
    public course_title: string;
    public reporting_term: string;
    public document_code: string;
    public document_json: string;
    public document_name: string;
    public document_description: string;
    public added_date?: string;
    public changed_date?: string;

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

export class ProvisionalRegistrationResponse
{
    public uuid: string;
    public regent_id?: number;
    public student_name: string;
    public email: string;
    public section_uuid: string;
    public student_section_uuid: string;
    public course_name: string;
    public section_code: string;
    public title: string;
    public term: string;
    public amount: number;
    public is_audit: boolean;
    public is_waitlist: boolean;
    public is_missing_requisites: boolean;
    public is_other_restriction: boolean;
    public documents: RegistrationDocumentResponse[];
    public requested_date: string;

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

export class ProvisionalRegistrationsResponse
{
    public responseStatus: ResponseStatus;
    public provisional_registrations: ProvisionalRegistrationResponse[];

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

export class ProvisionalRegistrationsRequest
{
    public reporting_term: string;
    public authorizing_uuid: string;

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

TypeScript ProvisionalRegistrationsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Registration/Provisional HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"reporting_term":"String","authorizing_uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"provisional_registrations":[{"uuid":"String","regent_id":0,"student_name":"String","email":"String","section_uuid":"String","student_section_uuid":"String","course_name":"String","section_code":"String","title":"String","term":"String","amount":0,"is_audit":false,"is_waitlist":false,"is_missing_requisites":false,"is_other_restriction":false,"documents":[{"uuid":"String","regent_id":0,"first_name":"String","last_name":"String","gender":"String","email":"String","program":"String","concentration":"String","section_uuid":"String","course_name":"String","course_title":"String","reporting_term":"String","document_code":"String","document_json":"String","document_name":"String","document_description":"String","added_date":"0001-01-01T00:00:00.0000000","changed_date":"0001-01-01T00:00:00.0000000"}],"requested_date":"0001-01-01T00:00:00.0000000"}]}