tvpl.api

<back to all web services

SearchDocumentPolicyRequest

Requires Authentication
The following routes are available for this service:
GET/DocumentPolicy
DocumentPolicyFilter Parameters:
NameParameterData TypeRequiredDescription
DepartmentIdformint?No
NameformstringNo
IsApprovedformbool?No
PagingRequest Parameters:
NameParameterData TypeRequiredDescription
PageformintNo
LimitformintNo
DocumentPolicyResponse Parameters:
NameParameterData TypeRequiredDescription
CodeformintNo
MessageformstringYes
DocumentPolicyformList<DocumentPolicy>No
UnapprovedCountformintNo
TotalCountformintNo
DocumentPolicy Parameters:
NameParameterData TypeRequiredDescription
ApprovedDateformDateTime?No
EstimatedDeadlineformDateTime?No
IsApprovedformboolNo
CreatedByformintYes
CreatedDateformDateTimeNo
DeletedAtformDateTime?No
DeletedByformint?No
ApprovalCommentformstringNo
IsDeletedformbool?No
LastUpdateAtformDateTime?No
UpdatedByformintNo
UpdateDocumentPolicyModel Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
PolicyCodeformstringYes
TitleformstringYes
DocumentLinkformstringNo
DocumentGroupIdformintNo
DescriptionformstringNo
ApprovedByformint?No
DepartmentLeadIdformintYes
DepartmentCoIdformint?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 /DocumentPolicy HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentPolicyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <DocumentPolicy xmlns:d2p1="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:DocumentPolicy>
      <d2p1:ApprovedBy>0</d2p1:ApprovedBy>
      <d2p1:DepartmentCoId>0</d2p1:DepartmentCoId>
      <d2p1:DepartmentLeadId>0</d2p1:DepartmentLeadId>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:DocumentGroupId>0</d2p1:DocumentGroupId>
      <d2p1:DocumentLink>String</d2p1:DocumentLink>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:PolicyCode>String</d2p1:PolicyCode>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:ApprovalComment>String</d2p1:ApprovalComment>
      <d2p1:ApprovedDate>0001-01-01T00:00:00</d2p1:ApprovedDate>
      <d2p1:CreatedBy>0</d2p1:CreatedBy>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
      <d2p1:DeletedBy>0</d2p1:DeletedBy>
      <d2p1:EstimatedDeadline>0001-01-01T00:00:00</d2p1:EstimatedDeadline>
      <d2p1:IsApproved>false</d2p1:IsApproved>
      <d2p1:IsDeleted>false</d2p1:IsDeleted>
      <d2p1:LastUpdateAt>0001-01-01T00:00:00</d2p1:LastUpdateAt>
      <d2p1:UpdatedBy>0</d2p1:UpdatedBy>
    </d2p1:DocumentPolicy>
  </DocumentPolicy>
  <Message>String</Message>
  <TotalCount>0</TotalCount>
  <UnapprovedCount>0</UnapprovedCount>
</DocumentPolicyResponse>