Pecuario.Backend

<back to all web services

GetAnimalTypesByCategory

The following routes are available for this service:
GET/api/v1/utils/animal-types/{categoryId}
import Foundation
import ServiceStack

public class GetAnimalTypesByCategory : IGet, Codable
{
    public var categoryId:Int?

    required public init(){}
}

public class GetAnimalTypesByCategoryResponse : BaseResponse
{
    public var animalTypes:[AnimalType] = []

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

    private enum CodingKeys : String, CodingKey {
        case animalTypes
    }

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

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

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 AnimalType : Codable
{
    public var id:Int
    // @Required()
    // @StringLength(50)
    public var name:String?

    // @References(typeof(AnimalCategory))
    public var animalCategoryId:Int

    required public init(){}
}


Swift GetAnimalTypesByCategory DTOs

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

HTTP + JSV

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

GET /api/v1/utils/animal-types/{categoryId} HTTP/1.1 
Host: pecuario-backend.develsystems.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	animalTypes: 
	[
		{
			id: 0,
			name: String,
			animalCategoryId: 0
		}
	]
}