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 Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
public class CheckSitePathValid : Codable
{
    /**
    * The sitepath to the company.
    */
    // @ApiMember(Description="The sitepath to the company.")
    public var sitePath:String

    required public init(){}
}

public class CheckCompanySitePathIsValidResponse : Codable
{
    public var valid:Bool
    public var message:String

    required public init(){}
}


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