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.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @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")
    public static class CodeLockZesecUnlock
    {
        /**
        * 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 UUID CompanyId = null;

        /**
        * 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 Integer BookingId = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public CodeLockZesecUnlock setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Integer getBookingId() { return BookingId; }
        public CodeLockZesecUnlock setBookingId(Integer value) { this.BookingId = value; return this; }
    }

    public static class CodeLockZesecUnlockResponse
    {
        /**
        * The status for unlocking the door
        */
        @ApiMember(DataType="string", Description="The status for unlocking the door")
        public String Status = null;
        
        public String getStatus() { return Status; }
        public CodeLockZesecUnlockResponse setStatus(String value) { this.Status = value; return this; }
    }

}

Java CodeLockZesecUnlock DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"BookingId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Status":"String"}