tvpl.api

<back to all web services

AdvanceCreateDocument

Requires Authentication
The following routes are available for this service:
POST/document/advance-create
AdvanceCreateDocument Parameters:
NameParameterData TypeRequiredDescription
PartUploadedFilebodyUploadedFilesNo
CompactUploadedFilebodyUploadedFilesNo
AnalysisUploadedFilebodyUploadedFilesNo
FullUploadedFilebodyUploadedFilesNo
AttachFilesbodyList<UploadedFiles>No
BasisDocumentIdbodyList<int>No
ReferenceDocumentIdbodyList<int>No
ReplacedDocumentIdbodyList<int>No
ExpiredDocumentIdbodyList<int>No
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
UploadedFiles Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
UploadedFileformstringYes
SubDocumentIdformint?No
StepIdformint?No
CodeformintNo
BasicUploadedFile Parameters:
NameParameterData TypeRequiredDescription
FileNameformstringYes
FilekeyformstringYes
FileUrlformstringYes
ChecksumformstringYes
ETagformstringYes
FileSizeformlongNo
DocumentDetailResponse Parameters:
NameParameterData TypeRequiredDescription
DataformDocumentDetailYes
CodeformintNo
MessageformstringYes
DocumentDetail Parameters:
NameParameterData TypeRequiredDescription
PartUploadedFileformUploadedFileAttachNo
CompactUploadedFileformUploadedFileAttachNo
AnalysisUploadedFileformUploadedFileAttachNo
FullUploadedFileformUploadedFileAttachNo
CreatedAtformDateTimeNo
NextApproverformApproversProfileNo
CurrentApproverformCurrentApproverNo
AttachFilesformList<UploadedFileAttach>No
HasReadPermissionformboolNo
CanGrantReadPermissionformboolNo
BasisDocumentformList<SimpleDocumentRelation>No
BasisForDocumentformList<SimpleDocumentRelation>No
MainDocumentformSimpleDocumentRelationNo
ReferenceDocumentformList<SimpleDocumentRelation>No
ReferencedByDocumentformList<SimpleDocumentRelation>No
ReplacedDocumentformList<SimpleDocumentRelation>No
ReplacedByDocumentformList<SimpleDocumentRelation>No
ExpiredDocumentformList<SimpleDocumentRelation>No
ExpiredByDocumentformList<SimpleDocumentRelation>No
UpdateForDocumentformSimpleDocumentRelationNo
ScopeTypeformint?No
StepOrderformintNo
DocumentSearchResultItem Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
DescriptionformstringYes
OwnerformstringNo
DocumentPolicyIdformint?No
UpdateDocumentIdformint?No
EffectBeginDateformDateTime?No
EffectEndDateformDateTime?No
IssuingAgencyIdformint?No
SubjectIdformint?No
SignByformstringNo
SignDateformDateTime?No
UpdatedAtformDateTime?No
StatusIdformint?No
IsInternalformboolNo
DocumentNumberformstringNo
DocumentCodeformstringNo
IsUrgentformbool?No
IdformintNo
ReasonReturnformstringNo
AccountIdformint?No
ApproverIdformint?No
UpdatedByformstringNo
CreatedByformstringNo
IsPartyformbool?No
IsRevisionRequestedformbool?No
IsPrivateformbool?No
DepartmentIdformint?No
PublicationDateformDateTime?No
ProcessStatusIdformintNo
DocumentTypeIdformint?No
DocumentGroupIdformint?No
AccountNameformstringNo
AcceptAccountNameformstringNo
DocumentGroupTextformstringNo
ProcessStatusTextformstringNo
DocumentTypeTextformstringNo
DepartmentTextformstringNo
StatusTextformstringNo
IssuingAgencyTextformstringNo
SubjectTextformstringNo
CommentformstringNo
SubmitCommentformstringNo
FullFileformstringNo
ParthFileformstringNo
IsActiveformbool?No
StepOrderformint?No
StepCountformint?No
UploadedFileAttach Parameters:
NameParameterData TypeRequiredDescription
FileTypeformstringYes
SubDocumentIdformint?No
StepIdformint?No
UploadedFileModel Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
AccessTypeformAccessTypeNo
CreatedByformintNo
CreatedDateformDateTimeNo
AccessType Enum:
Public
Restricted
ApproversProfile Parameters:
NameParameterData TypeRequiredDescription
UserProfilesformList<UserProfile>No
ProcessStatusIdformintNo
ProcessTitleformstringYes
ActionButtonLabelformstringNo
ProcessDescriptionformstringYes
IsApprovalRequiredformboolNo
IsFinalStepformboolNo
StepOrderformintNo
UserProfile Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
FullNameformstringNo
EmailformstringNo
DepartmentIdformint?No
PartyGroupIdformint?No
AvatarformstringNo
TelephoneformstringNo
BirthdayformDateTime?No
CreatedAtformDateTime?No
UpdatedAtformDateTime?No
FailedLoginCountformintNo
RolesformList<int>Yes
LastLoginDateformDateTime?No
UserLogin Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
CurrentApprover Parameters:
NameParameterData TypeRequiredDescription
ApproverIdformint?No
StatusformstringNo
ProcessStatusIdformintNo
ProcessTitleformstringYes
ActionButtonLabelformstringNo
ProcessDescriptionformstringYes
IsApprovalRequiredformboolNo
IsFinalStepformboolNo
StepOrderformintNo
SimpleDocumentRelation Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TitleformstringYes
DocumentCodeformstringYes
PublicationDateformDateTime?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /document/advance-create HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"partUploadedFile":{"id":0,"uploadedFile":"String","subDocumentId":0,"stepId":0,"code":0,"fileName":"String","filekey":"String","fileUrl":"String","checksum":"String","eTag":"String","fileSize":0},"compactUploadedFile":{"id":0,"uploadedFile":"String","subDocumentId":0,"stepId":0,"code":0,"fileName":"String","filekey":"String","fileUrl":"String","checksum":"String","eTag":"String","fileSize":0},"analysisUploadedFile":{"id":0,"uploadedFile":"String","subDocumentId":0,"stepId":0,"code":0,"fileName":"String","filekey":"String","fileUrl":"String","checksum":"String","eTag":"String","fileSize":0},"fullUploadedFile":{"id":0,"uploadedFile":"String","subDocumentId":0,"stepId":0,"code":0,"fileName":"String","filekey":"String","fileUrl":"String","checksum":"String","eTag":"String","fileSize":0},"attachFiles":[{"id":0,"uploadedFile":"String","subDocumentId":0,"stepId":0,"code":0,"fileName":"String","filekey":"String","fileUrl":"String","checksum":"String","eTag":"String","fileSize":0}],"basisDocumentId":[0],"referenceDocumentId":[0],"replacedDocumentId":[0],"expiredDocumentId":[0],"title":"String","description":"String","owner":"String","documentPolicyId":0,"updateDocumentId":0,"effectBeginDate":"0001-01-01T00:00:00.0000000+07:06","effectEndDate":"0001-01-01T00:00:00.0000000+07:06","issuingAgencyId":0,"documentTypeId":0,"documentGroupId":0,"subjectId":0,"signBy":"String","signDate":"0001-01-01T00:00:00.0000000+07:06","statusId":0,"isInternal":false,"documentNumber":"String","documentCode":"String","isUrgent":false,"scopeType":0,"isActive":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"data":{"partUploadedFile":{"fileType":"String","subDocumentId":0,"stepId":0,"id":0,"accessType":"Public","createdBy":0,"createdDate":"0001-01-01T00:00:00.0000000+07:06","fileName":"String","filekey":"String","fileUrl":"String","checksum":"String","eTag":"String","fileSize":0},"compactUploadedFile":{"fileType":"String","subDocumentId":0,"stepId":0,"id":0,"accessType":"Public","createdBy":0,"createdDate":"0001-01-01T00:00:00.0000000+07:06","fileName":"String","filekey":"String","fileUrl":"String","checksum":"String","eTag":"String","fileSize":0},"analysisUploadedFile":{"fileType":"String","subDocumentId":0,"stepId":0,"id":0,"accessType":"Public","createdBy":0,"createdDate":"0001-01-01T00:00:00.0000000+07:06","fileName":"String","filekey":"String","fileUrl":"String","checksum":"String","eTag":"String","fileSize":0},"fullUploadedFile":{"fileType":"String","subDocumentId":0,"stepId":0,"id":0,"accessType":"Public","createdBy":0,"createdDate":"0001-01-01T00:00:00.0000000+07:06","fileName":"String","filekey":"String","fileUrl":"String","checksum":"String","eTag":"String","fileSize":0},"createdAt":"0001-01-01T00:00:00.0000000+07:06","nextApprover":{"userProfiles":[{"id":0,"fullName":"String","email":"String","departmentId":0,"partyGroupId":0,"avatar":"String","telephone":"String","birthday":"0001-01-01T00:00:00.0000000+07:06","createdAt":"0001-01-01T00:00:00.0000000+07:06","updatedAt":"0001-01-01T00:00:00.0000000+07:06","failedLoginCount":0,"roles":[0],"lastLoginDate":"0001-01-01T00:00:00.0000000+07:06","name":"String"}],"processStatusId":0,"processTitle":"String","actionButtonLabel":"String","processDescription":"String","isApprovalRequired":false,"isFinalStep":false,"stepOrder":0},"currentApprover":{"approverId":0,"status":"String","processStatusId":0,"processTitle":"String","actionButtonLabel":"String","processDescription":"String","isApprovalRequired":false,"isFinalStep":false,"stepOrder":0},"attachFiles":[{"fileType":"String","subDocumentId":0,"stepId":0,"id":0,"accessType":"Public","createdBy":0,"createdDate":"0001-01-01T00:00:00.0000000+07:06","fileName":"String","filekey":"String","fileUrl":"String","checksum":"String","eTag":"String","fileSize":0}],"hasReadPermission":false,"canGrantReadPermission":false,"basisDocument":[{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"}],"basisForDocument":[{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"}],"mainDocument":{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"},"referenceDocument":[{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"}],"referencedByDocument":[{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"}],"replacedDocument":[{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"}],"replacedByDocument":[{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"}],"expiredDocument":[{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"}],"expiredByDocument":[{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"}],"updateForDocument":{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"},"scopeType":0,"stepOrder":0,"title":"String","description":"String","owner":"String","documentPolicyId":0,"updateDocumentId":0,"effectBeginDate":"0001-01-01T00:00:00.0000000+07:06","effectEndDate":"0001-01-01T00:00:00.0000000+07:06","issuingAgencyId":0,"subjectId":0,"signBy":"String","signDate":"0001-01-01T00:00:00.0000000+07:06","updatedAt":"0001-01-01T00:00:00.0000000+07:06","statusId":0,"isInternal":false,"documentNumber":"String","documentCode":"String","isUrgent":false,"id":0,"reasonReturn":"String","accountId":0,"approverId":0,"updatedBy":"String","createdBy":"String","isParty":false,"isRevisionRequested":false,"isPrivate":false,"departmentId":0,"publicationDate":"0001-01-01T00:00:00.0000000+07:06","processStatusId":0,"documentTypeId":0,"documentGroupId":0,"accountName":"String","acceptAccountName":"String","documentGroupText":"String","processStatusText":"String","documentTypeText":"String","departmentText":"String","statusText":"String","issuingAgencyText":"String","subjectText":"String","comment":"String","submitComment":"String","fullFile":"String","parthFile":"String","isActive":false,"stepOrder":0,"stepCount":0},"code":0,"message":"String"}