Dataset: Cervical Position Log

Dataset name: ds_cervical_position_log

Description

Cervical Mucus Log Data

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
Cervical Dilation	cervical_dilation	How open or dilated is cervix	int	2
Cervical Dilation Description	cervical_dilation_description	Description of how open or dilated is cervix	varchar	Partially open cervix
Cervical Firmness	cervical_firmness	How firm the cervix is	int	3
Cervical Firmness Description	cervical_firmness_description	Description of how firm the cervix is	varchar	Cervix is firm
Cervical Position	cervical_position	Position of Cervix	int	1
Cervical Position description	cervical_position_description	Description of the Position of Cervix	varchar	Cervix is Low
Measurement End Timestamp	cervical_position_measurement_timestamp_end	Cervical Mucus measurement end date and time	int	1648633780
Measurement Start Timestamp	cervical_position_measurement_timestamp_start	Cervical Mucus measurement start date and time	int	1648633780
ID	id	The machine name for a record. Internal to PDS and Mydex	int	1
Measurement Group	measurement_group	The top level group activity belongs to	varchar	Activity
Measurement Log ID	measurement_id	The key that links to Measurement Log	int	1
Created Timestamp	record_created_timestamp	Date record added to PDS	int	1648633780
Updated Timestamp	record_updated_timestamp	Date record updated in the PDS	int	1648633780
Source Device Type	source_device_type	States the type of source device	varchar	PDA
Source ID	source_id	The unique ID of source of the data	varchar	3621-29756
Source Instance	source_instance	The instance of the source type	int	Google Account 1
Source Name	source_name	The Name given to source	varchar	Google Fit

---

Making an API request for this Dataset

Example Request to the Sandbox Server

http://sbx-api.mydex.org/api/pds/transaction/UID.json
  ?key=KEY
  &api_key=API_KEY
  &con_id=CON_ID
  &source_type=connection
  &dataset=ds_cervical_position_log
  &instance=N

Replace the following with your own details: UID KEY, API_KEY, CON_ID and instance N.

Replace sbx-api with api when making a connection to a real member on the production server (must be authenticated).

To return the data in XML, change UID.json to UID.xml.

Example Response

A response to this API request will be structured as follows.

{
  "1": {
    "id": "1",
    "ds_id": "1",
    "cervical_dilation": "2",
    "cervical_dilation_description": "Partially open cervix",
    "cervical_firmness": "3",
    "cervical_firmness_description": "Cervix is firm",
    "cervical_position": "1",
    "cervical_position_description": "Cervix is Low",
    "cervical_position_measurement_timestamp_end": "1648633780",
    "cervical_position_measurement_timestamp_start": "1648633780",
    "measurement_group": "Activity",
    "measurement_id": "1",
    "record_created_timestamp": "1648633780",
    "record_updated_timestamp": "1648633780",
    "source_device_type": "PDA",
    "source_id": "3621-29756",
    "source_instance": "Google Account 1",
    "source_name": "Google Fit"
  }
}