adnx.devias.admin.api

<back to all web services

ConfigListRequest

Requires Authentication
Required permission:view-config
The following routes are available for this service:
GET/configurations
import Foundation
import ServiceStack

public class ConfigListRequest : PagingRequest
{
    public var name:String

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

    private enum CodingKeys : String, CodingKey {
        case name
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        name = try container.decodeIfPresent(String.self, forKey: .name)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if name != nil { try container.encode(name, forKey: .name) }
    }
}

public class PagingRequest : Codable
{
    public var page:Int
    public var limit:Int
    public var offSet:Int

    required public init(){}
}

public class PageResponse<SystemConfig : Codable> : IResponseRequest, Codable
{
    public var code:Int
    public var totalValue:Int
    public var message:String
    public var data:[SystemConfig] = []
    public var pagination:Pagination

    required public init(){}
}

public class SystemConfig : ICreated, IUpdate, Codable
{
    public var id:Int
    public var name:String
    public var value:String
    public var Description:String
    public var isActive:Bool
    // @Required()
    public var createdDate:Date?

    // @Required()
    public var updatedDate:Date?

    required public init(){}
}

public class Pagination : Codable
{
    public var total:Int
    public var pages:Int
    public var offset:Int
    public var limit:Int
    public var currentPage:Int

    required public init(){}
}


Swift ConfigListRequest 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.

GET /configurations HTTP/1.1 
Host: chienbinhdevias-admin-api-sandbox.adnx.vn 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"code":0,"totalValue":0,"message":"String","data":[{"id":0,"name":"String","value":"String","description":"String","isActive":false,"createdDate":"0001-01-01T00:00:00.0000000+07:06","updatedDate":"0001-01-01T00:00:00.0000000+07:06"}],"pagination":null}