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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @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")
    public static class SettingsErrorCheck implements ICompany
    {
        /**
        * 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.")
        public UUID CompanyId = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public SettingsErrorCheck setCompanyId(UUID value) { this.CompanyId = value; return this; }
    }

    public static class SettingsErrorCheckResponse
    {
        /**
        * The errormessage
        */
        @ApiMember(DataType="string", Description="The errormessage")
        public String ErrorMessage = null;
        
        public String getErrorMessage() { return ErrorMessage; }
        public SettingsErrorCheckResponse setErrorMessage(String value) { this.ErrorMessage = value; return this; }
    }

}

Java SettingsErrorCheck DTOs

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

HTTP + CSV

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: testapi.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ErrorMessage":"String"}