Get a specific location

GET /location/{id}

O auth2

Return a specific location.

Path parameters

id integer Required

Which item to be processed

Minimum value is 0.

Responses

200 application/json

List returned OK
Hide response attributes Show response attributes object
- locationId integer
  
  ID to be used in other calls in the system
- shortCode string
  
  A short code entered by the user - optional
- createdBy object
  
  User who created this location
  
  Hide createdBy attributes Show createdBy attributes object
  
  userid integer
  
  API user id
  
  showname string
- manager object
  
  User who who manages this location
  
  Hide manager attributes Show manager attributes object
  
  userid integer
  
  API user id
  
  showname string
- notifyUserId1 object
  
  User to notify when things change on this location
  
  Hide notifyUserId1 attributes Show notifyUserId1 attributes object
  
  userid integer
  
  API user id
  
  showname string
- notifyUserId2 object
  
  User to notify when things change on this location
  
  Hide notifyUserId2 attributes Show notifyUserId2 attributes object
  
  userid integer
  
  API user id
  
  showname string
- notifyUserId3 object
  
  User to notify when things change on this location
  
  Hide notifyUserId3 attributes Show notifyUserId3 attributes object
  
  userid integer
  
  API user id
  
  showname string
- notifyGroup integer
  
  Group to notify when things change on this location
- informManagerEachUse string
  
  Values are Y or N.
- availableForExternalBookings string
  
  Values are Y or N.
- externalRate number
- internalRate number
- rateMultiplier object
  
  Hide rateMultiplier attributes Show rateMultiplier attributes object
  
  code string
  
  H: Hour P: Half Day D: Day F: Fixed Price
  
  Values are H, P, D, or F.
  
  decode string
- publicAddress string
  
  The physical address of this location
401 application/json

Authentication unauthorised
Hide response attribute Show response attribute object
- error string
403 application/json

Invalid permission
Hide response attribute Show response attribute object
- error string
404 application/json

Not Found
Hide response attribute Show response attribute object
- error string

GET /location/{id}

curl \
 --request GET 'https://YOURSITE.infoodle.com/apiv2/location/99' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "locationId": 1,
  "shortCode": "AU3",
  "createdBy": {
    "userid": 779,
    "showname": "John Smith"
  },
  "manager": {
    "userid": 144274,
    "showname": "Jane Smith"
  },
  "notifyUserId1": {
    "userid": 210000,
    "showname": "Jamine Khan"
  },
  "notifyUserId2": {
    "userid": 874371,
    "showname": "George Best"
  },
  "notifyUserId3": {
    "userid": 874344,
    "showname": "Arthur Dent"
  },
  "notifyGroup": 636,
  "informManagerEachUse": "Y",
  "availableForExternalBookings": "Y",
  "externalRate": 3.45,
  "internalRate": 1.33,
  "rateMultiplier": {
    "code": "P",
    "decode": "Per Half Day"
  },
  "publicAddress": "1 High Street, High Wycome, W1A 1AA"
}

Response examples (401)

{
  "error": "Unauthorised"
}

Response examples (403)

{
  "error": "Invalid Permission"
}

Response examples (404)

{
  "error": "Not Found"
}