regis

<back to all web services

CanIRegisterRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/CanIRegister/{uuid}/Term/{reporting_term}

export class CanIRegisterResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public uuid: string;
    public reporting_term: string;
    public maxCredits: number;
    public maxAudits: number;
    public messages: string[];

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

export class CanIRegisterRequest
{
    public uuid: string;
    public term: string;
    public reporting_term: string;

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

TypeScript CanIRegisterRequest 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/CanIRegister/{uuid}/Term/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String","term":"String","reporting_term":"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"}},"regent_id":0,"uuid":"String","reporting_term":"String","maxCredits":0,"maxAudits":0,"messages":["String"]}