BokaMera.API.Host

<back to all web services

CodeLockRcoM5SettingQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/codelock/rcom5/settingsGet code lock api settings for the currently logged in userGet code lock api settings for the currently logged in user.
CodeLockRcoM5SettingQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /codelock/rcom5/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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