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).
"use strict";
export class CheckCompanySitePathIsValidResponse {
    /** @param {{Valid?:boolean,Message?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Valid;
    /** @type {string} */
    Message;
}
export class CheckSitePathValid {
    /** @param {{SitePath?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The sitepath to the company. */
    SitePath;
}

JavaScript 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
}