BokaMera.API.Host

CodeLockRcoM5SettingQuery

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

The following routes are available for this service:
GET	/codelock/rcom5/settings	Get code lock api settings for the currently logged in user	Get code lock api settings for the currently logged in user.

// @ts-nocheck

export class CodeLockRcoM5SettingResponse
{
    public CompanyId: string;
    /** @description Overrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/). */
    // @ApiMember(DataType="string", Description="Overrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/).")
    public ApiEndpoint: string;

    /** @description Server id from rcoservers.config of the M5AdminAPI installation. */
    // @ApiMember(DataType="int", Description="Server id from rcoservers.config of the M5AdminAPI installation.")
    public ServerId: number;

    /** @description System name exactly as in R-CARD M5 Arbetsstation. */
    // @ApiMember(DataType="string", Description="System name exactly as in R-CARD M5 Arbetsstation.")
    public SystemName: string;

    /** @description The API operator username to logon to the RCO M5 system. */
    // @ApiMember(DataType="string", Description="The API operator username to logon to the RCO M5 system.")
    public Username: string;

    /** @description The API operator password to logon to the RCO M5 system. */
    // @ApiMember(DataType="string", Description="The API operator password to logon to the RCO M5 system.")
    public Password: string;

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

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

    public constructor(init?: Partial<CodeLockRcoM5SettingResponse>) { (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 CodeLockRcoM5SettingQuery 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<CodeLockRcoM5SettingQuery>) { (Object as any).assign(this, init); }
}

TypeScript CodeLockRcoM5SettingQuery DTOs

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

HTTP + CSV

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

GET /codelock/rcom5/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv

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

{"ApiEndpoint":"String","ServerId":0,"SystemName":"String","Username":"String","Password":"String"}