tvpl.api

<back to all web services

SearchCategoryRequest

Requires Authentication
The following routes are available for this service:
POST/category
import Foundation
import ServiceStack

public class SearchCategoryRequest : CategoryRequest
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class CategoryRequest : Codable
{
    public var id:Int?
    public var type:CategoryTypes?
    public var name:String
    public var parentId:Int?

    required public init(){}
}

public enum CategoryTypes : String, Codable
{
    case Department
    case PartyGroup
    case DocGroup
    case DocType
    case IssuingAgency
    case Status
    case Subjects
    case Workflow
}

public class BaseResponse<List : Codable> : IResponseRequest, Codable
{
    public var code:Int
    public var message:String
    public var data:[Category] = []

    required public init(){}
}

public class Category : CreateCategoryModel
{
    public var id:Int
    public var level:Int
    public var sortOrder:Int
    public var lastUpdate:Date?
    // @Ignore()
    public var children:[Category] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case id
        case level
        case sortOrder
        case lastUpdate
        case children
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        level = try container.decodeIfPresent(Int.self, forKey: .level)
        sortOrder = try container.decodeIfPresent(Int.self, forKey: .sortOrder)
        lastUpdate = try container.decodeIfPresent(Date.self, forKey: .lastUpdate)
        children = try container.decodeIfPresent([Category].self, forKey: .children) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if level != nil { try container.encode(level, forKey: .level) }
        if sortOrder != nil { try container.encode(sortOrder, forKey: .sortOrder) }
        if lastUpdate != nil { try container.encode(lastUpdate, forKey: .lastUpdate) }
        if children.count > 0 { try container.encode(children, forKey: .children) }
    }
}

public class CreateCategoryModel : Codable
{
    public var name:String
    public var Description:String
    public var type:CategoryTypes
    public var isParty:Bool
    // @Ignore()
    public var childList:[Int] = []

    required public init(){}
}


Swift SearchCategoryRequest 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 /category HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":0,"type":"Department","name":"String","parentId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"code":0,"message":"String","data":[{"id":0,"level":0,"sortOrder":0,"lastUpdate":"0001-01-01T00:00:00.0000000+07:06","children":[{"id":0,"level":0,"sortOrder":0,"lastUpdate":"0001-01-01T00:00:00.0000000+07:06","children":[{"id":0,"level":0,"sortOrder":0,"lastUpdate":"0001-01-01T00:00:00.0000000+07:06","children":null,"name":"String","description":"String","type":"Department","isParty":false,"childList":[0]}],"name":"String","description":"String","type":"Department","isParty":false,"childList":[0]}],"name":"String","description":"String","type":"Department","isParty":false,"childList":[0]}]}