Pecuario.Backend

<back to all web services

GetCitiesByRegion

The following routes are available for this service:
GET/api/v1/utils/cities/{RegionId}
import Foundation
import ServiceStack

public class GetCitiesByRegion : IGet, Codable
{
    public var regionId:Int

    required public init(){}
}

public class GetCitiesByRegionResponse : BaseResponse
{
    public var cities:[City] = []

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

    private enum CodingKeys : String, CodingKey {
        case cities
    }

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

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

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 City : Codable
{
    public var id:Int
    // @References(typeof(Region))
    public var regionId:Int

    // @Required()
    // @StringLength(200)
    public var name:String?

    required public init(){}
}


Swift GetCitiesByRegion DTOs

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

HTTP + OTHER

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

GET /api/v1/utils/cities/{RegionId} HTTP/1.1 
Host: pecuario-backend.develsystems.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"cities":[{"id":0,"regionId":0,"name":"String"}]}