tvpl.api

<back to all web services

SearchDocumentReferenceRequest

Requires Authentication
Required role:super-admin
The following routes are available for this service:
GET/document-reference/search

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

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

export class SearchDocumentReferenceRequest extends PagingRequest
{
    public documentCode: string;
    public parentDocumentId?: number;
    public title: string;

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

export class MongoObject implements IMongoModel
{
    public id: string;

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

export class AuditLog extends MongoObject implements IEntityId, ICreated, IUpdate
{
    public userName?: string;
    public userId?: number;
    public documentId: number;
    public action: string;
    public description: string;
    public createdDate: string;
    public updatedDate: string;
    public ipAddress?: string;
    public userAgent?: string;

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

export class Pagination
{
    public total: number;
    public pages: number;
    public offset: number;
    public limit: number;
    public currentPage: number;

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

export class PageResponse<AuditLog> implements IResponseRequest
{
    public code: number;
    public message: string;
    public data: AuditLog[];
    public pagination: Pagination;

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

TypeScript SearchDocumentReferenceRequest 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.

GET /document-reference/search HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"code":0,"message":"String","data":[{"id":0,"parentDocumentId":0,"title":"String","documentCode":"String","referenceUrl":"String","description":"String"}],"pagination":null}