tvpl.api

GetTemplateByIdRequest

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


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 DocumentElement
{
    public id: number;
    public templateId: number;
    // @Required()
    public elementKey: string;

    // @Required()
    public tag: string;

    public parentId?: number;
    // @Required()
    public title: string;

    public description?: string;
    // @Required()
    public dataType: string;

    public templateType?: string;
    public orderIndex: number;
    public isRequired?: boolean;

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

export class DocumentElementDto extends DocumentElement
{
    public children: DocumentElementDto[];

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

export class DocumentTemplateDto extends DocumentTemplate
{
    public elements?: DocumentElementDto[];

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

export class DocumentTemplateResponse
{
    public template?: DocumentTemplateDto;
    public insertedId: number;
    public code: number;
    public message?: string;

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

export class GetTemplateByIdRequest
{
    public id: number;

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

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

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

<DocumentTemplateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <InsertedId>0</InsertedId>
  <Message>String</Message>
  <Template>
    <CreatedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</CreatedAt>
    <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</CreatedBy>
    <Description xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Description>
    <DocumentIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
      <d3p1:int>0</d3p1:int>
    </DocumentIds>
    <Documents xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
      <Document>
        <Description>String</Description>
        <DocumentCode>String</DocumentCode>
        <DocumentGroupId>0</DocumentGroupId>
        <DocumentNumber>String</DocumentNumber>
        <DocumentPolicyId>0</DocumentPolicyId>
        <DocumentTypeId>0</DocumentTypeId>
        <EffectBeginDate>0001-01-01T00:00:00</EffectBeginDate>
        <EffectEndDate>0001-01-01T00:00:00</EffectEndDate>
        <IsActive>false</IsActive>
        <IsInternal>false</IsInternal>
        <IsUrgent>false</IsUrgent>
        <IssuingAgencyId>0</IssuingAgencyId>
        <Owner>String</Owner>
        <ScopeType>0</ScopeType>
        <SignBy>String</SignBy>
        <SignDate>0001-01-01T00:00:00</SignDate>
        <StatusId>0</StatusId>
        <SubjectId>0</SubjectId>
        <Title>String</Title>
        <UpdateDocumentId>0</UpdateDocumentId>
        <AccountId>0</AccountId>
        <CreatedAt>0001-01-01T00:00:00</CreatedAt>
        <CreatedBy>String</CreatedBy>
        <DeletedAt>0001-01-01T00:00:00</DeletedAt>
        <DeletedBy>String</DeletedBy>
        <DepartmentId>0</DepartmentId>
        <FullTextSearchContent>String</FullTextSearchContent>
        <Id>0</Id>
        <IsParty>false</IsParty>
        <IsPrivate>false</IsPrivate>
        <IsRevisionRequested>false</IsRevisionRequested>
        <LastUpdatedAt>0001-01-01T00:00:00</LastUpdatedAt>
        <ProcessStatusId>0</ProcessStatusId>
        <PublicationDate>0001-01-01T00:00:00</PublicationDate>
        <ReasonReturn>String</ReasonReturn>
        <UpdatedBy>String</UpdatedBy>
      </Document>
    </Documents>
    <Id xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</Id>
    <IsActive xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsActive>
    <Title xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Title>
    <Elements>
      <DocumentElementDto>
        <CreatedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</CreatedAt>
        <DataType xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</DataType>
        <Description xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Description>
        <ElementKey xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</ElementKey>
        <Id xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</Id>
        <IsRequired xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsRequired>
        <OrderIndex xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</OrderIndex>
        <ParentId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</ParentId>
        <Tag xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Tag>
        <TemplateId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</TemplateId>
        <TemplateType xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</TemplateType>
        <Title xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Title>
        <Children>
          <DocumentElementDto>
            <CreatedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</CreatedAt>
            <DataType xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</DataType>
            <Description xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Description>
            <ElementKey xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</ElementKey>
            <Id xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</Id>
            <IsRequired xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsRequired>
            <OrderIndex xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</OrderIndex>
            <ParentId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</ParentId>
            <Tag xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Tag>
            <TemplateId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</TemplateId>
            <TemplateType xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</TemplateType>
            <Title xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Title>
            <Children>
              <DocumentElementDto>
                <CreatedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</CreatedAt>
                <DataType xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</DataType>
                <Description xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Description>
                <ElementKey xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</ElementKey>
                <Id xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</Id>
                <IsRequired xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsRequired>
                <OrderIndex xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</OrderIndex>
                <ParentId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</ParentId>
                <Tag xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Tag>
                <TemplateId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</TemplateId>
                <TemplateType xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</TemplateType>
                <Title xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Title>
                <Children i:nil="true" />
              </DocumentElementDto>
            </Children>
          </DocumentElementDto>
        </Children>
      </DocumentElementDto>
    </Elements>
  </Template>
</DocumentTemplateResponse>