| 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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>