List Locations

GET 
/organizations/:organizationId/locations

List locations

Request

Path Parameters

organizationId stringrequired

The ID of organization.

Query Parameters

parentId string

The parent location ID

maxResults number

Possible values: >= 10 and <= 100

The maximum number of results to return.

nextToken string

To retrieve the next set of results.

Responses

200

application/json

Schema

Schema

data object[]required
An array of assets within the specified location.
Array [
id stringrequired
organizationId stringrequired
name stringrequired
description stringrequired
address stringrequired
chatRoomId stringrequired
entities object[]required
Array [
]
image stringrequired
]

Example (from schema)

{
  "data": [
    {
      "id": "string",
      "organizationId": "string",
      "name": "string",
      "description": "string",
      "address": "string",
      "chatRoomId": "string",
      "entities": [
        {}
      ],
      "image": "string"
    }
  ]
}

Example

{
  "data": [
    {
      "id": "l-locationId",
      "organizationId": "o-organizationId",
      "name": "IDT-Location",
      "description": "IDT-Location-Description",
      "address": "Taipei City",
      "chatRoomId": "ABCDE",
      "entities": [],
      "image": "abc.png"
    }
  ]
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

404

The resource hasn't found.

application/json

Schema

Schema

error stringrequired

The resource hasn't found.

message stringrequired

The resource hasn't found message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ResourceNotFound",
  "message": "The requested resource could not be found."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...