Jump to

• Request
• Response

Retrives the virtual entities with Details of accounts under that entity for a given real customer

get

/service/virtualentities/entitieswithaccountdetails

This endpoint is used to retrive the virtual entities with Details of accounts under that entity for a given real customer.

Request

Supported Media Types

• application/json

Query Parameters

• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting no of records to be fetched
• realCustomerNo: string
  real customer number whose entities needs to be fetched
• virtualEntityId(optional): string
  virtual Entity Id
• virtualEntityName(optional): string
  virtual Entity Name

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns the virtualentities based on given id.

Body ()

Root Schema : EntityServiceWithAccountDetailsCollection

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EntityWithAccountDetailsServiceDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object EntityWithAccountDetailsServiceDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : EntityWithAccountDetailsServiceDTO

Type: object

Show Source

• childAccounts(optional): integer
  Available balance of a virtual enitty
• creationDate(optional): string
  creation date of a virtual enitty
• entityType(optional): string
  type of the virtual entiity e.g Individual, Corporate etc
• realCustomerNo(optional): string
  real customer no of a virtual enitty
• status(optional): string
  status of a virtual enitty
• virtualEntityId(optional): string
  Virtual entity id or virtual customer id of a real customer
• virtualEntityName(optional): string
  Virtual entity name or virtual customer name of a real customer

{
    "type":"object",
    "properties":{
        "virtualEntityId":{
            "type":"string",
            "description":"Virtual entity id or virtual customer id of a real customer"
        },
        "virtualEntityName":{
            "type":"string",
            "description":"Virtual entity name or virtual customer name of a real customer"
        },
        "entityType":{
            "type":"string",
            "description":"type of the virtual entiity e.g Individual, Corporate etc"
        },
        "childAccounts":{
            "type":"integer",
            "description":"Available balance of a virtual enitty"
        },
        "status":{
            "type":"string",
            "description":"status of a virtual enitty"
        },
        "creationDate":{
            "type":"string",
            "description":"creation date of a virtual enitty"
        },
        "realCustomerNo":{
            "type":"string",
            "description":"real customer no of a virtual enitty"
        }
    }
}

400 Response

Bad request error, the server is unable to process the request.

401 Response

Unauthorized request error, invalid credentials.

403 Response

Request denied, no permission to access the request.

500 Response

Internal server error.

Back to Top