BokaMera.API.Host

CommentsSuperAdminUserQuery

**Requires Authentication**
Required role:	superadmin

The following routes are available for this service:
GET	/superadmin/company/{CompanyId}/comments	Get companies comments.

import 'package:servicestack/servicestack.dart';

// @DataContract
abstract class QueryBase
{
    /**
    * Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
    */
    // @DataMember(Order=1)
    int? Skip;

    /**
    * Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
    */
    // @DataMember(Order=2)
    int? Take;

    /**
    * Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
    */
    // @DataMember(Order=3)
    String? OrderBy;

    /**
    * Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
    */
    // @DataMember(Order=4)
    String? OrderByDesc;

    /**
    * Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
    */
    // @DataMember(Order=5)
    String? Include;

    // @DataMember(Order=6)
    String? Fields;

    // @DataMember(Order=7)
    Map<String,String?>? Meta;

    QueryBase({this.Skip,this.Take,this.OrderBy,this.OrderByDesc,this.Include,this.Fields,this.Meta});
    QueryBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Skip = json['Skip'];
        Take = json['Take'];
        OrderBy = json['OrderBy'];
        OrderByDesc = json['OrderByDesc'];
        Include = json['Include'];
        Fields = json['Fields'];
        Meta = JsonConverters.toStringMap(json['Meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Skip': Skip,
        'Take': Take,
        'OrderBy': OrderBy,
        'OrderByDesc': OrderByDesc,
        'Include': Include,
        'Fields': Fields,
        'Meta': Meta
    };

    getTypeName() => "QueryBase";
    TypeContext? context = _ctx;
}

abstract class QueryDb2<From,Into> extends QueryBase
{
    QueryDb2();
    QueryDb2.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() => "QueryDb<$From,$Into>";
    TypeContext? context = _ctx;
}

class BaseModel implements IConvertible
{
    BaseModel();
    BaseModel.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "BaseModel";
    TypeContext? context = _ctx;
}

enum CommentsType
{
    NormalComment,
    CallBackPhoneComment,
    CallBackEmailComment,
    CallBackMeetingBookedComment,
    CallBackNotInterestedComment,
}

class CommentsTypeResponse implements IConvertible
{
    int? Id;
    String? Name;
    String? Description;

    CommentsTypeResponse({this.Id,this.Name,this.Description});
    CommentsTypeResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Name = json['Name'];
        Description = json['Description'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Name': Name,
        'Description': Description
    };

    getTypeName() => "CommentsTypeResponse";
    TypeContext? context = _ctx;
}

class CompanyCommentsResponse implements IConvertible
{
    // @ApiMember()
    String? CompanyId;

    // @ApiMember()
    int? Id;

    // @ApiMember(IsRequired=true)
    String? Comment;

    // @ApiMember(IsRequired=true)
    CommentsType? CommentTypeId;

    // @ApiMember(IsRequired=true)
    CommentsTypeResponse? CommentType;

    /**
    * The updated date
    */
    // @ApiMember(Description="The updated date")
    DateTime? Updated;

    /**
    * The created date
    */
    // @ApiMember(Description="The created date")
    DateTime? Created;

    /**
    * The created by
    */
    // @ApiMember(Description="The created by")
    String? CreatedBy;

    CompanyCommentsResponse({this.CompanyId,this.Id,this.Comment,this.CommentTypeId,this.CommentType,this.Updated,this.Created,this.CreatedBy});
    CompanyCommentsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        Id = json['Id'];
        Comment = json['Comment'];
        CommentTypeId = JsonConverters.fromJson(json['CommentTypeId'],'CommentsType',context!);
        CommentType = JsonConverters.fromJson(json['CommentType'],'CommentsTypeResponse',context!);
        Updated = JsonConverters.fromJson(json['Updated'],'DateTime',context!);
        Created = JsonConverters.fromJson(json['Created'],'DateTime',context!);
        CreatedBy = json['CreatedBy'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'Id': Id,
        'Comment': Comment,
        'CommentTypeId': JsonConverters.toJson(CommentTypeId,'CommentsType',context!),
        'CommentType': JsonConverters.toJson(CommentType,'CommentsTypeResponse',context!),
        'Updated': JsonConverters.toJson(Updated,'DateTime',context!),
        'Created': JsonConverters.toJson(Created,'DateTime',context!),
        'CreatedBy': CreatedBy
    };

    getTypeName() => "CompanyCommentsResponse";
    TypeContext? context = _ctx;
}

class CompanyComment extends BaseModel implements IConvertible
{
    CommentsType? CommentsType;
    // @Required()
    String? CompanyId;

    int? Id;
    int? CommentsTypeId;
    String? Comments;
    String? CreatedBy;
    // @Required()
    DateTime? Created;

    // @Required()
    DateTime? Updated;

    DateTime? ModifiedDate;

    CompanyComment({this.CommentsType,this.CompanyId,this.Id,this.CommentsTypeId,this.Comments,this.CreatedBy,this.Created,this.Updated,this.ModifiedDate});
    CompanyComment.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        CommentsType = JsonConverters.fromJson(json['CommentsType'],'CommentsType',context!);
        CompanyId = json['CompanyId'];
        Id = json['Id'];
        CommentsTypeId = json['CommentsTypeId'];
        Comments = json['Comments'];
        CreatedBy = json['CreatedBy'];
        Created = JsonConverters.fromJson(json['Created'],'DateTime',context!);
        Updated = JsonConverters.fromJson(json['Updated'],'DateTime',context!);
        ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'CommentsType': JsonConverters.toJson(CommentsType,'CommentsType',context!),
        'CompanyId': CompanyId,
        'Id': Id,
        'CommentsTypeId': CommentsTypeId,
        'Comments': Comments,
        'CreatedBy': CreatedBy,
        'Created': JsonConverters.toJson(Created,'DateTime',context!),
        'Updated': JsonConverters.toJson(Updated,'DateTime',context!),
        'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!)
    });

    getTypeName() => "CompanyComment";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="", StatusCode=400)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
class CommentsSuperAdminUserQuery extends QueryDb2<CompanyComment,CompanyCommentsResponse> implements IConvertible
{
    /**
    * Enter the companyId for the customer
    */
    // @ApiMember(Description="Enter the companyId for the customer", IsRequired=true, ParameterType="query")
    String? CompanyId;

    // @ApiMember()
    int? CommentsTypeId;

    CommentsSuperAdminUserQuery({this.CompanyId,this.CommentsTypeId});
    CommentsSuperAdminUserQuery.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        CompanyId = json['CompanyId'];
        CommentsTypeId = json['CommentsTypeId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'CompanyId': CompanyId,
        'CommentsTypeId': CommentsTypeId
    });

    getTypeName() => "CommentsSuperAdminUserQuery";
    TypeContext? context = _ctx;
}

class CommentsType extends BaseModel implements IConvertible
{
    int? Id;
    String? Name;
    String? Description;
    DateTime? ModifiedDate;

    CommentsType({this.Id,this.Name,this.Description,this.ModifiedDate});
    CommentsType.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Id = json['Id'];
        Name = json['Name'];
        Description = json['Description'];
        ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Id': Id,
        'Name': Name,
        'Description': Description,
        'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!)
    });

    getTypeName() => "CommentsType";
    TypeContext? context = _ctx;
}

class AccessKeyTypeResponse implements IConvertible
{
    int? Id;
    String? KeyType;
    String? Description;

    AccessKeyTypeResponse({this.Id,this.KeyType,this.Description});
    AccessKeyTypeResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        KeyType = json['KeyType'];
        Description = json['Description'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'KeyType': KeyType,
        'Description': Description
    };

    getTypeName() => "AccessKeyTypeResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class QueryResponse<AccessKeyTypeResponse> implements IConvertible
{
    // @DataMember(Order=1)
    int? Offset;

    // @DataMember(Order=2)
    int? Total;

    // @DataMember(Order=3)
    List<AccessKeyTypeResponse>? Results;

    // @DataMember(Order=4)
    Map<String,String?>? Meta;

    // @DataMember(Order=5)
    ResponseStatus? ResponseStatus;

    QueryResponse({this.Offset,this.Total,this.Results,this.Meta,this.ResponseStatus});
    QueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Offset = json['Offset'];
        Total = json['Total'];
        Results = JsonConverters.fromJson(json['Results'],'List<${runtimeGenericTypeDefs(this,[0]).join(",")}>',context!);
        Meta = JsonConverters.toStringMap(json['Meta']);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Offset': Offset,
        'Total': Total,
        'Results': JsonConverters.toJson(Results,'List<AccessKeyTypeResponse>',context!),
        'Meta': Meta,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "QueryResponse<$AccessKeyTypeResponse>";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
    'BaseModel': TypeInfo(TypeOf.Class, create:() => BaseModel()),
    'CommentsType': TypeInfo(TypeOf.Enum, enumValues:CommentsType.values),
    'CommentsTypeResponse': TypeInfo(TypeOf.Class, create:() => CommentsTypeResponse()),
    'CompanyCommentsResponse': TypeInfo(TypeOf.Class, create:() => CompanyCommentsResponse()),
    'CompanyComment': TypeInfo(TypeOf.Class, create:() => CompanyComment()),
    'CommentsSuperAdminUserQuery': TypeInfo(TypeOf.Class, create:() => CommentsSuperAdminUserQuery()),
    'List<CompanyCommentsResponse>': TypeInfo(TypeOf.Class, create:() => <CompanyCommentsResponse>[]),
    'AccessKeyTypeResponse': TypeInfo(TypeOf.Class, create:() => AccessKeyTypeResponse()),
    'QueryResponse<AccessKeyTypeResponse>': TypeInfo(TypeOf.Class, create:() => QueryResponse<AccessKeyTypeResponse>()),
});

Dart CommentsSuperAdminUserQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /superadmin/company/{CompanyId}/comments HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":0,"Comment":"String","CommentTypeId":"NormalComment","CommentType":{"Id":0,"Name":"String","Description":"String"},"CreatedBy":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}