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

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

<GetStates xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <CountryId>00000000-0000-0000-0000-000000000000</CountryId>
</GetStates>

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

<GetStatesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <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>
  <States xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:StateModel>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:ShortName>String</d2p1:ShortName>
      <d2p1:StateId>00000000-0000-0000-0000-000000000000</d2p1:StateId>
    </d2p1:StateModel>
  </States>
</GetStatesResponse>