REST Standard REST APIs DiagData REST API

Resource URL Summary

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

Parameter Description

${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.

HTTP Headers
This API uses the default ServiceMobility HTTP Headers.

HTTP Body

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.

Example 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.

HTTP Response

Response Codes

HTTP Code	Description
200	OK. Request was processed successfully. Even though the request may return a successful code of 200, the body may still contain warning details.
400	Syntax error in request. The response body will provide more details on the specific reason. Verify the URI, its parameters, and request body.
401	Unauthorized. The credentials are incorrect, please verify and try again.
404	Not Found. The URL is incorrect, please verify and try again.
405	The specified HTTP method is not supported for this resource.
409	Conflict. This error usually occurs when attempting to overwrite an existing object that can not be replaced.
410	The specified object does not exists. Please verify the URI.
500	An error has occurred within ServiceMobility. Please review the error message details and if necessary, contact customer support.

Response Body

{
    "code": 400,
    "detail": {
        "message": "",
        "params": {
            "value": ""
        },
        "dataPath": ""
    }
}

Response Object Properties

Property

Type

Description

code

integer

The HTTP response code.

detail

object

This object provides additional details the system provided while processing the transactions. Usually the details provide additional information on why an error occurred. However, it may also provide warning details even when the requests was successful. For example, the request may have returned a response of 200=OK, but included warnings in the response body of properties that are still being used that are marked for deprecation.

Property	Type	Description
message	string	A human readable message related to the processing of the request.
params	collection	A collection of additional key/value pairs that contain the values that caused the warning/error condition.
dataPath	string	Identifies the location within the request body the message refers to.