tvpl.api

<back to all web services

CreateCategoryRequest

Requires Authentication
Required role:super-admin
The following routes are available for this service:
POST/category/create
import 'package:servicestack/servicestack.dart';

enum CategoryTypes
{
    Department,
    PartyGroup,
    DocGroup,
    DocType,
    IssuingAgency,
    Status,
    Subjects,
    Workflow,
}

class CreateCategoryModel implements IConvertible
{
    String? name;
    String? description;
    CategoryTypes? type;
    bool? isParty;
    // @ignore()
    List<int>? childList;

    CreateCategoryModel({this.name,this.description,this.type,this.isParty,this.childList});
    CreateCategoryModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        name = json['name'];
        description = json['description'];
        type = JsonConverters.fromJson(json['type'],'CategoryTypes',context!);
        isParty = json['isParty'];
        childList = JsonConverters.fromJson(json['childList'],'List<int>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'name': name,
        'description': description,
        'type': JsonConverters.toJson(type,'CategoryTypes',context!),
        'isParty': isParty,
        'childList': JsonConverters.toJson(childList,'List<int>',context!)
    };

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

class CreateCategoryResponse implements IResponseRequest, IConvertible
{
    int? id;
    int? code;
    String? message;

    CreateCategoryResponse({this.id,this.code,this.message});
    CreateCategoryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        code = json['code'];
        message = json['message'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'code': code,
        'message': message
    };

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

class CreateCategoryRequest extends CreateCategoryModel implements IConvertible
{
    CreateCategoryRequest();
    CreateCategoryRequest.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "CreateCategoryRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'etc_api.vsmlab.vn', types: <String, TypeInfo> {
    'CategoryTypes': TypeInfo(TypeOf.Enum, enumValues:CategoryTypes.values),
    'CreateCategoryModel': TypeInfo(TypeOf.Class, create:() => CreateCategoryModel()),
    'CreateCategoryResponse': TypeInfo(TypeOf.Class, create:() => CreateCategoryResponse()),
    'CreateCategoryRequest': TypeInfo(TypeOf.Class, create:() => CreateCategoryRequest()),
});

Dart CreateCategoryRequest 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 /category/create HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateCategoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <ChildList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:int>0</d2p1:int>
  </ChildList>
  <Description xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Description>
  <IsParty xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsParty>
  <Name xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Name>
  <Type xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">Department</Type>
</CreateCategoryRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateCategoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <Id>0</Id>
  <Message>String</Message>
</CreateCategoryResponse>