Jump to

• Request
• Response

Get all valid structure

get

/structure-priority

This endpoint is used to get all valid Structure Priority records.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• customerId(optional): string
  Pattern: [a-zA-Z0-9]{1,20}

  customerId need to be set to fetch structures for particular customer
• includecloseandunauth(optional): boolean
  includecloseandunauth need to be set to fetch summary record, default value is false
• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting no of records to be fetched
• structureId(optional): string
  Pattern: [A-Z0-9]{1,30}

  structureId need to be set to fetch structures for particular customer

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure

Headers

• Location: string

Body ()

Root Schema : LmmTmStructurePriorityCollection

Type: object

Collection of structure priority.

Show Source

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

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

Nested Schema : data

Type: array

Show Source

• Array of: object LmmTmStructurePriorityDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : LmmTmStructurePriorityDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmmTmStructurePriorityDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"ID",
                    "maxLength":36
                },
                "customerId":{
                    "type":"string",
                    "description":"Customer ID",
                    "maxLength":20
                },
                "customerName":{
                    "type":"string",
                    "description":"Customer Name",
                    "maxLength":105
                },
                "structureId":{
                    "type":"string",
                    "description":"Structure ID",
                    "maxLength":30
                },
                "structurePriority":{
                    "type":"integer",
                    "description":"Structure Priority",
                    "minimum":1
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : LmmTmStructurePriorityDTO-allOf[1]

Type: object

Show Source

• customerId(optional): string
  Maximum Length: 20

  Customer ID
• customerName(optional): string
  Maximum Length: 105

  Customer Name
• id(optional): string
  Maximum Length: 36

  ID
• structureId(optional): string
  Maximum Length: 30

  Structure ID
• structurePriority(optional): integer
  Minimum Value: 1

  Structure Priority

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID",
            "maxLength":36
        },
        "customerId":{
            "type":"string",
            "description":"Customer ID",
            "maxLength":20
        },
        "customerName":{
            "type":"string",
            "description":"Customer Name",
            "maxLength":105
        },
        "structureId":{
            "type":"string",
            "description":"Structure ID",
            "maxLength":30
        },
        "structurePriority":{
            "type":"integer",
            "description":"Structure Priority",
            "minimum":1
        }
    }
}

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