Jump to

• Request
• Response

Get Structure details for account

post

/service/lma/structure/v1/having-common-accounts

This endpoint is used to get structure details for the accounts participating in multiple structures.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

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

Body ()

List of Accounts/Delink Accounts to get structure details along with id

Root Schema : LinkDelinkAccountListDTO

Type: object

Collection of accounts participating in multiple structures.

Show Source

• delinkAccounts: array delinkAccounts
• id: string
  Structure key id
• linkAccounts: array linkAccounts

{
    "description":"Collection of accounts participating in multiple structures.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Structure key id"
        },
        "linkAccounts":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "delinkAccounts":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : delinkAccounts

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : linkAccounts

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns message of success or failure

Body ()

Root Schema : AccParticipatingInMSCollection

Type: object

Collection of accounts participating in multiple structures.

Show Source

• data: array data
• paging: object PagingDto

{
    "description":"Collection of accounts participating in multiple structures.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AccParticipatingInMSDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object AccParticipatingInMSDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults: integer

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

Nested Schema : AccParticipatingInMSDTO

Type: object

Show Source

• accountName: string
  Account Description
• accountNumber: string
  Account Number
• structureDescription: string
  Pattern: [A-Za-z0-9 ()_+:"',.?/-]{1,200}

  Structure Description
• structureId: string
  Structure ID
• structureStatus: string
  Structure Status
• structureType: string
  Structure Type

{
    "type":"object",
    "properties":{
        "accountNumber":{
            "type":"string",
            "description":"Account Number"
        },
        "accountName":{
            "type":"string",
            "description":"Account Description"
        },
        "structureId":{
            "type":"string",
            "description":"Structure ID"
        },
        "structureDescription":{
            "type":"string",
            "description":"Structure Description",
            "pattern":"[A-Za-z0-9 ()_+:\"',.?/-]{1,200}"
        },
        "structureType":{
            "type":"string",
            "description":"Structure Type"
        },
        "structureStatus":{
            "type":"string",
            "description":"Structure 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