tvpl.api

DocumentDetailRequest

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

**DocumentDetailRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Id	query	int	No

**DocumentDetailResponse** Parameters:
Name	Parameter	Data Type	Required
Data	form	DocumentDetail	Yes
Code	form	int	No
Message	form	string	Yes

**DocumentDetail** Parameters:
Name	Parameter	Data Type	Required
PartUploadedFile	form	UploadedFileAttach	No
CompactUploadedFile	form	UploadedFileAttach	No
AnalysisUploadedFile	form	UploadedFileAttach	No
FullUploadedFile	form	UploadedFileAttach	No
CreatedAt	form	DateTime	No
NextApprover	form	ApproversProfile	No
CurrentApprover	form	CurrentApprover	No
AttachFiles	form	List<UploadedFileAttach>	No
HasReadPermission	form	bool	No
CanGrantReadPermission	form	bool	No
BasisDocument	form	List<SimpleDocumentRelation>	No
BasisForDocument	form	List<SimpleDocumentRelation>	No
MainDocument	form	SimpleDocumentRelation	No
ReferenceDocument	form	List<SimpleDocumentRelation>	No
ReferencedByDocument	form	List<SimpleDocumentRelation>	No
ReplacedDocument	form	List<SimpleDocumentRelation>	No
ReplacedByDocument	form	List<SimpleDocumentRelation>	No
ExpiredDocument	form	List<SimpleDocumentRelation>	No
ExpiredByDocument	form	List<SimpleDocumentRelation>	No
UpdateForDocument	form	SimpleDocumentRelation	No
ScopeType	form	int?	No
StepOrder	form	int	No

**DocumentSearchResultItem** Parameters:
Name	Parameter	Data Type	Required
Title	form	string	No
Description	form	string	Yes
Owner	form	string	No
DocumentPolicyId	form	int?	No
UpdateDocumentId	form	int?	No
EffectBeginDate	form	DateTime?	No
EffectEndDate	form	DateTime?	No
IssuingAgencyId	form	int?	No
SubjectId	form	int?	No
SignBy	form	string	No
SignDate	form	DateTime?	No
UpdatedAt	form	DateTime?	No
StatusId	form	int?	No
IsInternal	form	bool	No
DocumentNumber	form	string	No
DocumentCode	form	string	No
IsUrgent	form	bool?	No
Id	form	int	No
ReasonReturn	form	string	No
AccountId	form	int?	No
ApproverId	form	int?	No
UpdatedBy	form	string	No
CreatedBy	form	string	No
IsParty	form	bool?	No
IsRevisionRequested	form	bool?	No
IsPrivate	form	bool?	No
DepartmentId	form	int?	No
PublicationDate	form	DateTime?	No
ProcessStatusId	form	int	No
DocumentTypeId	form	int?	No
DocumentGroupId	form	int?	No
AccountName	form	string	No
AcceptAccountName	form	string	No
DocumentGroupText	form	string	No
ProcessStatusText	form	string	No
DocumentTypeText	form	string	No
DepartmentText	form	string	No
StatusText	form	string	No
IssuingAgencyText	form	string	No
SubjectText	form	string	No
Comment	form	string	No
SubmitComment	form	string	No
FullFile	form	string	No
ParthFile	form	string	No
IsActive	form	bool?	No
StepOrder	form	int?	No
StepCount	form	int?	No

**UploadedFileAttach** Parameters:
Name	Parameter	Data Type	Required
FileType	form	string	Yes
SubDocumentId	form	int?	No
StepId	form	int?	No

**UploadedFileModel** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
AccessType	form	AccessType	No
CreatedBy	form	int	No
CreatedDate	form	DateTime	No

**BasicUploadedFile** Parameters:
Name	Parameter	Data Type	Required
FileName	form	string	Yes
Filekey	form	string	Yes
FileUrl	form	string	Yes
Checksum	form	string	Yes
ETag	form	string	Yes
FileSize	form	long	No

**AccessType** Enum:
Public
Restricted

**ApproversProfile** Parameters:
Name	Parameter	Data Type	Required
UserProfiles	form	List<UserProfile>	No
ProcessStatusId	form	int	No
ProcessTitle	form	string	Yes
ActionButtonLabel	form	string	No
ProcessDescription	form	string	Yes
IsApprovalRequired	form	bool	No
IsFinalStep	form	bool	No
StepOrder	form	int	No

**UserProfile** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
FullName	form	string	No
Email	form	string	No
DepartmentId	form	int?	No
PartyGroupId	form	int?	No
Avatar	form	string	No
Telephone	form	string	No
Birthday	form	DateTime?	No
CreatedAt	form	DateTime?	No
UpdatedAt	form	DateTime?	No
FailedLoginCount	form	int	No
Roles	form	List<int>	Yes
LastLoginDate	form	DateTime?	No

**UserLogin** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	Yes

**CurrentApprover** Parameters:
Name	Parameter	Data Type	Required
ApproverId	form	int?	No
Status	form	string	No
ProcessStatusId	form	int	No
ProcessTitle	form	string	Yes
ActionButtonLabel	form	string	No
ProcessDescription	form	string	Yes
IsApprovalRequired	form	bool	No
IsFinalStep	form	bool	No
StepOrder	form	int	No

**SimpleDocumentRelation** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Title	form	string	Yes
DocumentCode	form	string	Yes
PublicationDate	form	DateTime?	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/detail HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml

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

<DocumentDetailResponse 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:AcceptAccountName>String</d2p1:AcceptAccountName>
    <d2p1:AccountId>0</d2p1:AccountId>
    <d2p1:AccountName>String</d2p1:AccountName>
    <d2p1:ApproverId>0</d2p1:ApproverId>
    <d2p1:Comment>String</d2p1:Comment>
    <d2p1:CreatedBy>String</d2p1:CreatedBy>
    <d2p1:DepartmentId>0</d2p1:DepartmentId>
    <d2p1:DepartmentText>String</d2p1:DepartmentText>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:DocumentCode>String</d2p1:DocumentCode>
    <d2p1:DocumentGroupId>0</d2p1:DocumentGroupId>
    <d2p1:DocumentGroupText>String</d2p1:DocumentGroupText>
    <d2p1:DocumentNumber>String</d2p1:DocumentNumber>
    <d2p1:DocumentPolicyId>0</d2p1:DocumentPolicyId>
    <d2p1:DocumentTypeId>0</d2p1:DocumentTypeId>
    <d2p1:DocumentTypeText>String</d2p1:DocumentTypeText>
    <d2p1:EffectBeginDate>0001-01-01T00:00:00</d2p1:EffectBeginDate>
    <d2p1:EffectEndDate>0001-01-01T00:00:00</d2p1:EffectEndDate>
    <d2p1:FullFile>String</d2p1:FullFile>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:IsActive>false</d2p1:IsActive>
    <d2p1:IsInternal>false</d2p1:IsInternal>
    <d2p1:IsParty>false</d2p1:IsParty>
    <d2p1:IsPrivate>false</d2p1:IsPrivate>
    <d2p1:IsRevisionRequested>false</d2p1:IsRevisionRequested>
    <d2p1:IsUrgent>false</d2p1:IsUrgent>
    <d2p1:IssuingAgencyId>0</d2p1:IssuingAgencyId>
    <d2p1:IssuingAgencyText>String</d2p1:IssuingAgencyText>
    <d2p1:Owner>String</d2p1:Owner>
    <d2p1:ParthFile>String</d2p1:ParthFile>
    <d2p1:ProcessStatusId>0</d2p1:ProcessStatusId>
    <d2p1:ProcessStatusText>String</d2p1:ProcessStatusText>
    <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
    <d2p1:ReasonReturn>String</d2p1:ReasonReturn>
    <d2p1:SignBy>String</d2p1:SignBy>
    <d2p1:SignDate>0001-01-01T00:00:00</d2p1:SignDate>
    <d2p1:StatusId>0</d2p1:StatusId>
    <d2p1:StatusText>String</d2p1:StatusText>
    <d2p1:StepCount>0</d2p1:StepCount>
    <d2p1:StepOrder>0</d2p1:StepOrder>
    <d2p1:SubjectId>0</d2p1:SubjectId>
    <d2p1:SubjectText>String</d2p1:SubjectText>
    <d2p1:SubmitComment>String</d2p1:SubmitComment>
    <d2p1:Title>String</d2p1:Title>
    <d2p1:UpdateDocumentId>0</d2p1:UpdateDocumentId>
    <d2p1:UpdatedAt>0001-01-01T00:00:00</d2p1:UpdatedAt>
    <d2p1:UpdatedBy>String</d2p1:UpdatedBy>
    <d2p1:AnalysisUploadedFile>
      <d2p1:Checksum>String</d2p1:Checksum>
      <d2p1:ETag>String</d2p1:ETag>
      <d2p1:FileName>String</d2p1:FileName>
      <d2p1:FileSize>0</d2p1:FileSize>
      <d2p1:FileUrl>String</d2p1:FileUrl>
      <d2p1:Filekey>String</d2p1:Filekey>
      <d2p1:AccessType>Public</d2p1:AccessType>
      <d2p1:CreatedBy>0</d2p1:CreatedBy>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:FileType>String</d2p1:FileType>
      <d2p1:StepId>0</d2p1:StepId>
      <d2p1:SubDocumentId>0</d2p1:SubDocumentId>
    </d2p1:AnalysisUploadedFile>
    <d2p1:AttachFiles>
      <d2p1:UploadedFileAttach>
        <d2p1:Checksum>String</d2p1:Checksum>
        <d2p1:ETag>String</d2p1:ETag>
        <d2p1:FileName>String</d2p1:FileName>
        <d2p1:FileSize>0</d2p1:FileSize>
        <d2p1:FileUrl>String</d2p1:FileUrl>
        <d2p1:Filekey>String</d2p1:Filekey>
        <d2p1:AccessType>Public</d2p1:AccessType>
        <d2p1:CreatedBy>0</d2p1:CreatedBy>
        <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:FileType>String</d2p1:FileType>
        <d2p1:StepId>0</d2p1:StepId>
        <d2p1:SubDocumentId>0</d2p1:SubDocumentId>
      </d2p1:UploadedFileAttach>
    </d2p1:AttachFiles>
    <d2p1:BasisDocument>
      <d2p1:SimpleDocumentRelation>
        <d2p1:DocumentCode>String</d2p1:DocumentCode>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
        <d2p1:Title>String</d2p1:Title>
        <d2p1:Type>String</d2p1:Type>
      </d2p1:SimpleDocumentRelation>
    </d2p1:BasisDocument>
    <d2p1:BasisForDocument>
      <d2p1:SimpleDocumentRelation>
        <d2p1:DocumentCode>String</d2p1:DocumentCode>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
        <d2p1:Title>String</d2p1:Title>
        <d2p1:Type>String</d2p1:Type>
      </d2p1:SimpleDocumentRelation>
    </d2p1:BasisForDocument>
    <d2p1:CanGrantReadPermission>false</d2p1:CanGrantReadPermission>
    <d2p1:CompactUploadedFile>
      <d2p1:Checksum>String</d2p1:Checksum>
      <d2p1:ETag>String</d2p1:ETag>
      <d2p1:FileName>String</d2p1:FileName>
      <d2p1:FileSize>0</d2p1:FileSize>
      <d2p1:FileUrl>String</d2p1:FileUrl>
      <d2p1:Filekey>String</d2p1:Filekey>
      <d2p1:AccessType>Public</d2p1:AccessType>
      <d2p1:CreatedBy>0</d2p1:CreatedBy>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:FileType>String</d2p1:FileType>
      <d2p1:StepId>0</d2p1:StepId>
      <d2p1:SubDocumentId>0</d2p1:SubDocumentId>
    </d2p1:CompactUploadedFile>
    <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
    <d2p1:CurrentApprover>
      <d2p1:ActionButtonLabel>String</d2p1:ActionButtonLabel>
      <d2p1:ApproverId>0</d2p1:ApproverId>
      <d2p1:IsApprovalRequired>false</d2p1:IsApprovalRequired>
      <d2p1:IsFinalStep>false</d2p1:IsFinalStep>
      <d2p1:ProcessDescription>String</d2p1:ProcessDescription>
      <d2p1:ProcessStatusId>0</d2p1:ProcessStatusId>
      <d2p1:ProcessTitle>String</d2p1:ProcessTitle>
      <d2p1:Status>String</d2p1:Status>
      <d2p1:StepOrder>0</d2p1:StepOrder>
    </d2p1:CurrentApprover>
    <d2p1:ExpiredByDocument>
      <d2p1:SimpleDocumentRelation>
        <d2p1:DocumentCode>String</d2p1:DocumentCode>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
        <d2p1:Title>String</d2p1:Title>
        <d2p1:Type>String</d2p1:Type>
      </d2p1:SimpleDocumentRelation>
    </d2p1:ExpiredByDocument>
    <d2p1:ExpiredDocument>
      <d2p1:SimpleDocumentRelation>
        <d2p1:DocumentCode>String</d2p1:DocumentCode>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
        <d2p1:Title>String</d2p1:Title>
        <d2p1:Type>String</d2p1:Type>
      </d2p1:SimpleDocumentRelation>
    </d2p1:ExpiredDocument>
    <d2p1:FullUploadedFile>
      <d2p1:Checksum>String</d2p1:Checksum>
      <d2p1:ETag>String</d2p1:ETag>
      <d2p1:FileName>String</d2p1:FileName>
      <d2p1:FileSize>0</d2p1:FileSize>
      <d2p1:FileUrl>String</d2p1:FileUrl>
      <d2p1:Filekey>String</d2p1:Filekey>
      <d2p1:AccessType>Public</d2p1:AccessType>
      <d2p1:CreatedBy>0</d2p1:CreatedBy>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:FileType>String</d2p1:FileType>
      <d2p1:StepId>0</d2p1:StepId>
      <d2p1:SubDocumentId>0</d2p1:SubDocumentId>
    </d2p1:FullUploadedFile>
    <d2p1:HasReadPermission>false</d2p1:HasReadPermission>
    <d2p1:MainDocument>
      <d2p1:DocumentCode>String</d2p1:DocumentCode>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:Type>String</d2p1:Type>
    </d2p1:MainDocument>
    <d2p1:NextApprover>
      <d2p1:ActionButtonLabel>String</d2p1:ActionButtonLabel>
      <d2p1:IsApprovalRequired>false</d2p1:IsApprovalRequired>
      <d2p1:IsFinalStep>false</d2p1:IsFinalStep>
      <d2p1:ProcessDescription>String</d2p1:ProcessDescription>
      <d2p1:ProcessStatusId>0</d2p1:ProcessStatusId>
      <d2p1:ProcessTitle>String</d2p1:ProcessTitle>
      <d2p1:StepOrder>0</d2p1:StepOrder>
      <d2p1:UserProfiles>
        <d2p1:UserProfile>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:Password>String</d2p1:Password>
          <d2p1:Avatar>String</d2p1:Avatar>
          <d2p1:Birthday>0001-01-01T00:00:00</d2p1:Birthday>
          <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:Email>String</d2p1:Email>
          <d2p1:FailedLoginCount>0</d2p1:FailedLoginCount>
          <d2p1:FullName>String</d2p1:FullName>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:IsDeleted>false</d2p1:IsDeleted>
          <d2p1:LastLoginDate>0001-01-01T00:00:00</d2p1:LastLoginDate>
          <d2p1:PartyGroupId>0</d2p1:PartyGroupId>
          <d2p1:Roles xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>0</d6p1:int>
          </d2p1:Roles>
          <d2p1:Telephone>String</d2p1:Telephone>
          <d2p1:UpdatedAt>0001-01-01T00:00:00</d2p1:UpdatedAt>
          <d2p1:UpdatedBy>String</d2p1:UpdatedBy>
        </d2p1:UserProfile>
      </d2p1:UserProfiles>
    </d2p1:NextApprover>
    <d2p1:PartUploadedFile>
      <d2p1:Checksum>String</d2p1:Checksum>
      <d2p1:ETag>String</d2p1:ETag>
      <d2p1:FileName>String</d2p1:FileName>
      <d2p1:FileSize>0</d2p1:FileSize>
      <d2p1:FileUrl>String</d2p1:FileUrl>
      <d2p1:Filekey>String</d2p1:Filekey>
      <d2p1:AccessType>Public</d2p1:AccessType>
      <d2p1:CreatedBy>0</d2p1:CreatedBy>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:FileType>String</d2p1:FileType>
      <d2p1:StepId>0</d2p1:StepId>
      <d2p1:SubDocumentId>0</d2p1:SubDocumentId>
    </d2p1:PartUploadedFile>
    <d2p1:ReferenceDocument>
      <d2p1:SimpleDocumentRelation>
        <d2p1:DocumentCode>String</d2p1:DocumentCode>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
        <d2p1:Title>String</d2p1:Title>
        <d2p1:Type>String</d2p1:Type>
      </d2p1:SimpleDocumentRelation>
    </d2p1:ReferenceDocument>
    <d2p1:ReferencedByDocument>
      <d2p1:SimpleDocumentRelation>
        <d2p1:DocumentCode>String</d2p1:DocumentCode>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
        <d2p1:Title>String</d2p1:Title>
        <d2p1:Type>String</d2p1:Type>
      </d2p1:SimpleDocumentRelation>
    </d2p1:ReferencedByDocument>
    <d2p1:ReplacedByDocument>
      <d2p1:SimpleDocumentRelation>
        <d2p1:DocumentCode>String</d2p1:DocumentCode>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
        <d2p1:Title>String</d2p1:Title>
        <d2p1:Type>String</d2p1:Type>
      </d2p1:SimpleDocumentRelation>
    </d2p1:ReplacedByDocument>
    <d2p1:ReplacedDocument>
      <d2p1:SimpleDocumentRelation>
        <d2p1:DocumentCode>String</d2p1:DocumentCode>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
        <d2p1:Title>String</d2p1:Title>
        <d2p1:Type>String</d2p1:Type>
      </d2p1:SimpleDocumentRelation>
    </d2p1:ReplacedDocument>
    <d2p1:ScopeType>0</d2p1:ScopeType>
    <d2p1:StepOrder>0</d2p1:StepOrder>
    <d2p1:UpdateForDocument>
      <d2p1:DocumentCode>String</d2p1:DocumentCode>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:Type>String</d2p1:Type>
    </d2p1:UpdateForDocument>
  </Data>
  <Message>String</Message>
</DocumentDetailResponse>