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.

export class CodeLockVanderbiltSettingResponse
{
    public CompanyId: string;
    /** @description The api endpoint of the code lock */
    // @ApiMember(DataType="string", Description="The api endpoint of the code lock")
    public ApiEndpoint: string;

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

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

    /** @description 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 DefaultFacilityId?: number;

    /** @description When settings was created */
    // @ApiMember(DataType="datetime", Description="When settings was created")
    public Created: string;

    /** @description When settings was updated */
    // @ApiMember(DataType="datetime", Description="When settings was updated")
    public Updated: string;

    public constructor(init?: Partial<CodeLockVanderbiltSettingResponse>) { (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 CodeLockVanderbiltSettingQuery 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;

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

TypeScript 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
}