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.
CodeLockVanderbiltSettingQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
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 .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.

GET /codelock/vanderbilt/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
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>