> For the complete documentation index, see [llms.txt](https://docs.hos.accessacloud.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hos.accessacloud.com/atreemo-api/api-reference/atreemo-api-reference/location.md). # Location Api Methods for Location ## Get > Get list of locations ```json {"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Location","description":"Api Methods for Location"}],"servers":[{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/atreemo-api","description":"Local DEV APIM import draft only; not a deployed endpoint announcement."}],"security":[{"AtreemoBearer":[]}],"components":{"securitySchemes":{"AtreemoBearer":{"type":"http","scheme":"bearer","description":"Atreemo access token obtained by the caller from the Atreemo instance `POST /token` endpoint (OAuth2 password grant) and sent as `Authorization: Bearer `. See the Authorisation guide."}},"schemas":{"GetLocationsOutput":{"type":"object","properties":{"Error":{"type":"array","items":{"type":"string"},"description":"The list of errors description"},"Locations":{"type":"array","items":{"$ref":"#/components/schemas/Location"},"description":"List Of locations"},"Response":{"type":"boolean","description":"The status of the call"}}},"Location":{"type":"object","properties":{"LocationID":{"type":"string","description":"The unique identifier"},"LocationName":{"type":"string","description":"Name of locations"},"OriginLocationID":{"type":"string","description":"The unique identifier"},"RegionID":{"type":"integer","format":"int32","nullable":true,"description":"Region unique identifier"},"RegionName":{"type":"string","description":"Name of the region"},"Suspended":{"type":"boolean","description":"Suspension status"}}}}},"paths":{"/api/Location/Get":{"get":{"operationId":"LocationGet","summary":"Get","tags":["Location"],"description":"Get list of locations","responses":{"200":{"description":"OK (sample status in the public collection).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLocationsOutput"}}}}}}}}} ``` ## GetByUserID > Retrieves locations through GetLocationsByBrand using the authenticated user, the resolved brand and the optional Generic flag. Returns GetLocationsOutput. The action name does not introduce a caller-supplied UserID query parameter or guarantee access to locations outside the caller's permitted context. ```json {"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Location","description":"Api Methods for Location"}],"servers":[{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/atreemo-api","description":"Local DEV APIM import draft only; not a deployed endpoint announcement."}],"security":[{"AtreemoBearer":[]}],"components":{"securitySchemes":{"AtreemoBearer":{"type":"http","scheme":"bearer","description":"Atreemo access token obtained by the caller from the Atreemo instance `POST /token` endpoint (OAuth2 password grant) and sent as `Authorization: Bearer `. See the Authorisation guide."}},"schemas":{"GetLocationsOutput":{"type":"object","properties":{"Error":{"type":"array","items":{"type":"string"},"description":"The list of errors description"},"Locations":{"type":"array","items":{"$ref":"#/components/schemas/Location"},"description":"List Of locations"},"Response":{"type":"boolean","description":"The status of the call"}}},"Location":{"type":"object","properties":{"LocationID":{"type":"string","description":"The unique identifier"},"LocationName":{"type":"string","description":"Name of locations"},"OriginLocationID":{"type":"string","description":"The unique identifier"},"RegionID":{"type":"integer","format":"int32","nullable":true,"description":"Region unique identifier"},"RegionName":{"type":"string","description":"Name of the region"},"Suspended":{"type":"boolean","description":"Suspension status"}}}}},"paths":{"/api/Location/GetByUserID":{"get":{"operationId":"LocationGetByUserId","summary":"GetByUserID","tags":["Location"],"description":"Retrieves locations through GetLocationsByBrand using the authenticated user, the resolved brand and the optional Generic flag. Returns GetLocationsOutput. The action name does not introduce a caller-supplied UserID query parameter or guarantee access to locations outside the caller's permitted context.","parameters":[{"name":"Generic","in":"query","schema":{"type":"boolean","nullable":true},"description":"Native query parameter. CLR bool? Generic in the pinned controller signature. Omission uses the declared default.","required":false}],"responses":{"200":{"description":"OK (sample status in the public collection).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLocationsOutput"}}}}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.hos.accessacloud.com/atreemo-api/api-reference/atreemo-api-reference/location.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.