Platform API

<back to all web services

GetStates

Get states for the specified country

The following routes are available for this service:
All Verbs/api/states/{CountryId}
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type StateModel() = 
        member val StateId:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val ShortName:String = null with get,set

    [<ApiResponse(Description="List of states")>]
    [<AllowNullLiteral>]
    type GetStatesResponse() = 
        member val States:ResizeArray<StateModel> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Get states for the specified country
    ///</summary>
    [<Api(Description="Get states for the specified country")>]
    [<AllowNullLiteral>]
    type GetStates() = 
        ///<summary>
        ///Get states for the specified country id
        ///</summary>
        [<ApiMember(Description="Get states for the specified country id", Name="CountryId")>]
        member val CountryId:Guid = new Guid() with get,set

F# 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"}}}