| All Verbs | /api/suburbs |
|---|
import 'package:servicestack/servicestack.dart';
class SuburbModel implements IConvertible
{
String? SuburbId;
String? Name;
String? StateId;
String? StateName;
String? PostCode;
String? CountryId;
String? CountryName;
SuburbModel({this.SuburbId,this.Name,this.StateId,this.StateName,this.PostCode,this.CountryId,this.CountryName});
SuburbModel.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
SuburbId = json['SuburbId'];
Name = json['Name'];
StateId = json['StateId'];
StateName = json['StateName'];
PostCode = json['PostCode'];
CountryId = json['CountryId'];
CountryName = json['CountryName'];
return this;
}
Map<String, dynamic> toJson() => {
'SuburbId': SuburbId,
'Name': Name,
'StateId': StateId,
'StateName': StateName,
'PostCode': PostCode,
'CountryId': CountryId,
'CountryName': CountryName
};
getTypeName() => "SuburbModel";
TypeContext? context = _ctx;
}
// @ApiResponse(Description="List of suburbs matching the criteria")
class GetSuburbsResponse implements IConvertible
{
List<SuburbModel>? Suburbs;
ResponseStatus? ResponseStatus;
GetSuburbsResponse({this.Suburbs,this.ResponseStatus});
GetSuburbsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Suburbs = JsonConverters.fromJson(json['Suburbs'],'List<SuburbModel>',context!);
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Suburbs': JsonConverters.toJson(Suburbs,'List<SuburbModel>',context!),
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "GetSuburbsResponse";
TypeContext? context = _ctx;
}
/**
* Get all suburbs for the specified country, state and/or postcode
*/
// @Api(Description="Get all suburbs for the specified country, state and/or postcode")
class GetSuburbs implements IConvertible
{
/**
* Get suburbs matching the specified search text criteria.
*/
// @ApiMember(Description="Get suburbs matching the specified search text criteria.", Name="SearchText")
String? SearchText;
/**
* State to get suburbs for
*/
// @ApiMember(Description="State to get suburbs for", Name="StateName")
String? StateName;
/**
* Postcode to get suburbs for
*/
// @ApiMember(Description="Postcode to get suburbs for", Name="Postcode")
String? PostCode;
/**
* Country to get suburbs for
*/
// @ApiMember(Description="Country to get suburbs for", Name="CountryId")
String? CountryId;
/**
* Country to get suburbs for
*/
// @ApiMember(Description="Country to get suburbs for", Name="CountryName")
String? CountryName;
GetSuburbs({this.SearchText,this.StateName,this.PostCode,this.CountryId,this.CountryName});
GetSuburbs.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
SearchText = json['SearchText'];
StateName = json['StateName'];
PostCode = json['PostCode'];
CountryId = json['CountryId'];
CountryName = json['CountryName'];
return this;
}
Map<String, dynamic> toJson() => {
'SearchText': SearchText,
'StateName': StateName,
'PostCode': PostCode,
'CountryId': CountryId,
'CountryName': CountryName
};
getTypeName() => "GetSuburbs";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
'SuburbModel': TypeInfo(TypeOf.Class, create:() => SuburbModel()),
'GetSuburbsResponse': TypeInfo(TypeOf.Class, create:() => GetSuburbsResponse()),
'List<SuburbModel>': TypeInfo(TypeOf.Class, create:() => <SuburbModel>[]),
'GetSuburbs': TypeInfo(TypeOf.Class, create:() => GetSuburbs()),
});
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/suburbs HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetSuburbs 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>
<CountryName>String</CountryName>
<PostCode>String</PostCode>
<SearchText>String</SearchText>
<StateName>String</StateName>
</GetSuburbs>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetSuburbsResponse 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>
<Suburbs xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:SuburbModel>
<d2p1:CountryId>00000000-0000-0000-0000-000000000000</d2p1:CountryId>
<d2p1:CountryName>String</d2p1:CountryName>
<d2p1:Name>String</d2p1:Name>
<d2p1:PostCode>String</d2p1:PostCode>
<d2p1:StateId>00000000-0000-0000-0000-000000000000</d2p1:StateId>
<d2p1:StateName>String</d2p1:StateName>
<d2p1:SuburbId>00000000-0000-0000-0000-000000000000</d2p1:SuburbId>
</d2p1:SuburbModel>
</Suburbs>
</GetSuburbsResponse>