Jump to

• Request
• Response

Retrieves the core accounts by providing array of account numbers

get

/service/coreaccounts/getAccounts

This endpoint is used to retrieve the core accounts by providing array of account numbers.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• accountNos: array
  Minimum Number of Items: 1

  Maximum Number of Items: 100

  array of accountNos with minimum 1 and maximum 1000

  • [0]: string

  {
      "name":"accountNos",
      "in":"query",
      "description":"array of accountNos with minimum 1 and maximum 1000",
      "required":true,
      "type":"array",
      "items":{
          "type":"string"
      },
      "minItems":1,
      "maxItems":100
  }

Header Parameters

• sourceCode: string
  Source from which request is initiated

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the coreaccount based on given accountNos.

Body ()

Root Schema : CoreAccountServiceCollection

Type: object

Collection of coreaccount.

Show Source

• data(optional): array data

{
    "description":"Collection of coreaccount.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CoreAccountDTO"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object CoreAccountDTO

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

Nested Schema : CoreAccountDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object CoreAccountDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "address4":{
                    "type":"string",
                    "description":"Fourth line of the customer?s address",
                    "minLength":0,
                    "maxLength":105
                },
                "address3":{
                    "type":"string",
                    "description":"Third line of the customer?s address",
                    "minLength":0,
                    "maxLength":105
                },
                "address2":{
                    "type":"string",
                    "description":"Second line of the customer?s address",
                    "minLength":0,
                    "maxLength":105
                },
                "address1":{
                    "type":"string",
                    "description":"First line of the customer?s address",
                    "minLength":0,
                    "maxLength":105
                }
            }
        }
    ]
}

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 : CoreAccountDTO-allOf[1]

Type: object

Show Source

• address1(optional): string
  Minimum Length: 0

  Maximum Length: 105

  First line of the customer?s address
• address2(optional): string
  Minimum Length: 0

  Maximum Length: 105

  Second line of the customer?s address
• address3(optional): string
  Minimum Length: 0

  Maximum Length: 105

  Third line of the customer?s address
• address4(optional): string
  Minimum Length: 0

  Maximum Length: 105

  Fourth line of the customer?s address

{
    "type":"object",
    "properties":{
        "address4":{
            "type":"string",
            "description":"Fourth line of the customer?s address",
            "minLength":0,
            "maxLength":105
        },
        "address3":{
            "type":"string",
            "description":"Third line of the customer?s address",
            "minLength":0,
            "maxLength":105
        },
        "address2":{
            "type":"string",
            "description":"Second line of the customer?s address",
            "minLength":0,
            "maxLength":105
        },
        "address1":{
            "type":"string",
            "description":"First line of the customer?s address",
            "minLength":0,
            "maxLength":105
        }
    }
}

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