BokaMera.API.Host

<back to all web services

SettingsErrorCheck

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/settings/errorcheckWill check your settings and return any errors.Will check if any errors in your settings and return them with suggestions how to fix.
import 'package:servicestack/servicestack.dart';

class SettingsErrorCheckResponse implements IConvertible
{
    /**
    * The errormessage
    */
    // @ApiMember(DataType="string", Description="The errormessage")
    String? ErrorMessage;

    SettingsErrorCheckResponse({this.ErrorMessage});
    SettingsErrorCheckResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'ErrorMessage': ErrorMessage
    };

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

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)
// @ValidateRequest(Validator="IsAuthenticated")
class SettingsErrorCheck implements ICompany, IConvertible
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    String? CompanyId;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
    'SettingsErrorCheckResponse': TypeInfo(TypeOf.Class, create:() => SettingsErrorCheckResponse()),
    'SettingsErrorCheck': TypeInfo(TypeOf.Class, create:() => SettingsErrorCheck()),
});

Dart SettingsErrorCheck DTOs

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

HTTP + JSV

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

GET /settings/errorcheck HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ErrorMessage: String
}