Record Query Service - Inputs

The table lists the inputs of the record query web service.

Record Query Service Inputs
Command Type Query Directives External Keys Predefined Keys Operator
Set the command to Query: 
<Command type="Query">

<MasterCatalogRecord etype="Entity">

Pagination: to achieve pagination of a large result, specify the following tags:
  • <MaxCount> : Limits the number of records returned, if more than one record matches the query.
  • <StartCount> : In combination with MaxCount, the caller can control which ‘page’ of the result set needs to be returned.
  • <OrderByColumnList> : Defines order by Column list with sort order for the results. This tag is Optional.

    You can retrieve data in sort order based on one or more columns in an ascending or descending order.

Query Criterion Using External Keys Predefined Keys Supported Operators
 
  • <FUTURE_DATED_RECORD>: Queries records by Future Effective Date key options. Specify any one the following key options:
    • I (Include FED): Includes Future Effective Date records along with other records.
    • O (Only FED): Includes only Future Effective Date records.
    • N (No FED): Does not include Future Effective Date records.

      Based on these key options, the records are returned. If you do specify any key option, by default the N (No FED) option is retrieved.

  • When querying a record, specify the EFFECTIVEDATE variable in context to return the related record according to the effective date of a relationship.