BokaMera.API.Host

<back to all web services

AddAxemaCodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/codelock/axema/settingsAdd settings for the code lock of the company of the currently logged in userAdd settings for code lock of the company of the currently logged in user.
// @ts-nocheck

export class CodeLockAxemaSettingResponse
{
    public CompanyId: string;
    /** @description The api endpoint of the code lock */
    // @ApiMember(DataType="string", Description="The api endpoint of the code lock")
    public ApiEndpoint: string;

    /** @description The api port for the code lock. */
    // @ApiMember(DataType="string", Description="The api port for the code lock.")
    public ApiPort: number;

    /** @description The username to logon to the code lock. */
    // @ApiMember(DataType="string", Description="The username to logon to the code lock.")
    public Username: string;

    /** @description The password to logon to the code lock. */
    // @ApiMember(DataType="string", Description="The password to logon to the code lock.")
    public Password: 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<CodeLockAxemaSettingResponse>) { (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 AddAxemaCodeLockSetting 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;

    /** @description The api endpoint of the code lock */
    // @ApiMember(DataType="string", Description="The api endpoint of the code lock", IsRequired=true)
    public ApiEndpoint: string;

    /** @description The api port for the code lock. */
    // @ApiMember(DataType="string", Description="The api port for the code lock.", IsRequired=true)
    public ApiPort: string;

    /** @description The username to logon to the code lock. */
    // @ApiMember(DataType="string", Description="The username to logon to the code lock.", IsRequired=true)
    public Username: string;

    /** @description The password to logon to the code lock. */
    // @ApiMember(DataType="string", Description="The password to logon to the code lock.", IsRequired=true)
    public Password: string;

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

TypeScript AddAxemaCodeLockSetting DTOs

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

HTTP + OTHER

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

POST /codelock/axema/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","ApiEndpoint":"String","ApiPort":"String","Username":"String","Password":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ApiEndpoint":"String","ApiPort":0,"Username":"String","Password":"String"}