BokaMera.API.Host

<back to all web services

AddVanderbiltCodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/codelock/vanderbilt/settingsAdd settings for the code lock of the company of the currently logged in userAdd settings for code lock of the company of 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 AddVanderbiltCodeLockSetting 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;

        /**
        * The api endpoint of the code lock
        */
        @ApiMember(DataType="string", Description="The api endpoint of the code lock", IsRequired=true)
        public String ApiEndpoint = null;

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

        /**
        * The default identifier for the code lock.
        */
        @ApiMember(DataType="string", Description="The default identifier for the code lock.", IsRequired=true)
        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 String DefaultFacilityId = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public AddVanderbiltCodeLockSetting setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getApiEndpoint() { return ApiEndpoint; }
        public AddVanderbiltCodeLockSetting setApiEndpoint(String value) { this.ApiEndpoint = value; return this; }
        public String getApiPort() { return ApiPort; }
        public AddVanderbiltCodeLockSetting setApiPort(String value) { this.ApiPort = value; return this; }
        public String getIdentifier() { return Identifier; }
        public AddVanderbiltCodeLockSetting setIdentifier(String value) { this.Identifier = value; return this; }
        public String getDefaultFacilityId() { return DefaultFacilityId; }
        public AddVanderbiltCodeLockSetting setDefaultFacilityId(String value) { this.DefaultFacilityId = 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 AddVanderbiltCodeLockSetting 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/vanderbilt/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddVanderbiltCodeLockSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ApiEndpoint>String</ApiEndpoint>
  <ApiPort>String</ApiPort>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <DefaultFacilityId>String</DefaultFacilityId>
  <Identifier>String</Identifier>
</AddVanderbiltCodeLockSetting>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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