| All Verbs | /api/states/{CountryId} |
|---|
export class StateModel
{
public StateId: string;
public Name: string;
public ShortName: string;
public constructor(init?: Partial<StateModel>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="List of states")
export class GetStatesResponse
{
public States: StateModel[];
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<GetStatesResponse>) { (Object as any).assign(this, init); }
}
/** @description Get states for the specified country */
// @Api(Description="Get states for the specified country")
export class GetStates
{
/** @description Get states for the specified country id */
// @ApiMember(Description="Get states for the specified country id", Name="CountryId")
public CountryId: string;
public constructor(init?: Partial<GetStates>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}