Previous Next JavaScript must be enabled to correctly display this content

## Get Structure Priority Details for customer ID

get

/structure-priority/{customerId}

This endpoint is used to get structure priority details for customer ID

### Request

Supported Media Types

- application/json
- application/xml

Path Parameters

- customerId: string
  customer ID

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 200 Response

Returns message of success or failure
Body ()
Root Schema : StructurePriorityDetailsCollection
Type: `object`
Collection of structure priority details
Show Source

- data(optional): array data
- paging(optional): object PagingDto

    {
        "description":"Collection of structure priority details",
        "type":"object",
        "properties":{
            "data":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/StructurePriorityDetailDTO"
                }
            },
            "paging":{
                "$ref":"#/definitions/PagingDto"
            }
        }
    }

Nested Schema : data
Type: `array`
Show Source

- Array of: object StructurePriorityDetailDTO

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

Nested Schema : PagingDto
Type: `object`
Show Source

- totalResults(optional): integer

    {
        "type":"object",
        "properties":{
            "totalResults":{
                "type":"integer"
            }
        }
    }

Nested Schema : StructurePriorityDetailDTO
Type: `object`
Show Source

- customerId(optional): string
  Customer ID
- customerName(optional): string
  Customer Name
- structureDescription(optional): string
  Pattern: `[A-Za-z0-9 ()_+:"',.?/-]{1,200}`
  Structure Description
- structureId(optional): string
  Structure ID
- structurePriority(optional): integer
  Structure Priority
- structureStatus(optional): string
  Structure Status
- structureType(optional): string
  Structure Type

    {
        "type":"object",
        "properties":{
            "structureId":{
                "type":"string",
                "description":"Structure ID"
            },
            "structureDescription":{
                "type":"string",
                "description":"Structure Description",
                "pattern":"[A-Za-z0-9 ()_+:\"',.?/-]{1,200}"
            },
            "customerId":{
                "type":"string",
                "description":"Customer ID"
            },
            "customerName":{
                "type":"string",
                "description":"Customer Name"
            },
            "structureType":{
                "type":"string",
                "description":"Structure Type"
            },
            "structureStatus":{
                "type":"string",
                "description":"Structure Status"
            },
            "structurePriority":{
                "type":"integer",
                "description":"Structure Priority"
            }
        }
    }

#### 400 Response

Malformed syntax.

#### 401 Response

Request does not have sufficient credentials.

#### 403 Response

Request is not authorized.

#### 405 Response

Invalid input

#### 500 Response

Internal error
Back to Top