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}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentReferences:
    id: int = 0
    parent_document_id: int = 0
    title: Optional[str] = None
    document_code: Optional[str] = None
    reference_url: Optional[str] = None
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateDocumentReferenceRequest:
    id: int = 0
    parent_document_id: int = 0
    title: Optional[str] = None
    document_code: Optional[str] = None
    reference_url: Optional[str] = None
    description: Optional[str] = None

Python UpdateDocumentReferenceRequest DTOs

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>