Developer Helper Endpoints

Developers working with a rich data source and platform like Mydex will want to be able to ask questions of the platform in real time to help them know what they can do and what is available.

The following functions are designed to help understand what data is available within our Master Schema, what data types, what fields and any validation rules that apply. We also provide helper functions to understand at a specific personal data store level what is available within that store.

If you have other helper functions that you feel would be of use do let us know by sending us a request via our documentation feedback email address which can be found at https://dev.mydex.org/support.html.



Description Path/Parameters Returned data Example
View all the available datasets in the master schema database. GET /developer-helpers/datasets datasetmachinename

datasetname

status
/developer-helpers/datasets

[{"datasetmachinename":"dsaddress",
  "datasetname":"Address",
  "status":"Implement"},
 {"datasetmachinename":"dsbankaccounttransactions",
  "datasetname":"Bank Account Transactions",
  "status":"Live"},
...]
View datasets by status. To view multiple categories, separate them by /. GET /developer-helpers/datasets/:status1/:status2/:status3 datasetmachinename

dataset
name

status
/developer-helpers/datasets/in%20development/implement

[{"datasetmachinename":"dsaddress",
  "datasetname":"Address",
  "status":"Implement"},
 {"datasetmachinename":"dscertificates",
  "datasetname":"Certificates",
  "status":"In Development"},
...]
Display the accepted options for a particular field. GET /developer-helpers/options/:field list of options /developer-helpers/options/luutilityservice

["Broadband",
 "Electricity",
 "Gas",
 "Gas & Electricity",
 "Oil",
 "Telephone",
 "Water"]
Get the data types of all fields in a dataset. GET /developer-helpers/types/:dataset fieldname

display
name

datatype
/developer-helpers/types/fielddsemployment

{"fieldempemployeeid":
  {"fieldname":"fieldempemployeeid",
   "displayname":"EmployeeID",
   "datatype":"text"},
 "fieldempemployername":
  {"fieldname":"fieldempemployername",
   "displayname":"Employer Name",
   "datatype":"text"},
...}
Get the data type of a specific field. GET /developer-helpers/type/:field fieldname

displayname

data
type
/developer-helpers/type/batransactiondate

{"fieldname":"batransactiondate",
 "displayname":"Transactions Date",
 "datatype":"date"}
Lists linked groups with corresponding linked fields. GET /developer-helpers/linkedfields linkedgroupname

field
name
/developer-helpers/linkedfields

{"Birth Town":
 ["fieldbirthtown",
  "fielddlpob",
  "fieldppplaceofbirth"],
 "Country":
 ["fieldhomecountry",
  "fieldutilitybillingcountry",
  "fieldutilitysuppliedcountry"],
...}
Find all fields belonging to a linked group. GET /developer-helpers/linkedfieldsgroup/:groupname fieldname

dataset
machinename
/developer-helpers/linkedfieldsgroup/first%20name

[{"fieldname":"fieldpersonalfname",
  "datasetmachinename":"fielddspersonaldetails"},
 {"fieldname":"fieldppgivennames",
  "datasetmachinename":"fielddspassport"}]
Find the linked group a specific field belongs to and view all fields in this group. GET /developer-helpers/linkedfields/:field linkedgroupname

linked
fields
/developer-helpers/linkedfields/fieldbirthdob

{"linkedgroupname":"Date of Birth",
 "linkedfields":
  ["fieldbirthdob",
   "fielddldob",
   "fieldppdob"]}
Find field names that include the search term. GET /developer-helpers/search/:search search term

matching fields
/developer-helpers/search/birth

{"searchterm":"birth",
 "matchingfields":
  ["fieldbirthcountry",
   "fieldbirthdob",
   "fieldbirthnationality",
   "fieldbirthtown",
   "fieldppplaceofbirth"]}
Validate user input by type. GET /developer-helpers/validate/:fieldname/:userinput true/false /developer-helpers/validate/fieldninumber/AB010203Z

{"result":"true"}
Validate user input for lookup field options. GET /developer-helpers/validateoptions/:lufieldname/:userinput true/false /developer-helpers/validateoptions/lubankacctype/savingss

{"result":"false"}
Find ‘lu’ field name for a field. GET /developer-helpers/getlookup/:fieldname luname /developer-helpers/getlookup/fieldedutype

{"lookupclass":"lueduorgtype"}
Get information about PDS tabs. GET /developer-helpers/tabs/details/:namesorders/:var tab names

associated side tabs

orders of side tabs
/developer-helpers/tabs/details/names/top

{"toptabnames":
  ["Assets","Education",
   "Employment",
   "Financial",
   "Health",
   "Home",
   "My Council",
   "Notepad",
   "Personal",
   "Personal Directory",
   "Travel",
   "Voluntary"]}
/developer-helpers/tabs/details/orders/all

[...
  {"toptabname":"Financial",
   "assocsidetabs":
    [{"order":"1",
      "sidetabname":"Bank Account"},
     {"order":"2",
      "sidetabname":"Credit Card"},
     {"order":"3",
      "sidetabname":"Loyalty Card"}]},
  {"toptabname":"Health",
   "assocsidetabs":
    [{"order":"1",
      "sidetabname":"Basics"}]},
...]
Get information about fields within tabs. GET /developer-helpers/tabs/layout/:toptab/:sidetab panel name

fieldname

order

datasetmachinename
/developer-helpers/tabs/layout/Personal/Basics

{"panelname":"Personal-Basics",
 "paneltype":"Linear",
 "items":
  [{"order":"1",
    "datasetmachinename":"fielddspersonaldetails",
    "fieldname":"fieldpersonaltitle"},
   {"order":"2",
    "datasetmachinename":"fielddspersonaldetails",
    "fieldname":"fieldpersonalfname"},
...]}
Get the data and options of fields in dataset. GET /getdatasetinfo/:dataset fieldname

display
name

datatye

field
order

options

sourcetype
/developer-helpers/getdatasetinfo/fielddspersonaldetails

...{"fieldpersonalmaritalstatus": {
        "fieldname": "fieldpersonalmaritalstatus",
        "displayname": "Marital Status",
        "datatype": "text",
        "fieldorder": "8",
        "options": [
            "Single",
            "Married / Civil Partner",
            "Divorced / Civil Partnership Disolved",
            "Widowed / Surviving Civil Partner",
            "Separated",
            "Not Stated"
        ],
        "source_type": "Pick List"
    }...,