Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title3.15.0

The DiagData REST API is used to retrieve diagnostic data that was uploaded from the mobile application. This API has two GET URLs. The first GET request is used to retrieve a list of diagnostics data that is available for the specified user and date. The second GET request, is used to retrieve the actual diagnostic data. 

Warning

This REST API only supports the JSON Format



Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel2

Related pages:


Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

Retrieve a list of available Diagnostic Data uploads for a specific User and Date

GET /seiapi/v3/trans/DiagData/${UserID}/${date}

Retrieve specific uploaded Diagnostic Data for a specific User

GET /seiapi/v3/trans/DiagData/${UserID}/${date}/${seq}

API Specific Parameters

ParameterDescription
${date}

Specifies the date the diagnostic data was uploaded.

The format of the date field is YYYY-MM-DD.

${seq}Specifies the unique uploaded instance.

${UserID}

Specifies the user ID to retrieve diagnostic data for.

Include Page
_Default HTTP Headers
_Default HTTP Headers

HTTP Body

(info) The response body will always have a HTTP header Content-Type of application/json.

Diagnostic List Body

This format will be returned when requesting a list of available diagnostic data uploads. Below is an example response. 

Code Block
languagejs
titleExample JSON Format
[
  {
    "seq": "269",
    "diagsDate": "2015-10-29T18:35:16.473Z",
    "appVersion": "3.14.0",
    "dBVersion": "1.30",
    "url": "/seiapi/v3/trans/DiagData/j.doe@abcorp.com/2015-10-29/269"
  },
  {
    "seq": "270",
    "diagsDate": "2015-10-29T18:38:54.153Z",
    "appVersion": "3.14.0",
    "dBVersion": "1.30",
    "url": "/seiapi/v3/trans/DiagData/j.doe@abcorp.com/2015-10-29/270"
  },
  {
    "seq": "271",
    "diagsDate": "2015-10-29T18:50:36.240Z",
    "appVersion": "3.14.0",
    "dBVersion": "1.30",
    "url": "/seiapi/v3/trans/DiagData/j.doe@abcorp.com/2015-10-29/271"
  }
]

Diagnostic Data Body

The JSON format returned contains the diagnostic data that was collected from the mobile application. This content can vary and change based on the actual diagnostic script that was executed.  


Include Page
_REST Response Codes
_REST Response Codes