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