BokaMera.API.Host

<back to all web services

CodeLockParakeySettingQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/codelock/parakey/settingsGet code lock api settings for the currently logged in userGet code lock api settings for the currently logged in user.

export class CodeLockParakeySettingResponse
{
    public CompanyId: string;
    /** @description The domain id of the code lock. */
    // @ApiMember(DataType="string", Description="The domain id of the code lock.")
    public DomainId: string;

    /** @description The access token of the code lock. */
    // @ApiMember(DataType="string", Description="The access token of the code lock.")
    public AccessToken: string;

    /** @description When settings was created */
    // @ApiMember(DataType="datetime", Description="When settings was created")
    public Created: string;

    /** @description When settings was updated */
    // @ApiMember(DataType="datetime", Description="When settings was updated")
    public Updated: string;

    public constructor(init?: Partial<CodeLockParakeySettingResponse>) { (Object as any).assign(this, init); }
}

// @ValidateRequest(Validator="IsAuthenticated")
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privileges to call this service", StatusCode=403)
export class CodeLockParakeySettingQuery implements ICompany
{
    /** @description 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 CompanyId?: string;

    public constructor(init?: Partial<CodeLockParakeySettingQuery>) { (Object as any).assign(this, init); }
}

TypeScript CodeLockParakeySettingQuery DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /codelock/parakey/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"DomainId":"String","AccessToken":"String"}