tvpl.api

<back to all web services

EnsureDocumentNumberRequest

Requires Authentication
The following routes are available for this service:
POST/document-number/ensure
EnsureDocumentNumberRequest Parameters:
NameParameterData TypeRequiredDescription
WorkflowIdbodyintNo
LabelKeybodystringYes
EnsureDocumentNumberResponse Parameters:
NameParameterData TypeRequiredDescription
CodeformintNo
MessageformstringYes
ValueformstringNo

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.

POST /document-number/ensure HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EnsureDocumentNumberRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <LabelKey>String</LabelKey>
  <WorkflowId>0</WorkflowId>
</EnsureDocumentNumberRequest>

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

<EnsureDocumentNumberResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <Message>String</Message>
  <Value>String</Value>
</EnsureDocumentNumberResponse>