Jump to

• Request
• Response

Get Structure Priority Details for customer ID

get

/api/1.0/service/lma/structure-priority/{customerId}

This endpoint is used to get the list of all structures along with priority for the customer hierarchy.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• customerId(required): string
  customer ID

Header Parameters

• sourceCode(required): string
  Source from which request is initiated

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns message of success or failure

Body ()

Root Schema : StructurePriorityDetailsServiceCollection

Type: object

Collection of structure priority details

Show Source

• data: array data
• paging: object PagingDto

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

Nested Schema : data

Type: array

Show Source

• Array of: object StructurePriorityDetailServiceDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults: integer

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

Nested Schema : StructurePriorityDetailServiceDTO

Type: object

Show Source

• customerId: string
  Customer ID
• customerName: string
  Customer Name
• recordStatus: string
  Record Status
• structureDescription: string
  Pattern: [A-Za-z0-9 ()_+:"',.?/-]{1,200}

  Structure Description
• structureId: string
  Structure ID
• structurePriority: integer
  Structure Priority
• structureStatus: string
  Structure Status
• structureType: 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"
        },
        "recordStatus":{
            "type":"string",
            "description":"Record Status"
        }
    }
}

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