Platform API

GetStates

Get states for the specified country

The following routes are available for this service:
All Verbs	/api/states/{CountryId}

import 'package:servicestack/servicestack.dart';

class StateModel implements IConvertible
{
    String? StateId;
    String? Name;
    String? ShortName;

    StateModel({this.StateId,this.Name,this.ShortName});
    StateModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        StateId = json['StateId'];
        Name = json['Name'];
        ShortName = json['ShortName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'StateId': StateId,
        'Name': Name,
        'ShortName': ShortName
    };

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

// @ApiResponse(Description="List of states")
class GetStatesResponse implements IConvertible
{
    List<StateModel>? States;
    ResponseStatus? ResponseStatus;

    GetStatesResponse({this.States,this.ResponseStatus});
    GetStatesResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        States = JsonConverters.fromJson(json['States'],'List<StateModel>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

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

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

/**
* Get states for the specified country
*/
// @Api(Description="Get states for the specified country")
class GetStates implements IConvertible
{
    /**
    * Get states for the specified country id
    */
    // @ApiMember(Description="Get states for the specified country id", Name="CountryId")
    String? CountryId;

    GetStates({this.CountryId});
    GetStates.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'StateModel': TypeInfo(TypeOf.Class, create:() => StateModel()),
    'GetStatesResponse': TypeInfo(TypeOf.Class, create:() => GetStatesResponse()),
    'List<StateModel>': TypeInfo(TypeOf.Class, create:() => <StateModel>[]),
    'GetStates': TypeInfo(TypeOf.Class, create:() => GetStates()),
});

Dart GetStates 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.

POST /api/states/{CountryId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CountryId":"00000000-0000-0000-0000-000000000000"}

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

{"States":[{"StateId":"00000000-0000-0000-0000-000000000000","Name":"String","ShortName":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}