BokaMera.API.Host

<back to all web services

UpdateRcoM5CodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/codelock/rcom5/settingsUpdate settings for the RCO M5 code lock of the company of the currently logged in userUpdate settings for code lock of the company of the currently logged in user.
UpdateRcoM5CodeLockSetting Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
ApiEndpointbodystringYesOverrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/).
ServerIdbodyintNoServer id from rcoservers.config of the M5AdminAPI installation.
SystemNamebodystringYesSystem name exactly as in R-CARD M5 Arbetsstation.
UsernamebodystringYesThe API operator username to logon to the RCO M5 system.
PasswordbodystringYesThe API operator password to logon to the RCO M5 system.
CodeLockRcoM5SettingResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
ApiEndpointformstringYesOverrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/).
ServerIdformintNoServer id from rcoservers.config of the M5AdminAPI installation.
SystemNameformstringYesSystem name exactly as in R-CARD M5 Arbetsstation.
UsernameformstringYesThe API operator username to logon to the RCO M5 system.
PasswordformstringYesThe API operator password to logon to the RCO M5 system.
CreatedformdatetimeNoWhen settings were created
UpdatedformdatetimeNoWhen settings were 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.

PUT /codelock/rcom5/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,
	ServerId: 0,
	SystemName: String,
	Username: String,
	Password: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ApiEndpoint: String,
	ServerId: 0,
	SystemName: String,
	Username: String,
	Password: String
}