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}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Get states for the specified country
    */
    @Api(Description="Get states for the specified country")
    public static class GetStates
    {
        /**
        * Get states for the specified country id
        */
        @ApiMember(Description="Get states for the specified country id", Name="CountryId")
        public UUID CountryId = null;
        
        public UUID getCountryId() { return CountryId; }
        public GetStates setCountryId(UUID value) { this.CountryId = value; return this; }
    }

    @ApiResponse(Description="List of states")
    public static class GetStatesResponse
    {
        public ArrayList<StateModel> States = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<StateModel> getStates() { return States; }
        public GetStatesResponse setStates(ArrayList<StateModel> value) { this.States = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetStatesResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class StateModel
    {
        public UUID StateId = null;
        public String Name = null;
        public String ShortName = null;
        
        public UUID getStateId() { return StateId; }
        public StateModel setStateId(UUID value) { this.StateId = value; return this; }
        public String getName() { return Name; }
        public StateModel setName(String value) { this.Name = value; return this; }
        public String getShortName() { return ShortName; }
        public StateModel setShortName(String value) { this.ShortName = value; return this; }
    }

}

Java GetStates DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	States: 
	[
		{
			Name: String,
			ShortName: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}