regis

<back to all web services

SectionDocumentsRequest

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

export class DocumentResponse
{
    public code: string;
    public document_name: string;
    public document_description: string;

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

export class SectionDocumentsResponse
{
    public uuid: string;
    public course_name: string;
    public title: string;
    public term: string;
    public reporting_term: string;
    public assigned_documents: DocumentResponse[];
    public available_documents: DocumentResponse[];

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

export class SectionDocumentsRequest
{
    public uuid: string;

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

TypeScript SectionDocumentsRequest DTOs

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

HTTP + OTHER

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

POST /Sections/{uuid}/Documents HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"uuid":"String","course_name":"String","title":"String","term":"String","reporting_term":"String","assigned_documents":[{"code":"String","document_name":"String","document_description":"String"}],"available_documents":[{"code":"String","document_name":"String","document_description":"String"}]}