tvpl.api

SearchTemplateRequest

The following routes are available for this service:
GET	/document-template/search


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

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

export class BasicDocument
{
    // @Required()
    public title: string;

    // @StringLength(4000)
    public description: string;

    // @StringLength(500)
    public owner?: string;

    public documentPolicyId?: number;
    public updateDocumentId?: number;
    public effectBeginDate?: string;
    public effectEndDate?: string;
    public issuingAgencyId?: number;
    public documentTypeId?: number;
    public documentGroupId?: number;
    public subjectId?: number;
    // @StringLength(500)
    public signBy?: string;

    public signDate?: string;
    public statusId?: number;
    public isInternal: boolean;
    public documentNumber?: string;
    public documentCode?: string;
    public isUrgent?: boolean;
    public scopeType?: number;
    public isActive?: boolean;

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

export class Document extends BasicDocument
{
    public id: number;
    // @StringLength(500)
    public reasonReturn?: string;

    public accountId?: number;
    public deletedAt?: string;
    // @StringLength(500)
    public deletedBy?: string;

    // @StringLength(500)
    public updatedBy?: string;

    public createdAt?: string;
    // @StringLength(500)
    public createdBy?: string;

    public isParty?: boolean;
    public isRevisionRequested: boolean;
    public lastUpdatedAt?: string;
    public isPrivate?: boolean;
    public departmentId?: number;
    public publicationDate?: string;
    public processStatusId?: number;
    public fullTextSearchContent?: string;

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

export class DocumentTemplate
{
    public id: number;
    // @Required()
    public title: string;

    public description?: string;
    public isActive: boolean;
    // @Ignore()
    public documentIds?: number[];

    // @Ignore()
    public documents?: Document[];

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

export class SearchDocumentTemplateResponse implements IResponseRequest
{
    public code: number;
    public message: string;
    public data?: DocumentTemplate[];
    public totalCount: number;

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

export class SearchTemplateRequest extends PagingRequest
{
    public title?: string;

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

TypeScript SearchTemplateRequest 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-template/search HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml

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

<SearchDocumentTemplateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:DocumentTemplate>
      <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
      <d2p1:CreatedBy>0</d2p1:CreatedBy>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:DocumentIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d2p1:DocumentIds>
      <d2p1:Documents>
        <d2p1:Document>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:DocumentCode>String</d2p1:DocumentCode>
          <d2p1:DocumentGroupId>0</d2p1:DocumentGroupId>
          <d2p1:DocumentNumber>String</d2p1:DocumentNumber>
          <d2p1:DocumentPolicyId>0</d2p1:DocumentPolicyId>
          <d2p1:DocumentTypeId>0</d2p1:DocumentTypeId>
          <d2p1:EffectBeginDate>0001-01-01T00:00:00</d2p1:EffectBeginDate>
          <d2p1:EffectEndDate>0001-01-01T00:00:00</d2p1:EffectEndDate>
          <d2p1:IsActive>false</d2p1:IsActive>
          <d2p1:IsInternal>false</d2p1:IsInternal>
          <d2p1:IsUrgent>false</d2p1:IsUrgent>
          <d2p1:IssuingAgencyId>0</d2p1:IssuingAgencyId>
          <d2p1:Owner>String</d2p1:Owner>
          <d2p1:ScopeType>0</d2p1:ScopeType>
          <d2p1:SignBy>String</d2p1:SignBy>
          <d2p1:SignDate>0001-01-01T00:00:00</d2p1:SignDate>
          <d2p1:StatusId>0</d2p1:StatusId>
          <d2p1:SubjectId>0</d2p1:SubjectId>
          <d2p1:Title>String</d2p1:Title>
          <d2p1:UpdateDocumentId>0</d2p1:UpdateDocumentId>
          <d2p1:AccountId>0</d2p1:AccountId>
          <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
          <d2p1:CreatedBy>String</d2p1:CreatedBy>
          <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
          <d2p1:DeletedBy>String</d2p1:DeletedBy>
          <d2p1:DepartmentId>0</d2p1:DepartmentId>
          <d2p1:FullTextSearchContent>String</d2p1:FullTextSearchContent>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:IsParty>false</d2p1:IsParty>
          <d2p1:IsPrivate>false</d2p1:IsPrivate>
          <d2p1:IsRevisionRequested>false</d2p1:IsRevisionRequested>
          <d2p1:LastUpdatedAt>0001-01-01T00:00:00</d2p1:LastUpdatedAt>
          <d2p1:ProcessStatusId>0</d2p1:ProcessStatusId>
          <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
          <d2p1:ReasonReturn>String</d2p1:ReasonReturn>
          <d2p1:UpdatedBy>String</d2p1:UpdatedBy>
        </d2p1:Document>
      </d2p1:Documents>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsActive>false</d2p1:IsActive>
      <d2p1:Title>String</d2p1:Title>
    </d2p1:DocumentTemplate>
  </Data>
  <Message>String</Message>
  <TotalCount>0</TotalCount>
</SearchDocumentTemplateResponse>