NAV

RegionGetList

DomainAPI|Regions

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

import 'package:servicestack/servicestack.dart';

class RegionViewModel implements IConvertible
{
    String? regionId;
    String? regionDescription;

    RegionViewModel({this.regionId,this.regionDescription});
    RegionViewModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        regionId = json['regionId'];
        regionDescription = json['regionDescription'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'regionId': regionId,
        'regionDescription': regionDescription
    };

    getTypeName() => "RegionViewModel";
    TypeContext? context = _ctx;
}

class RegionGetListResponse extends GetListResponse<RegionViewModel> implements IConvertible
{
    RegionGetListResponse();
    RegionGetListResponse.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "RegionGetListResponse";
    TypeContext? context = _ctx;
}

class RegionGetList implements IGet, IConvertible
{
    RegionGetList();
    RegionGetList.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "RegionGetList";
    TypeContext? context = _ctx;
}

class GetListResponse<TEntity> implements IConvertible
{
    List<TEntity>? items;
    ResponseStatus? responseStatus;

    GetListResponse({this.items,this.responseStatus});
    GetListResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        items = JsonConverters.fromJson(json['items'],'List<${runtimeGenericTypeDefs(this,[0]).join(",")}>',context!);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'items': JsonConverters.toJson(items,'List<TEntity>',context!),
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetListResponse<$TEntity>";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'extensions.avon.ca', types: <String, TypeInfo> {
    'RegionViewModel': TypeInfo(TypeOf.Class, create:() => RegionViewModel()),
    'RegionGetListResponse': TypeInfo(TypeOf.Class, create:() => RegionGetListResponse()),
    'RegionGetList': TypeInfo(TypeOf.Class, create:() => RegionGetList()),
    'GetListResponse<TEntity>': TypeInfo(TypeOf.GenericDef,create:() => GetListResponse()),
});

Dart RegionGetList DTOs

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

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RegionGetListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nxnw.Adc.CountryCulture.ServiceModel">
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Nxnw.Adc.CountryCulture.ServiceModel" xmlns="http://schemas.datacontract.org/2004/07/Nxnw.Adc.Common.ServiceModel">
    <d2p1:RegionViewModel>
      <d2p1:RegionDescription>String</d2p1:RegionDescription>
      <d2p1:RegionId>String</d2p1:RegionId>
    </d2p1:RegionViewModel>
  </Items>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Nxnw.Adc.Common.ServiceModel">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</RegionGetListResponse>