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.
AddVanderbiltCodeLockSetting Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
ApiEndpointbodystringYesThe api endpoint of the code lock
ApiPortbodystringYesThe api port for the code lock.
IdentifierbodystringYesThe default identifier for the code lock.
DefaultFacilityIdbodystringNoThe default facility id to be used when no set on the resource.
CodeLockVanderbiltSettingResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
ApiEndpointformstringNoThe api endpoint of the code lock
ApiPortformstringNoThe api port for the code lock.
IdentifierformstringNoThe default identifier for the code lock.
DefaultFacilityIdformstringNoThe default facility id to be used when no set on the resource.
CreatedformdatetimeNoWhen settings was created
UpdatedformdatetimeNoWhen settings was updated

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.

POST /codelock/vanderbilt/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	ApiEndpoint: String,
	ApiPort: String,
	Identifier: String,
	DefaultFacilityId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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