Platform API

GetStates

Get states for the specified country

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

import Foundation
import ServiceStack

/**
* Get states for the specified country
*/
// @Api(Description="Get states for the specified country")
public class GetStates : Codable
{
    /**
    * Get states for the specified country id
    */
    // @ApiMember(Description="Get states for the specified country id", Name="CountryId")
    public var countryId:String

    required public init(){}
}

// @ApiResponse(Description="List of states")
public class GetStatesResponse : Codable
{
    public var states:[StateModel]
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class StateModel : Codable
{
    public var stateId:String
    public var name:String
    public var shortName:String

    required public init(){}
}

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