Print Page as PDF
Entity mapping APIs ICR (7008)

Entity mapping APIs    ICR (7008)

Name Value
NUMBER 7008
IA # 7008
DATE CREATED 2019/01/24
CUSTODIAL PACKAGE VA FILEMAN
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DDE
NAME Entity mapping APIs
GENERAL DESCRIPTION
APIs that can be used with the ENTITY file (#1.5) to
retrieve data from VA FileMan files and format them in either XML or JSON.
STATUS Active
KEYWORDS
  • ENTITY
  • SDA
DURATION Till Otherwise Agreed
ID DDE
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$GET1()
This extrinsic function retrieves a single record and
returns a string containing the data.

$$GET1^DDE(RESOURCE, ID,, MTYPE, ERROR)
VARIABLES TYPE VARIABLES DESCRIPTION
RESOURCE Input
(Required)  The ien or name of the ENTITY file (#1.5)
record to use.
ID Input
(Optional) The record ien or name to use to retrieve
data.
MTYPE Input
(Optional)  Format used for returned data;  0=JSON
(default) or 1=XML
ERROR Both
(Optional)  The name of a closed root reference that
is used to return error messages.
GET()
This procedure can retrieve multiple records using
the QUERY array or a single record using the ID parameter.  It will return an
array containing the data.

GET^DDE(RESOURCE, ID, QUERY, MTYPE, MAX, RESULT, ERROR)
VARIABLES TYPE VARIABLES DESCRIPTION
RESOURCE Input
(Required)  The ien or name of the ENTITY file (#1.5)
record to use.
ID Input
(Optional) The record ien or name to use to retrieve
data.
QUERY Input
(Optional)  An array used to lookup multiple records
via the GET QUERY ROUTINE:
QUERY("start") start date.time for a search of records
QUERY("stop")  stop date.time for a search of records
QUERY("patient")  DFN or DFN;ICN of a patient
QUERY(x) where x is any developer-defined lookup value
MTYPE Input
(Optional)  Format used for returned data;  0=JSON
(default) or 1=XML
MAX Input
(Optional)  The maximum number of items to return.
RESULT Both
(Optional)  The name of a closed root reference that
is used to return data.
ERROR Both
(Optional)  The name of a closed root reference that
is used to return error messages.
DATE ACTIVATED 2019/03/08