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 dataset_machine_name

dataset_name

status		 /developer-helpers/datasets

[{"dataset_machine_name":"ds_address",
  "dataset_name":"Address",
  "status":"Implement"},
 {"dataset_machine_name":"ds_bank_account_transactions",
  "dataset_name":"Bank Account Transactions",
  "status":"Live"},
...]
View all the available datasets by type in the master schema database. GET /developer-helpers/datasetsbytype/:type
Where type must be either 'metadata' or 'transactional' 		dataset_machine_name

dataset_name

status		 /developer-helpers/datasetsbytype/transactional

[{"dataset_machine_name": "ds_assurance_log",
  "dataset_name": "Assurance Log",
  "status": "Live"
},
{"dataset_machine_name": "ds_bank_account_transactions",
  "dataset_name": "Bank Account Transactions",
  "status": "Live"},
...]
View datasets by status. To view multiple categories, separate them by /. GET /developer-helpers/datasets/:status1/:status2/:status3 dataset_machine_name

dataset_name

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

[{"dataset_machine_name":"ds_address",
  "dataset_name":"Address",
  "status":"Implement"},
 {"dataset_machine_name":"ds_certificates",
  "dataset_name":"Certificates",
  "status":"In Development"},
...]
Display the accepted options for a particular field. GET /developer-helpers/options/:field list of options /developer-helpers/options/lu_utility_service

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

display_name

data_type		 /developer-helpers/types/ds_employment

{"field_emp_employee_id":
  {"field_name":"field_emp_employee_id",
   "display_name":"EmployeeID",
   "data_type":"text"},
 "field_emp_employer_name":
  {"field_name":"field_emp_employer_name",
   "display_name":"Employer Name",
   "data_type":"text"},
...}
Get the data type of a specific field. GET /developer-helpers/type/:field field_name

display_name

data_type		 /developer-helpers/type/ba_transaction_date

{"field_name":"ba_transaction_date",
 "display_name":"Transactions Date",
 "data_type":"date"}
Lists linked groups with corresponding linked fields. GET /developer-helpers/linkedfields linked_group_name

field_name		 /developer-helpers/linkedfields

{"Birth Town":
 ["field_birth_town",
  "field_dl_pob",
  "field_pp_place_of_birth"],
 "Country":
 ["field_home_country",
  "field_utility_billing_country",
  "field_utility_supplied_country"],
...}
Find all fields belonging to a linked group. GET /developer-helpers/linkedfieldsgroup/:groupname field_name

dataset_machine_name		 /developer-helpers/linkedfieldsgroup/first%20name

[{"field_name":"field_personal_fname",
  "dataset_machine_name":"field_ds_personal_details"},
 {"field_name":"field_pp_given_names",
  "dataset_machine_name":"field_ds_passport"}]
Find the linked group a specific field belongs to and view all fields in this group. GET /developer-helpers/linkedfields/:field linked_group_name

linked_fields		 /developer-helpers/linkedfields/field_birth_dob

{"linked_group_name":"Date of Birth",
 "linked_fields":
  ["field_birth_dob",
   "field_dl_dob",
   "field_pp_dob"]}
Find field names that include the search term. GET /developer-helpers/search/:search search term

matching fields		 /developer-helpers/search/birth

{"search_term":"birth",
 "matching_fields":
  ["field_birth_country",
   "field_birth_dob",
   "field_birth_nationality",
   "field_birth_town",
   "field_pp_place_of_birth"]}
Validate user input by type. GET /developer-helpers/validate/:field_name/:user_input true/false /developer-helpers/validate/field_ni_number/AB010203Z

{"result":"true"}
Validate user input for lookup field options. GET /developer-helpers/validateoptions/:lu_field_name/:user_input true/false /developer-helpers/validateoptions/lu_bank_acc_type/savings

{"result":"false"}
Find ‘lu_’ field name for a field. GET /developer-helpers/getlookup/:field_name lu_name /developer-helpers/getlookup/field_edu_type

{"lookup_class":"lu_edu_org_type"}
Get information about PDS tabs. GET /developer-helpers/tabs/details/:names_orders/:var tab names

associated side tabs

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

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

[...
  {"top_tab_name":"Financial",
   "assoc_side_tabs":
    [{"order":"1",
      "side_tab_name":"Bank Account"},
     {"order":"2",
      "side_tab_name":"Credit Card"},
     {"order":"3",
      "side_tab_name":"Loyalty Card"}]},
  {"top_tab_name":"Health",
   "assoc_side_tabs":
    [{"order":"1",
      "side_tab_name":"Basics"}]},
...]
Get information about fields within tabs. GET /developer-helpers/tabs/layout/:top_tab/:side_tab panel name

field_name

order

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

{"panel_name":"Personal-Basics",
 "panel_type":"Linear",
 "items":
  [{"order":"1",
    "dataset_machine_name":"field_ds_personal_details",
    "field_name":"field_personal_title"},
   {"order":"2",
    "dataset_machine_name":"field_ds_personal_details",
    "field_name":"field_personal_fname"},
...]}
Get the data and options of fields in dataset. GET /getdatasetinfo/:dataset field_name

display_name

data_tye

field_order

options

source_type		 /developer-helpers/getdatasetinfo/ds_personal_details

...{"field_personal_marital_status": {
        "field_name": "field_personal_marital_status",
        "display_name": "Marital Status",
        "data_type": "text",
        "field_order": "8",
        "options": [
            "Single",
            "Married / Civil Partner",
            "Divorced / Civil Partnership Disolved",
            "Widowed / Surviving Civil Partner",
            "Separated",
            "Not Stated"
        ],
        "source_type": "Pick List"
    }...,