BokaMera.API.Host

<back to all web services

CodeLockZesecUnlock

Requires Authentication
The following routes are available for this service:
POST/codelock/zesec/unlockUnlock the door for the code lock of the company of the currently logged in userUnlock the door for the code lock of the company of the currently logged in user.

export class CodeLockZesecUnlockResponse
{
    /** @description The status for unlocking the door */
    // @ApiMember(DataType="string", Description="The status for unlocking the door")
    public Status: string;

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

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privileges to call this service", StatusCode=403)
// @ValidateRequest(Validator="IsAuthenticated")
export class CodeLockZesecUnlock
{
    /** @description The Company Id of the company you want to unlock the door for. */
    // @ApiMember(Description="The Company Id of the company you want to unlock the door for.")
    public CompanyId: string;

    /** @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 BookingId: number;

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

TypeScript CodeLockZesecUnlock 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/zesec/unlock HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CodeLockZesecUnlock xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BookingId>0</BookingId>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
</CodeLockZesecUnlock>

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

<CodeLockZesecUnlockResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Status>String</Status>
</CodeLockZesecUnlockResponse>