NAV

RegionGetList

DomainAPI|Regions

The following routes are available for this service:
GET	/regions

import Foundation
import ServiceStack

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

public class RegionGetListResponse : GetListResponse<RegionViewModel>
{
    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 GetListResponse<TEntity : Codable> : Codable
{
    public var items:[TEntity] = []
    public var responseStatus:ResponseStatus?

    required public init(){}
}

public class RegionViewModel : Codable
{
    public var regionId:String?
    public var regionDescription:String?

    required public init(){}
}

Swift RegionGetList 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 /regions HTTP/1.1 
Host: extensions.avon.ca 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"items":[{"regionId":"String","regionDescription":"String"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}