Jump to

• Request
• Response

Get the location plan defined in a project.

get

/connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/locationPlans/{locationPlanId}

This operation retrieves the location plan of a specific project.

Request

Path Parameters

• locationPlanId: string
  Location plan identifier
• orgId: string
  Organization identifier
• projectId: string
  Project identifier

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Location plan was successfully retrieved.

Body ()

Root Schema : LocationPlan

Type: object

Show Source

• description(optional): string
  Description of the location plan

  Example: My location plan description
• id(optional): string
  Read Only: true

  The unique id of the object

  Example: 53
• imageP1: string
  First point of the picture, to pin the image to the mapP1

  Example: 39.215302, 26.308674
• imageP2: string
  Second point of the picture, to pin the image to the mapP2

  Example: 39.215302, 26.308674
• links(optional): array links
• mapP1: string
  First geoPoint (latitude, longitude) in the map, to place the image of the location plan

  Example: 39.215302, 26.308674
• mapP2: string
  Second geoPoint (latitude, longitude) in the map, to place the image of the location plan

  Example: 39.215302, 26.308674
• name: string
  Minimum Length: 0

  Maximum Length: 255

  Name of the location plan. Max length is 255 characters

  Example: My location plan name

{
    "required":[
        "imageP1",
        "imageP2",
        "mapP1",
        "mapP2",
        "name"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique id of the object",
            "readOnly":true,
            "example":"53"
        },
        "name":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Name of the location plan. Max length is 255 characters",
            "example":"My location plan name"
        },
        "description":{
            "type":"string",
            "description":"Description of the location plan",
            "example":"My location plan description"
        },
        "imageP1":{
            "type":"string",
            "description":"First point of the picture, to pin the image to the mapP1",
            "example":"39.215302, 26.308674"
        },
        "imageP2":{
            "type":"string",
            "description":"Second point of the picture, to pin the image to the mapP2",
            "example":"39.215302, 26.308674"
        },
        "mapP1":{
            "type":"string",
            "description":"First geoPoint (latitude, longitude) in the map, to place the image of the location plan",
            "example":"39.215302, 26.308674"
        },
        "mapP2":{
            "type":"string",
            "description":"Second geoPoint (latitude, longitude) in the map, to place the image of the location plan",
            "example":"39.215302, 26.308674"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

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

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

Back to Top