tvpl.api

PendingAccessRequests

The following routes are available for this service:
GET	/document-permission/Pending-Access-Requests


export class PagingRequest
{
    public page: number;
    public limit: number;

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

export enum DocumentAccessPermissions
{
    Read = 'Read',
    Write = 'Write',
    GrantRead = 'GrantRead',
}

export enum DocumentApprovalStatus
{
    Pending = 'Pending',
    Approved = 'Approved',
    Rejected = 'Rejected',
}

export class DocumentAccessRequest
{
    public id: number;
    public documentId: number;
    public requestedBy: number;
    public requestPermission: DocumentAccessPermissions;
    public status: DocumentApprovalStatus;
    public createdDate: string;
    public approvedBy?: number;
    public approvedDate?: string;
    public note?: string;
    public comment?: string;
    public dueDate?: string;

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

export class DocumentAccessRequestView extends DocumentAccessRequest
{
    public approvedByName?: string;
    public requestedName?: string;
    public documentTitle: string;

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

export class PendingAccessResponse
{
    public total: number;
    public code: number;
    public message: string;
    public requests: DocumentAccessRequestView[];

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

export class PendingAccessRequests extends PagingRequest
{
    public status?: DocumentApprovalStatus;

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

TypeScript PendingAccessRequests DTOs

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

HTTP + XML

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

GET /document-permission/Pending-Access-Requests HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PendingAccessResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <Message>String</Message>
  <Requests xmlns:d2p1="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:DocumentAccessRequestView>
      <d2p1:ApprovedBy>0</d2p1:ApprovedBy>
      <d2p1:ApprovedDate>0001-01-01T00:00:00</d2p1:ApprovedDate>
      <d2p1:Comment>String</d2p1:Comment>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:DocumentId>0</d2p1:DocumentId>
      <d2p1:DueDate>0001-01-01T00:00:00</d2p1:DueDate>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Note>String</d2p1:Note>
      <d2p1:RequestPermission>Read</d2p1:RequestPermission>
      <d2p1:RequestedBy>0</d2p1:RequestedBy>
      <d2p1:Status>Pending</d2p1:Status>
      <d2p1:ApprovedByName>String</d2p1:ApprovedByName>
      <d2p1:DocumentTitle>String</d2p1:DocumentTitle>
      <d2p1:RequestedName>String</d2p1:RequestedName>
    </d2p1:DocumentAccessRequestView>
  </Requests>
  <Total>0</Total>
</PendingAccessResponse>