| All Verbs | /api/datalists/ |
|---|
import 'package:servicestack/servicestack.dart';
class ListItemModel implements IConvertible
{
String? ListItemId;
String? Name;
String? Description;
String? ShortName;
bool? IsDefault;
int? Order;
String? ListItemTrafficLightId;
String? PrimaryListItemImageId;
String? PrimaryListItemImageUrl;
String? PrimaryImageThumbnailUrl;
String? OwnerContactId;
String? RecordStatus;
ListItemModel({this.ListItemId,this.Name,this.Description,this.ShortName,this.IsDefault,this.Order,this.ListItemTrafficLightId,this.PrimaryListItemImageId,this.PrimaryListItemImageUrl,this.PrimaryImageThumbnailUrl,this.OwnerContactId,this.RecordStatus});
ListItemModel.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ListItemId = json['ListItemId'];
Name = json['Name'];
Description = json['Description'];
ShortName = json['ShortName'];
IsDefault = json['IsDefault'];
Order = json['Order'];
ListItemTrafficLightId = json['ListItemTrafficLightId'];
PrimaryListItemImageId = json['PrimaryListItemImageId'];
PrimaryListItemImageUrl = json['PrimaryListItemImageUrl'];
PrimaryImageThumbnailUrl = json['PrimaryImageThumbnailUrl'];
OwnerContactId = json['OwnerContactId'];
RecordStatus = json['RecordStatus'];
return this;
}
Map<String, dynamic> toJson() => {
'ListItemId': ListItemId,
'Name': Name,
'Description': Description,
'ShortName': ShortName,
'IsDefault': IsDefault,
'Order': Order,
'ListItemTrafficLightId': ListItemTrafficLightId,
'PrimaryListItemImageId': PrimaryListItemImageId,
'PrimaryListItemImageUrl': PrimaryListItemImageUrl,
'PrimaryImageThumbnailUrl': PrimaryImageThumbnailUrl,
'OwnerContactId': OwnerContactId,
'RecordStatus': RecordStatus
};
getTypeName() => "ListItemModel";
TypeContext? context = _ctx;
}
class ListModel implements IConvertible
{
String? ListId;
String? Name;
String? Description;
String? ShortName;
String? OwnerContactId;
bool? IsStandard;
String? RecordStatus;
String? DefaultListItemId;
String? DefaultListItemName;
bool? HasImageForListItem;
bool? HasTrafficLightForListItem;
List<ListItemModel>? ListItems;
bool? PermissionEdit;
bool? PermissionAdd;
bool? PermissionDelete;
ListModel({this.ListId,this.Name,this.Description,this.ShortName,this.OwnerContactId,this.IsStandard,this.RecordStatus,this.DefaultListItemId,this.DefaultListItemName,this.HasImageForListItem,this.HasTrafficLightForListItem,this.ListItems,this.PermissionEdit,this.PermissionAdd,this.PermissionDelete});
ListModel.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ListId = json['ListId'];
Name = json['Name'];
Description = json['Description'];
ShortName = json['ShortName'];
OwnerContactId = json['OwnerContactId'];
IsStandard = json['IsStandard'];
RecordStatus = json['RecordStatus'];
DefaultListItemId = json['DefaultListItemId'];
DefaultListItemName = json['DefaultListItemName'];
HasImageForListItem = json['HasImageForListItem'];
HasTrafficLightForListItem = json['HasTrafficLightForListItem'];
ListItems = JsonConverters.fromJson(json['ListItems'],'List<ListItemModel>',context!);
PermissionEdit = json['PermissionEdit'];
PermissionAdd = json['PermissionAdd'];
PermissionDelete = json['PermissionDelete'];
return this;
}
Map<String, dynamic> toJson() => {
'ListId': ListId,
'Name': Name,
'Description': Description,
'ShortName': ShortName,
'OwnerContactId': OwnerContactId,
'IsStandard': IsStandard,
'RecordStatus': RecordStatus,
'DefaultListItemId': DefaultListItemId,
'DefaultListItemName': DefaultListItemName,
'HasImageForListItem': HasImageForListItem,
'HasTrafficLightForListItem': HasTrafficLightForListItem,
'ListItems': JsonConverters.toJson(ListItems,'List<ListItemModel>',context!),
'PermissionEdit': PermissionEdit,
'PermissionAdd': PermissionAdd,
'PermissionDelete': PermissionDelete
};
getTypeName() => "ListModel";
TypeContext? context = _ctx;
}
// @ApiResponse(Description="Custom data lists for a licensee, as well as standard data lists")
class GetDataListsResponse implements IConvertible
{
List<ListModel>? Lists;
ResponseStatus? ResponseStatus;
GetDataListsResponse({this.Lists,this.ResponseStatus});
GetDataListsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Lists = JsonConverters.fromJson(json['Lists'],'List<ListModel>',context!);
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Lists': JsonConverters.toJson(Lists,'List<ListModel>',context!),
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "GetDataListsResponse";
TypeContext? context = _ctx;
}
/**
* Get custom data lists for a licensee, as well as standard data lists
*/
// @Api(Description="Get custom data lists for a licensee, as well as standard data lists")
class GetDataLists implements IConvertible
{
/**
* Licensee requested Custom data lists belong to.
*/
// @ApiMember(DataType="Guid?", Description="Licensee requested Custom data lists belong to.", Name="LicenseeId", ParameterType="query")
String? LicenseeId;
/**
* Specific text to search for.
*/
// @ApiMember(DataType="string", Description="Specific text to search for.", Name="SearchText", ParameterType="query")
String? SearchText;
GetDataLists({this.LicenseeId,this.SearchText});
GetDataLists.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
LicenseeId = json['LicenseeId'];
SearchText = json['SearchText'];
return this;
}
Map<String, dynamic> toJson() => {
'LicenseeId': LicenseeId,
'SearchText': SearchText
};
getTypeName() => "GetDataLists";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
'ListItemModel': TypeInfo(TypeOf.Class, create:() => ListItemModel()),
'ListModel': TypeInfo(TypeOf.Class, create:() => ListModel()),
'List<ListItemModel>': TypeInfo(TypeOf.Class, create:() => <ListItemModel>[]),
'GetDataListsResponse': TypeInfo(TypeOf.Class, create:() => GetDataListsResponse()),
'List<ListModel>': TypeInfo(TypeOf.Class, create:() => <ListModel>[]),
'GetDataLists': TypeInfo(TypeOf.Class, create:() => GetDataLists()),
});
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/datalists/ HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetDataLists 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>
<SearchText>String</SearchText>
</GetDataLists>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetDataListsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<Lists xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:ListModel>
<d2p1:DefaultListItemId>00000000-0000-0000-0000-000000000000</d2p1:DefaultListItemId>
<d2p1:DefaultListItemName>String</d2p1:DefaultListItemName>
<d2p1:Description>String</d2p1:Description>
<d2p1:HasImageForListItem>false</d2p1:HasImageForListItem>
<d2p1:HasTrafficLightForListItem>false</d2p1:HasTrafficLightForListItem>
<d2p1:IsStandard>false</d2p1:IsStandard>
<d2p1:ListId>00000000-0000-0000-0000-000000000000</d2p1:ListId>
<d2p1:ListItems>
<d2p1:ListItemModel>
<d2p1:Description>String</d2p1:Description>
<d2p1:IsDefault>false</d2p1:IsDefault>
<d2p1:ListItemId>00000000-0000-0000-0000-000000000000</d2p1:ListItemId>
<d2p1:ListItemTrafficLightId>00000000-0000-0000-0000-000000000000</d2p1:ListItemTrafficLightId>
<d2p1:Name>String</d2p1:Name>
<d2p1:Order>0</d2p1:Order>
<d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
<d2p1:PrimaryImageThumbnailUrl>String</d2p1:PrimaryImageThumbnailUrl>
<d2p1:PrimaryListItemImageId>00000000-0000-0000-0000-000000000000</d2p1:PrimaryListItemImageId>
<d2p1:PrimaryListItemImageUrl>String</d2p1:PrimaryListItemImageUrl>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:ShortName>String</d2p1:ShortName>
</d2p1:ListItemModel>
</d2p1:ListItems>
<d2p1:Name>String</d2p1:Name>
<d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
<d2p1:PermissionAdd>false</d2p1:PermissionAdd>
<d2p1:PermissionDelete>false</d2p1:PermissionDelete>
<d2p1:PermissionEdit>false</d2p1:PermissionEdit>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:ShortName>String</d2p1:ShortName>
</d2p1:ListModel>
</Lists>
<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>
</GetDataListsResponse>