tvpl.api

<back to all web services

UpdateDocumentReferenceRequest

Requires Authentication
Required role:super-admin
The following routes are available for this service:
PUT/document-reference/{Id}
UpdateDocumentReferenceRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
ParentDocumentIdbodyintNo
TitlebodystringYes
DocumentCodebodystringYes
ReferenceUrlbodystringYes
DescriptionbodystringYes
DocumentReferences Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ParentDocumentIdformintNo
TitleformstringYes
DocumentCodeformstringYes
ReferenceUrlformstringYes
DescriptionformstringYes

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.

PUT /document-reference/{Id} HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateDocumentReferenceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Description>String</Description>
  <DocumentCode>String</DocumentCode>
  <Id>0</Id>
  <ParentDocumentId>0</ParentDocumentId>
  <ReferenceUrl>String</ReferenceUrl>
  <Title>String</Title>
</UpdateDocumentReferenceRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentReferences xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
  <Description>String</Description>
  <DocumentCode>String</DocumentCode>
  <Id>0</Id>
  <ParentDocumentId>0</ParentDocumentId>
  <ReferenceUrl>String</ReferenceUrl>
  <Title>String</Title>
</DocumentReferences>