Jump to

• Request
• Response

Fetch various structures and their priorities for the given account

get

/service/lma/structure/priorities/accountNumbers/{accountNumbers}

This endpoint is used to fetch various structures and their priorities for the given account.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• accountNumbers(required): array
  Account Number CS List

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 the Structure AccountPriority for all the structures.

Body ()

Root Schema : LmmTmStructureAccPrtyServiceCollection

Type: object

Collection of externalsystem.

Show Source

• data: array data
• paging: object PagingDto

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

Nested Schema : data

Type: array

Show Source

• Array of: object LmmTmStructureAccPriorityServiceDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults: integer

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

Nested Schema : LmmTmStructureAccPriorityServiceDTO

Type: object

Show Source

• accountNumber: string
  Maximum Length: 30
• branchCode: string
  Maximum Length: 4
• effectiveDate: string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
• endDate: string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
• id: string
  Maximum Length: 36
• structureDescription: string
  Pattern: [A-Za-z0-9 ()_+:"',.?/-]{1,200}
• structureDetailsId: string
  Maximum Length: 36
• structureId: string
  Pattern: [A-Z0-9]{1,30}
• structureMasterId: string
  Maximum Length: 36
• structurePriority: integer
• structureType: string
• versionNo: integer

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"",
            "maxLength":"36"
        },
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "structureDescription":{
            "type":"string",
            "description":"",
            "pattern":"[A-Za-z0-9 ()_+:\"',.?/-]{1,200}"
        },
        "structureType":{
            "type":"string",
            "description":""
        },
        "effectiveDate":{
            "type":"string",
            "description":"",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
        },
        "endDate":{
            "type":"string",
            "description":"",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
        },
        "structurePriority":{
            "type":"integer",
            "description":""
        },
        "accountNumber":{
            "type":"string",
            "description":"",
            "maxLength":"30"
        },
        "structureDetailsId":{
            "type":"string",
            "description":"",
            "maxLength":"36"
        },
        "structureMasterId":{
            "type":"string",
            "description":"",
            "maxLength":"36"
        },
        "versionNo":{
            "type":"integer",
            "description":""
        },
        "branchCode":{
            "type":"string",
            "description":"",
            "maxLength":"4"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top