BokaMera.API.Host

AddSiedleCodeLockSetting

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
POST	/codelock/siedle/settings	Add settings for the code lock of the company of the currently logged in user	Add settings for code lock of the company of the currently logged in user.

// @ts-nocheck

export enum SiedleIntegrationType
{
    LocalApi = 1,
    CloudBasedApi = 2,
}

export class CodeLockSiedleSettingResponse
{
    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 device id to the code lock. */
    // @ApiMember(DataType="string", Description="The device id to the code lock.")
    public DeviceId: string;

    /** @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 The integration type to the code lock. 1 = Local Api,  2 = Cloud Based Api */
    // @ApiMember(DataType="string", Description="The integration type to the code lock. 1 = Local Api,  2 = Cloud Based Api")
    public IntegrationType: SiedleIntegrationType;

    /** @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<CodeLockSiedleSettingResponse>) { (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 AddSiedleCodeLockSetting 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 device id to the code lock. */
    // @ApiMember(DataType="string", Description="The device id to the code lock.")
    public DeviceId: string;

    /** @description The integration type to the code lock. 1 = Local Api,  2 = Cloud Based Api */
    // @ApiMember(DataType="string", Description="The integration type to the code lock. 1 = Local Api,  2 = Cloud Based Api")
    public IntegrationType: SiedleIntegrationType;

    /** @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<AddSiedleCodeLockSetting>) { (Object as any).assign(this, init); }
}

TypeScript AddSiedleCodeLockSetting 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.

POST /codelock/siedle/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	ApiEndpoint: String,
	ApiPort: String,
	DeviceId: String,
	IntegrationType: LocalApi,
	Username: String,
	Password: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ApiEndpoint: String,
	ApiPort: 0,
	DeviceId: String,
	Username: String,
	Password: String,
	IntegrationType: LocalApi
}