Platform API

GetStates

Get states for the specified country

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

"use strict";
export class StateModel {
    /** @param {{StateId?:string,Name?:string,ShortName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StateId;
    /** @type {string} */
    Name;
    /** @type {string} */
    ShortName;
}
export class GetStatesResponse {
    /** @param {{States?:StateModel[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {StateModel[]} */
    States;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetStates {
    /** @param {{CountryId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Get states for the specified country id */
    CountryId;
}

JavaScript GetStates DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}