Jump to

• Request
• Response

Retrieves the entity positions by date range

get

/service/entitypositionenquiry/byDateRange

This endpoint is used to retrieve the entity positions by the date range.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• customerNumber: string
  update date of the entities that need to be fetched
• fromDate: string
  update date of the entities that need to be fetched
• fromEntity(optional): string
• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting no of records to be fetched
• toDate: string
  update date of the entities that need to be fetched
• toEntity(optional): string

Header Parameters

• sourceCode: string
  Source from which request is initiated

Back to Top

Response

Supported Media Types

• application/json
• application/xml
• text/csv

200 Response

Returns the entitypositionenquiry based on given id.

Body ()

Root Schema : VieTbInterEntityDateWiseCollection

Type: object

Collection of interentitypositions by date range.

Show Source

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

{
    "description":"Collection of interentitypositions by date range.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VieTbInterEntityDateWiseDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        },
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object VieTbInterEntityDateWiseDTO

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

Nested Schema : ResponseDto

Type: object

Show Source

• codes(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : VieTbInterEntityDateWiseDTO

Type: object

Match All

Show Source

• object VieTbInterEntityDateWiseDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "date":{
                    "type":"string",
                    "description":""
                },
                "entityPositions":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/EntityPositionsDetailsDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : VieTbInterEntityDateWiseDTO-allOf[0]

Type: object

Show Source

• date(optional): string
• entityPositions(optional): array entityPositions

{
    "type":"object",
    "properties":{
        "date":{
            "type":"string",
            "description":""
        },
        "entityPositions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EntityPositionsDetailsDTO"
            }
        }
    }
}

Nested Schema : entityPositions

Type: array

Show Source

• Array of: object EntityPositionsDetailsDTO

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

Nested Schema : EntityPositionsDetailsDTO

Type: object

Match All

Show Source

• object EntityPositionsDetailsDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "fromEntityId":{
                    "type":"string",
                    "description":""
                },
                "toEntityId":{
                    "type":"string",
                    "description":""
                },
                "fromEntityName":{
                    "type":"string",
                    "description":""
                },
                "toEntityName":{
                    "type":"string",
                    "description":""
                },
                "lastUpdateTimeStamp":{
                    "type":"string",
                    "description":""
                },
                "currAmountDetails":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/CurrencyWiseEntityAggrDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : EntityPositionsDetailsDTO-allOf[0]

Type: object

Show Source

• currAmountDetails(optional): array currAmountDetails
• fromEntityId(optional): string
• fromEntityName(optional): string
• lastUpdateTimeStamp(optional): string
• toEntityId(optional): string
• toEntityName(optional): string

{
    "type":"object",
    "properties":{
        "fromEntityId":{
            "type":"string",
            "description":""
        },
        "toEntityId":{
            "type":"string",
            "description":""
        },
        "fromEntityName":{
            "type":"string",
            "description":""
        },
        "toEntityName":{
            "type":"string",
            "description":""
        },
        "lastUpdateTimeStamp":{
            "type":"string",
            "description":""
        },
        "currAmountDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CurrencyWiseEntityAggrDTO"
            }
        }
    }
}

Nested Schema : currAmountDetails

Type: array

Show Source

• Array of: object CurrencyWiseEntityAggrDTO

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

Nested Schema : CurrencyWiseEntityAggrDTO

Type: object

Match All

Show Source

• object CurrencyWiseEntityAggrDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string",
                    "description":""
                },
                "amount":{
                    "type":"integer",
                    "description":""
                }
            }
        }
    ]
}

Nested Schema : CurrencyWiseEntityAggrDTO-allOf[0]

Type: object

Show Source

• amount(optional): integer
• currency(optional): string

{
    "type":"object",
    "properties":{
        "currency":{
            "type":"string",
            "description":""
        },
        "amount":{
            "type":"integer",
            "description":""
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

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

Nested Schema : ResponseCode

Type: object

Show Source

• arg(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

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

Nested Schema : items

Type: object

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