BokaMera.API.Host

AddRcoM5CodeLockSetting

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

The following routes are available for this service:
POST	/codelock/rcom5/settings	Add settings for the RCO M5 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 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 AddRcoM5CodeLockSetting 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 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.", IsRequired=true)
    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.", IsRequired=true)
    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.", IsRequired=true)
    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.", IsRequired=true)
    public Password: string;

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

TypeScript AddRcoM5CodeLockSetting DTOs

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

HTTP + XML

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

POST /codelock/rcom5/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddRcoM5CodeLockSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ApiEndpoint>String</ApiEndpoint>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Password>String</Password>
  <ServerId>0</ServerId>
  <SystemName>String</SystemName>
  <Username>String</Username>
</AddRcoM5CodeLockSetting>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CodeLockRcoM5SettingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ApiEndpoint>String</ApiEndpoint>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Created>0001-01-01T00:00:00</Created>
  <Password>String</Password>
  <ServerId>0</ServerId>
  <SystemName>String</SystemName>
  <Updated>0001-01-01T00:00:00</Updated>
  <Username>String</Username>
</CodeLockRcoM5SettingResponse>