tvpl.api

<back to all web services

SearchTemplateRequest

Requires Authentication
The following routes are available for this service:
GET/document-template/search
SearchTemplateRequest Parameters:
NameParameterData TypeRequiredDescription
TitlequerystringNo
PagingRequest Parameters:
NameParameterData TypeRequiredDescription
PageformintNo
LimitformintNo
SearchDocumentTemplateResponse Parameters:
NameParameterData TypeRequiredDescription
CodeformintNo
MessageformstringYes
DataformList<DocumentTemplate>No
TotalCountformlongNo
DocumentTemplate Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TitleformstringYes
DescriptionformstringNo
IsActiveformboolNo
DocumentIdsformList<int>No
DocumentsformList<Document>No
Document Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ReasonReturnformstringNo
AccountIdformint?No
DeletedAtformDateTime?No
DeletedByformstringNo
UpdatedByformstringNo
CreatedAtformDateTime?No
CreatedByformstringNo
IsPartyformbool?No
IsRevisionRequestedformboolNo
LastUpdatedAtformDateTime?No
IsPrivateformbool?No
DepartmentIdformint?No
PublicationDateformDateTime?No
ProcessStatusIdformint?No
FullTextSearchContentformstringNo
BasicDocument Parameters:
NameParameterData TypeRequiredDescription
TitleformstringYes
DescriptionformstringYes
OwnerformstringNo
DocumentPolicyIdformint?No
UpdateDocumentIdformint?No
EffectBeginDateformDateTime?No
EffectEndDateformDateTime?No
IssuingAgencyIdformint?No
DocumentTypeIdformint?No
DocumentGroupIdformint?No
SubjectIdformint?No
SignByformstringNo
SignDateformDateTime?No
StatusIdformint?No
IsInternalformboolNo
DocumentNumberformstringNo
DocumentCodeformstringNo
IsUrgentformbool?No
ScopeTypeformint?No
IsActiveformbool?No

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>