BokaMera.API.Host

<back to all web services

CodeLockVanderbiltSettingQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/codelock/vanderbilt/settingsGet code lock api settings for the currently logged in userGet code lock api settings for the currently logged in user.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @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)
    public static class CodeLockVanderbiltSettingQuery implements ICompany
    {
        /**
        * 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 UUID CompanyId = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public CodeLockVanderbiltSettingQuery setCompanyId(UUID value) { this.CompanyId = value; return this; }
    }

    public static class CodeLockVanderbiltSettingResponse
    {
        public UUID CompanyId = null;
        /**
        * The api endpoint of the code lock
        */
        @ApiMember(DataType="string", Description="The api endpoint of the code lock")
        public String ApiEndpoint = null;

        /**
        * The api port for the code lock.
        */
        @ApiMember(DataType="string", Description="The api port for the code lock.")
        public Integer ApiPort = null;

        /**
        * The default identifier for the code lock.
        */
        @ApiMember(DataType="string", Description="The default identifier for the code lock.")
        public String Identifier = null;

        /**
        * The default facility id to be used when no set on the resource.
        */
        @ApiMember(DataType="string", Description="The default facility id to be used when no set on the resource.")
        public Integer DefaultFacilityId = null;

        /**
        * When settings was created
        */
        @ApiMember(DataType="datetime", Description="When settings was created")
        public Date Created = null;

        /**
        * When settings was updated
        */
        @ApiMember(DataType="datetime", Description="When settings was updated")
        public Date Updated = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public CodeLockVanderbiltSettingResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getApiEndpoint() { return ApiEndpoint; }
        public CodeLockVanderbiltSettingResponse setApiEndpoint(String value) { this.ApiEndpoint = value; return this; }
        public Integer getApiPort() { return ApiPort; }
        public CodeLockVanderbiltSettingResponse setApiPort(Integer value) { this.ApiPort = value; return this; }
        public String getIdentifier() { return Identifier; }
        public CodeLockVanderbiltSettingResponse setIdentifier(String value) { this.Identifier = value; return this; }
        public Integer getDefaultFacilityId() { return DefaultFacilityId; }
        public CodeLockVanderbiltSettingResponse setDefaultFacilityId(Integer value) { this.DefaultFacilityId = value; return this; }
        public Date getCreated() { return Created; }
        public CodeLockVanderbiltSettingResponse setCreated(Date value) { this.Created = value; return this; }
        public Date getUpdated() { return Updated; }
        public CodeLockVanderbiltSettingResponse setUpdated(Date value) { this.Updated = value; return this; }
    }

}

Java CodeLockVanderbiltSettingQuery 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.

GET /codelock/vanderbilt/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ApiEndpoint: String,
	ApiPort: 0,
	Identifier: String,
	DefaultFacilityId: 0
}