tvpl.api

<back to all web services

CreateDocumentReferenceRequest

Requires Authentication
Required role:super-admin
The following routes are available for this service:
POST/document-reference
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 CreateDocumentReferenceRequest:
    parent_document_id: int = 0
    title: Optional[str] = None
    document_code: Optional[str] = None
    reference_url: Optional[str] = None
    description: Optional[str] = None

Python CreateDocumentReferenceRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /document-reference HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"parentDocumentId":0,"title":"String","documentCode":"String","referenceUrl":"String","description":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"id":0,"parentDocumentId":0,"title":"String","documentCode":"String","referenceUrl":"String","description":"String"}