| All Verbs | /api/suites |
|---|
import 'package:servicestack/servicestack.dart';
class ListItemFilter implements IConvertible
{
String? ListItemFilterId;
String? FilterName;
String? ListId;
String? ListItemId;
bool? ListItemIsInFilter;
ListItemFilter({this.ListItemFilterId,this.FilterName,this.ListId,this.ListItemId,this.ListItemIsInFilter});
ListItemFilter.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ListItemFilterId = json['ListItemFilterId'];
FilterName = json['FilterName'];
ListId = json['ListId'];
ListItemId = json['ListItemId'];
ListItemIsInFilter = json['ListItemIsInFilter'];
return this;
}
Map<String, dynamic> toJson() => {
'ListItemFilterId': ListItemFilterId,
'FilterName': FilterName,
'ListId': ListId,
'ListItemId': ListItemId,
'ListItemIsInFilter': ListItemIsInFilter
};
getTypeName() => "ListItemFilter";
TypeContext? context = _ctx;
}
class ListDataItem implements IConvertible
{
String? Id;
String? Name;
String? Description;
String? ShortName;
String? DefaultName;
bool? IsDefault;
int? Order;
String? ListItemTrafficLightId;
String? PrimaryListItemImageId;
String? PrimaryListItemImageUrl;
String? PrimaryImageThumbnailUrl;
String? OwnerContactId;
String? RecordStatus;
String? Tags;
String? ListId;
bool? MarkAsChecked;
String? RelatedObjectId;
bool? CanEdit;
bool? IsOwner;
List<dynamic>? ExtraValues;
List<ListItemFilter>? ListItemFilters;
ListDataItem({this.Id,this.Name,this.Description,this.ShortName,this.DefaultName,this.IsDefault,this.Order,this.ListItemTrafficLightId,this.PrimaryListItemImageId,this.PrimaryListItemImageUrl,this.PrimaryImageThumbnailUrl,this.OwnerContactId,this.RecordStatus,this.Tags,this.ListId,this.MarkAsChecked,this.RelatedObjectId,this.CanEdit,this.IsOwner,this.ExtraValues,this.ListItemFilters});
ListDataItem.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
Name = json['Name'];
Description = json['Description'];
ShortName = json['ShortName'];
DefaultName = json['DefaultName'];
IsDefault = json['IsDefault'];
Order = json['Order'];
ListItemTrafficLightId = json['ListItemTrafficLightId'];
PrimaryListItemImageId = json['PrimaryListItemImageId'];
PrimaryListItemImageUrl = json['PrimaryListItemImageUrl'];
PrimaryImageThumbnailUrl = json['PrimaryImageThumbnailUrl'];
OwnerContactId = json['OwnerContactId'];
RecordStatus = json['RecordStatus'];
Tags = json['Tags'];
ListId = json['ListId'];
MarkAsChecked = json['MarkAsChecked'];
RelatedObjectId = json['RelatedObjectId'];
CanEdit = json['CanEdit'];
IsOwner = json['IsOwner'];
ExtraValues = JsonConverters.fromJson(json['ExtraValues'],'List<dynamic>',context!);
ListItemFilters = JsonConverters.fromJson(json['ListItemFilters'],'List<ListItemFilter>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'Name': Name,
'Description': Description,
'ShortName': ShortName,
'DefaultName': DefaultName,
'IsDefault': IsDefault,
'Order': Order,
'ListItemTrafficLightId': ListItemTrafficLightId,
'PrimaryListItemImageId': PrimaryListItemImageId,
'PrimaryListItemImageUrl': PrimaryListItemImageUrl,
'PrimaryImageThumbnailUrl': PrimaryImageThumbnailUrl,
'OwnerContactId': OwnerContactId,
'RecordStatus': RecordStatus,
'Tags': Tags,
'ListId': ListId,
'MarkAsChecked': MarkAsChecked,
'RelatedObjectId': RelatedObjectId,
'CanEdit': CanEdit,
'IsOwner': IsOwner,
'ExtraValues': JsonConverters.toJson(ExtraValues,'List<dynamic>',context!),
'ListItemFilters': JsonConverters.toJson(ListItemFilters,'List<ListItemFilter>',context!)
};
getTypeName() => "ListDataItem";
TypeContext? context = _ctx;
}
// @ApiResponse(Description="List of suites")
class GetSuitesResponse implements IConvertible
{
List<ListDataItem>? Suites;
ResponseStatus? ResponseStatus;
GetSuitesResponse({this.Suites,this.ResponseStatus});
GetSuitesResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Suites = JsonConverters.fromJson(json['Suites'],'List<ListDataItem>',context!);
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Suites': JsonConverters.toJson(Suites,'List<ListDataItem>',context!),
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "GetSuitesResponse";
TypeContext? context = _ctx;
}
/**
* Get all suites
*/
// @Api(Description="Get all suites")
class GetSuites implements IConvertible
{
/**
* Licensee Contact Id to return suites for. This will only return the suites that the contact has licenses for. If not set, all suites are returned
*/
// @ApiMember(Description="Licensee Contact Id to return suites for. This will only return the suites that the contact has licenses for. If not set, all suites are returned", Name="LicenseeId")
String? LicenseeId;
GetSuites({this.LicenseeId});
GetSuites.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
LicenseeId = json['LicenseeId'];
return this;
}
Map<String, dynamic> toJson() => {
'LicenseeId': LicenseeId
};
getTypeName() => "GetSuites";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
'ListItemFilter': TypeInfo(TypeOf.Class, create:() => ListItemFilter()),
'ListDataItem': TypeInfo(TypeOf.Class, create:() => ListDataItem()),
'List<dynamic>': TypeInfo(TypeOf.Class, create:() => <dynamic>[]),
'List<ListItemFilter>': TypeInfo(TypeOf.Class, create:() => <ListItemFilter>[]),
'GetSuitesResponse': TypeInfo(TypeOf.Class, create:() => GetSuitesResponse()),
'List<ListDataItem>': TypeInfo(TypeOf.Class, create:() => <ListDataItem>[]),
'GetSuites': TypeInfo(TypeOf.Class, create:() => GetSuites()),
});
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/suites HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetSuites xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<LicenseeId>00000000-0000-0000-0000-000000000000</LicenseeId>
</GetSuites>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetSuitesResponse 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>
<Suites xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
<d2p1:ListDataItem>
<d2p1:_x003C_CanEdit_x003E_k__BackingField>false</d2p1:_x003C_CanEdit_x003E_k__BackingField>
<d2p1:_x003C_DefaultName_x003E_k__BackingField>String</d2p1:_x003C_DefaultName_x003E_k__BackingField>
<d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
<d2p1:_x003C_ExtraValues_x003E_k__BackingField xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:anyType />
</d2p1:_x003C_ExtraValues_x003E_k__BackingField>
<d2p1:_x003C_Id_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_Id_x003E_k__BackingField>
<d2p1:_x003C_IsDefault_x003E_k__BackingField>false</d2p1:_x003C_IsDefault_x003E_k__BackingField>
<d2p1:_x003C_IsOwner_x003E_k__BackingField>false</d2p1:_x003C_IsOwner_x003E_k__BackingField>
<d2p1:_x003C_ListId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ListId_x003E_k__BackingField>
<d2p1:_x003C_ListItemFilters_x003E_k__BackingField>
<d2p1:ListItemFilter>
<d2p1:_x003C_FilterName_x003E_k__BackingField>String</d2p1:_x003C_FilterName_x003E_k__BackingField>
<d2p1:_x003C_ListId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ListId_x003E_k__BackingField>
<d2p1:_x003C_ListItemFilterId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ListItemFilterId_x003E_k__BackingField>
<d2p1:_x003C_ListItemId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ListItemId_x003E_k__BackingField>
<d2p1:_x003C_ListItemIsInFilter_x003E_k__BackingField>false</d2p1:_x003C_ListItemIsInFilter_x003E_k__BackingField>
</d2p1:ListItemFilter>
</d2p1:_x003C_ListItemFilters_x003E_k__BackingField>
<d2p1:_x003C_ListItemTrafficLightId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ListItemTrafficLightId_x003E_k__BackingField>
<d2p1:_x003C_MarkAsChecked_x003E_k__BackingField>false</d2p1:_x003C_MarkAsChecked_x003E_k__BackingField>
<d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
<d2p1:_x003C_Order_x003E_k__BackingField>0</d2p1:_x003C_Order_x003E_k__BackingField>
<d2p1:_x003C_OwnerContactId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_OwnerContactId_x003E_k__BackingField>
<d2p1:_x003C_PrimaryImageThumbnailUrl_x003E_k__BackingField>String</d2p1:_x003C_PrimaryImageThumbnailUrl_x003E_k__BackingField>
<d2p1:_x003C_PrimaryListItemImageId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_PrimaryListItemImageId_x003E_k__BackingField>
<d2p1:_x003C_PrimaryListItemImageUrl_x003E_k__BackingField>String</d2p1:_x003C_PrimaryListItemImageUrl_x003E_k__BackingField>
<d2p1:_x003C_RecordStatus_x003E_k__BackingField>String</d2p1:_x003C_RecordStatus_x003E_k__BackingField>
<d2p1:_x003C_RelatedObjectId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_RelatedObjectId_x003E_k__BackingField>
<d2p1:_x003C_ShortName_x003E_k__BackingField>String</d2p1:_x003C_ShortName_x003E_k__BackingField>
<d2p1:_x003C_Tags_x003E_k__BackingField>String</d2p1:_x003C_Tags_x003E_k__BackingField>
</d2p1:ListDataItem>
</Suites>
</GetSuitesResponse>