Pecuario.Backend

<back to all web services

GetAnimalCategories

The following routes are available for this service:
GET/api/v1/utils/animal-categories
import Foundation
import ServiceStack

public class GetAnimalCategories : IGet, Codable
{
    required public init(){}
}

public class GetAnimalCategoriesResponse : BaseResponse
{
    public var animalCategories:[AnimalCategory] = []

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

    private enum CodingKeys : String, CodingKey {
        case animalCategories
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        animalCategories = try container.decodeIfPresent([AnimalCategory].self, forKey: .animalCategories) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if animalCategories.count > 0 { try container.encode(animalCategories, forKey: .animalCategories) }
    }
}

public class BaseResponse : Codable
{
    public var status:Status

    required public init(){}
}

public class Status : Codable
{
    public var message:String
    public var statusCode:Int

    required public init(){}
}

public class AnimalCategory : Codable
{
    public var id:Int
    // @Required()
    // @StringLength(50)
    public var name:String?

    public var alias:String
    public var order:Int
    public var enabled:Bool

    required public init(){}
}


Swift GetAnimalCategories DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/v1/utils/animal-categories HTTP/1.1 
Host: pecuario-backend.develsystems.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"animalCategories":[{"id":0,"name":"String","alias":"String","order":0,"enabled":false}]}