BokaMera.API.Host

<back to all web services

CheckSitePathValid

The following routes are available for this service:
GET/companies/checksitepathvalidCheck if company with sitepath is validThis service is used to check if sitepath on company is valid (free and correct).
import 'package:servicestack/servicestack.dart';

class CheckCompanySitePathIsValidResponse implements IConvertible
{
    bool? Valid;
    String? Message;

    CheckCompanySitePathIsValidResponse({this.Valid,this.Message});
    CheckCompanySitePathIsValidResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
class CheckSitePathValid implements IConvertible
{
    /**
    * The sitepath to the company.
    */
    // @ApiMember(Description="The sitepath to the company.")
    String? SitePath;

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

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

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

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

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

Dart CheckSitePathValid 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 /companies/checksitepathvalid HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Valid: False,
	Message: String
}