Jump to

• Request
• Response

Get all hazard locations

get

/connectedWorker/clientapi/v2/projects/{projectId}/hazards/{hazardId}/locations

This operation retrieves all locations for a hazard.

Request

Path Parameters

• hazardId: integer(int64)
  Hazard identifier
• projectId: integer(int64)
  Project identifier

Back to Top

Response

Supported Media Types

• application/json

200 Response

Hazard locations were successfully retrieved

Body ()

Root Schema : HazardLocations

Type: object

Show Source

• items: array items
• links(optional): array links

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/HazardLocation"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object HazardLocation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/HazardLocation"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : HazardLocation

Type: object

Show Source

• links(optional): array links
• locationId(optional): integer(int64)
  Read Only: true

  Identifier of the location within the hazard

  Example: 51
• status(optional): string
  Read Only: true

  Allowed Values: [ "OPEN", "RESOLVED" ]

  Status of the hazard location

  Example: OPEN

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"OPEN",
            "description":"Status of the hazard location",
            "readOnly":true,
            "enum":[
                "OPEN",
                "RESOLVED"
            ]
        },
        "locationId":{
            "type":"integer",
            "format":"int64",
            "example":51,
            "description":"Identifier of the location within the hazard",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
  The target resource's URI
• rel: string
  Relation type

{
    "type":"object",
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relation type"
        },
        "href":{
            "type":"string",
            "description":"The target resource's URI"
        }
    }
}

Back to Top