tvpl.api

CreateDocumentNumberFormatRequest

**Requires Authentication**
Required role:	super-admin

The following routes are available for this service:
POST	/document-number-format

import 'package:servicestack/servicestack.dart';

class DocumentNumberFormat implements IConvertible
{
    int? id;
    // @required()
    // @StringLength(50)
    String? typeKey;

    // @required()
    // @StringLength(255)
    String? name;

    // @required()
    // @StringLength(255)
    String? formatTemplate;

    int? padding;
    int? resetPeriod;
    // @StringLength(500)
    String? labelKeys;

    bool? isActive;
    bool? isDeleted;
    DateTime? deletedAt;
    int? deletedBy;
    DateTime? createdAt;
    int? createdBy;
    DateTime? updatedAt;
    int? updatedBy;

    DocumentNumberFormat({this.id,this.typeKey,this.name,this.formatTemplate,this.padding,this.resetPeriod,this.labelKeys,this.isActive,this.isDeleted,this.deletedAt,this.deletedBy,this.createdAt,this.createdBy,this.updatedAt,this.updatedBy});
    DocumentNumberFormat.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        typeKey = json['typeKey'];
        name = json['name'];
        formatTemplate = json['formatTemplate'];
        padding = json['padding'];
        resetPeriod = json['resetPeriod'];
        labelKeys = json['labelKeys'];
        isActive = json['isActive'];
        isDeleted = json['isDeleted'];
        deletedAt = JsonConverters.fromJson(json['deletedAt'],'DateTime',context!);
        deletedBy = json['deletedBy'];
        createdAt = JsonConverters.fromJson(json['createdAt'],'DateTime',context!);
        createdBy = json['createdBy'];
        updatedAt = JsonConverters.fromJson(json['updatedAt'],'DateTime',context!);
        updatedBy = json['updatedBy'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'typeKey': typeKey,
        'name': name,
        'formatTemplate': formatTemplate,
        'padding': padding,
        'resetPeriod': resetPeriod,
        'labelKeys': labelKeys,
        'isActive': isActive,
        'isDeleted': isDeleted,
        'deletedAt': JsonConverters.toJson(deletedAt,'DateTime',context!),
        'deletedBy': deletedBy,
        'createdAt': JsonConverters.toJson(createdAt,'DateTime',context!),
        'createdBy': createdBy,
        'updatedAt': JsonConverters.toJson(updatedAt,'DateTime',context!),
        'updatedBy': updatedBy
    };

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

class CreateDocumentNumberFormatRequest implements IConvertible
{
    String? typeKey;
    String? name;
    String? formatTemplate;
    int? padding;
    int? resetPeriod;
    String? labelKeys;
    bool? isActive;

    CreateDocumentNumberFormatRequest({this.typeKey,this.name,this.formatTemplate,this.padding,this.resetPeriod,this.labelKeys,this.isActive});
    CreateDocumentNumberFormatRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        typeKey = json['typeKey'];
        name = json['name'];
        formatTemplate = json['formatTemplate'];
        padding = json['padding'];
        resetPeriod = json['resetPeriod'];
        labelKeys = json['labelKeys'];
        isActive = json['isActive'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'typeKey': typeKey,
        'name': name,
        'formatTemplate': formatTemplate,
        'padding': padding,
        'resetPeriod': resetPeriod,
        'labelKeys': labelKeys,
        'isActive': isActive
    };

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

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

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

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

<CreateDocumentNumberFormatRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <FormatTemplate>String</FormatTemplate>
  <IsActive>false</IsActive>
  <LabelKeys>String</LabelKeys>
  <Name>String</Name>
  <Padding>0</Padding>
  <ResetPeriod>0</ResetPeriod>
  <TypeKey>String</TypeKey>
</CreateDocumentNumberFormatRequest>

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

<DocumentNumberFormat xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
  <CreatedAt>0001-01-01T00:00:00</CreatedAt>
  <CreatedBy>0</CreatedBy>
  <DeletedAt>0001-01-01T00:00:00</DeletedAt>
  <DeletedBy>0</DeletedBy>
  <FormatTemplate>String</FormatTemplate>
  <Id>0</Id>
  <IsActive>false</IsActive>
  <IsDeleted>false</IsDeleted>
  <LabelKeys>String</LabelKeys>
  <Name>String</Name>
  <Padding>0</Padding>
  <ResetPeriod>0</ResetPeriod>
  <TypeKey>String</TypeKey>
  <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
  <UpdatedBy>0</UpdatedBy>
</DocumentNumberFormat>