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 'package:servicestack/servicestack.dart';

class DocumentReferences implements IConvertible
{
    int? id;
    int? parentDocumentId;
    String? title;
    String? documentCode;
    String? referenceUrl;
    String? description;

    DocumentReferences({this.id,this.parentDocumentId,this.title,this.documentCode,this.referenceUrl,this.description});
    DocumentReferences.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        parentDocumentId = json['parentDocumentId'];
        title = json['title'];
        documentCode = json['documentCode'];
        referenceUrl = json['referenceUrl'];
        description = json['description'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'parentDocumentId': parentDocumentId,
        'title': title,
        'documentCode': documentCode,
        'referenceUrl': referenceUrl,
        'description': description
    };

    getTypeName() => "DocumentReferences";
    TypeContext? context = _ctx;
}

class UpdateDocumentReferenceRequest implements IConvertible
{
    int? id;
    int? parentDocumentId;
    String? title;
    String? documentCode;
    String? referenceUrl;
    String? description;

    UpdateDocumentReferenceRequest({this.id,this.parentDocumentId,this.title,this.documentCode,this.referenceUrl,this.description});
    UpdateDocumentReferenceRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        parentDocumentId = json['parentDocumentId'];
        title = json['title'];
        documentCode = json['documentCode'];
        referenceUrl = json['referenceUrl'];
        description = json['description'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'parentDocumentId': parentDocumentId,
        'title': title,
        'documentCode': documentCode,
        'referenceUrl': referenceUrl,
        'description': description
    };

    getTypeName() => "UpdateDocumentReferenceRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'etc_api.vsmlab.vn', types: <String, TypeInfo> {
    'DocumentReferences': TypeInfo(TypeOf.Class, create:() => DocumentReferences()),
    'UpdateDocumentReferenceRequest': TypeInfo(TypeOf.Class, create:() => UpdateDocumentReferenceRequest()),
});

Dart 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>