| GET | /organisations/all |
|---|
import 'package:servicestack/servicestack.dart';
abstract class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
String? embed;
GetOperationUnTenanted({this.embed});
GetOperationUnTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
embed = json['embed'];
return this;
}
Map<String, dynamic> toJson() => {
'embed': embed
};
getTypeName() => "GetOperationUnTenanted<$TResponse>";
TypeContext? context = _ctx;
}
abstract class SearchOperationUnTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements IHasSearchOptions
{
String? distinct;
int? limit;
int? offset;
String? sort;
String? filter;
SearchOperationUnTenanted({this.distinct,this.limit,this.offset,this.sort,this.filter});
SearchOperationUnTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
distinct = json['distinct'];
limit = json['limit'];
offset = json['offset'];
sort = json['sort'];
filter = json['filter'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'distinct': distinct,
'limit': limit,
'offset': offset,
'sort': sort,
'filter': filter
});
getTypeName() => "SearchOperationUnTenanted<$TResponse>";
TypeContext? context = _ctx;
}
enum SortDirection
{
Ascending,
Descending,
}
class Sorting implements IConvertible
{
String? by;
SortDirection? direction;
Sorting({this.by,this.direction});
Sorting.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
by = json['by'];
direction = JsonConverters.fromJson(json['direction'],'SortDirection',context!);
return this;
}
Map<String, dynamic> toJson() => {
'by': by,
'direction': JsonConverters.toJson(direction,'SortDirection',context!)
};
getTypeName() => "Sorting";
TypeContext? context = _ctx;
}
class Filtering implements IConvertible
{
List<String>? fields;
Filtering({this.fields});
Filtering.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
fields = JsonConverters.fromJson(json['fields'],'List<String>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'fields': JsonConverters.toJson(fields,'List<String>',context!)
};
getTypeName() => "Filtering";
TypeContext? context = _ctx;
}
class SearchMetadata implements IConvertible
{
int? total;
int? limit;
int? offset;
Sorting? sort;
Filtering? filter;
SearchMetadata({this.total,this.limit,this.offset,this.sort,this.filter});
SearchMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
total = json['total'];
limit = json['limit'];
offset = json['offset'];
sort = JsonConverters.fromJson(json['sort'],'Sorting',context!);
filter = JsonConverters.fromJson(json['filter'],'Filtering',context!);
return this;
}
Map<String, dynamic> toJson() => {
'total': total,
'limit': limit,
'offset': offset,
'sort': JsonConverters.toJson(sort,'Sorting',context!),
'filter': JsonConverters.toJson(filter,'Filtering',context!)
};
getTypeName() => "SearchMetadata";
TypeContext? context = _ctx;
}
abstract class SearchOperationResponse
{
SearchMetadata? metadata;
SearchOperationResponse({this.metadata});
SearchOperationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
metadata = JsonConverters.fromJson(json['metadata'],'SearchMetadata',context!);
return this;
}
Map<String, dynamic> toJson() => {
'metadata': JsonConverters.toJson(metadata,'SearchMetadata',context!)
};
getTypeName() => "SearchOperationResponse";
TypeContext? context = _ctx;
}
class Organisation implements IIdentifiableResource, IConvertible
{
String? displayName;
List<String>? owners;
bool? isDefault;
String? id;
bool? forceTwoFactor;
Organisation({this.displayName,this.owners,this.isDefault,this.id,this.forceTwoFactor});
Organisation.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
displayName = json['displayName'];
owners = JsonConverters.fromJson(json['owners'],'List<String>',context!);
isDefault = json['isDefault'];
id = json['id'];
forceTwoFactor = json['forceTwoFactor'];
return this;
}
Map<String, dynamic> toJson() => {
'displayName': displayName,
'owners': JsonConverters.toJson(owners,'List<String>',context!),
'isDefault': isDefault,
'id': id,
'forceTwoFactor': forceTwoFactor
};
getTypeName() => "Organisation";
TypeContext? context = _ctx;
}
class ListOrganisationsResponse extends SearchOperationResponse implements IConvertible
{
ResponseStatus? responseStatus;
List<Organisation>? organisations;
ListOrganisationsResponse({this.responseStatus,this.organisations});
ListOrganisationsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
organisations = JsonConverters.fromJson(json['organisations'],'List<Organisation>',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
'organisations': JsonConverters.toJson(organisations,'List<Organisation>',context!)
});
getTypeName() => "ListOrganisationsResponse";
TypeContext? context = _ctx;
}
class ListOrganisationsRequest extends SearchOperationUnTenanted<ListOrganisationsResponse> implements IConvertible
{
ListOrganisationsRequest();
ListOrganisationsRequest.fromJson(Map<String, dynamic> json) : super.fromJson(json);
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
return this;
}
Map<String, dynamic> toJson() => super.toJson();
getTypeName() => "ListOrganisationsRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
'GetOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
'SearchOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
'SortDirection': TypeInfo(TypeOf.Enum, enumValues:SortDirection.values),
'Sorting': TypeInfo(TypeOf.Class, create:() => Sorting()),
'Filtering': TypeInfo(TypeOf.Class, create:() => Filtering()),
'SearchMetadata': TypeInfo(TypeOf.Class, create:() => SearchMetadata()),
'SearchOperationResponse': TypeInfo(TypeOf.AbstractClass),
'Organisation': TypeInfo(TypeOf.Class, create:() => Organisation()),
'ListOrganisationsResponse': TypeInfo(TypeOf.Class, create:() => ListOrganisationsResponse()),
'List<Organisation>': TypeInfo(TypeOf.Class, create:() => <Organisation>[]),
'ListOrganisationsRequest': TypeInfo(TypeOf.Class, create:() => ListOrganisationsRequest()),
});
Dart ListOrganisationsRequest DTOs
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.
GET /organisations/all HTTP/1.1 Host: foundrystage-api-app.azurewebsites.net Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
organisations:
[
{
displayName: String,
owners:
[
String
],
isDefault: False,
id: String,
forceTwoFactor: False
}
],
metadata:
{
total: 0,
limit: 0,
offset: 0,
sort:
{
by: String,
direction: Ascending
},
filter:
{
fields:
[
String
]
}
}
}