S-Assist - API Reference

Updated on 27th March, 2024

Base URLs

Development:

• https://api.assist.sassist.marutisuzuki.com/dev

Staging

• https://api.assist.sassist.marutisuzuki.com/stage

Production:

• https://api.assist.sassist.marutisuzuki.com/v1

1. Ping

Description

The reachability of the host can be checked through the Ping API. The API responds with a pong to communicate availability to the requesting client.

Method

GET

URL

/ping

Headers

None

Query

None

Body

None

curl

curl -X GET 'https://api.assist.sassist.marutisuzuki.com/dev/ping'

Response Type

String

Response

pong

2. Healthchecks

Description

Internal healthchecks are run when the healthchecks API is invoked. This triggers a mechanism for the server to check the health of all connected services, and responds with a successful response if all systems are healthy.

Method

GET

URL

/healthchecks

Headers

None

Query

None

Body

None

curl

curl -X GET 'https://api.assist.sassist.marutisuzuki.com/dev/healthchecks'

Response Type

JSON

Response

{
    "code": "success",
    "error": false,
    "message": "Successful"
}

3. Authentication

Description

Users may be authenticated based on different mechanisms. In case of the user app, the API key provided for vendors allows implicit authentication. For internal systems, credentials from DMS are used. Separate email and password is provided for business users.

Method

POST

URL

/auths/login

Headers

• x-key: API Key issued by Xane for vendor authentication.
• x-identifier: Unique device identifier for the user.
• x-origin: Origin of any API call. Set this to 5 for the MSR app.
• x-platform: Device platform. Refer to the meta API for the full list of supported values.
• x-version: App release version of the app.
• user-agent: Optional, but recommended. User Agent used for calling the API.

Query

None

Body

• role_id: This identifier is used to determine the user’s role or level of access and limitations within the system or application. For end-users of S-Assist, this should be ‘1’.
• username: DMS username of the user. This is mandatory for the training data collection apps and acts as the primary identifier for the user in the system.
• password: Password used for authentication. This is mandatory for the apps that use either username or email for authentication.
• email: Email address of the user. This is mandatory if coming from the analytics or content management apps and acts as the primary identifier for the user in the system.
• phone: Phone number of the user. This is mandatory if coming from the user app and acts as the primary identifier for the user in the system.
• push_token: Optional. Push token for notifications.
• first_name: Optional. First name of the user.
• last_name: Optional. Last name of the user.
• gender: Optional. Gender of the user.
• date_of_birth: Optional. Date of birth of the user, in the yyyy-mm-dd format.`

curl

curl --location --request POST 'https://api.assist.sassist.marutisuzuki.com/dev/auths/login' \
--header 'x-key: 955e86a09a0049c39677f99d4a856d894ad909e026ec478f969c35d46e8f9755' \
--header 'x-identifier: 046d050fd5d1b5b1' \
--header 'x-origin: 5' \
--header 'x-platform: 3' \
--header 'x-version: 1' \
--header 'Content-Type: application/json' \
--data '{
    "role_id": 1,
    "phone": "8810474955",
    "first_name": "sahil",
    "last_name": "narain"
}'

Response Type

JSON

Response

{
  "code": "success",
  "error": false,
  "message": "Successful",
  "data": {
    "user": {
      "id": 4,
      "role_id": 3,
      "phone": "8810474955",
      "email": null,
      "username": null,
      "cms_admin": 0
    },
    "session": {
      "id": 92,
      "user_id": 4,
      "role_id": 3,
      "token": "cfd769acefc24dd4bcf133bc9512a04ddb838ab7d1d14207992ecc885a8ee166",
      "origin_id": 5,
      "platform_id": 3,
      "app_version": 1,
      "identifier": "046d050fd5d1b5b1",
      "user_agent": "curl/7.76.1",
      "expiry": "2024-06-20T08:32:31.000Z",
      "active": 1,
      "created_at": "2024-03-22T08:32:31.000Z"
    }
  }
}

4. Deauthentication

Description

Users may be deauthenticated at any time by calling this API. Equivalent to logging out, this forces the current authentication token to be invalidated.

Method

PUT

URL

/auths/logout

Headers

• x-auth: Session token for the end-user.
• x-identifier: Unique device identifier for the end-user.
• x-origin: Origin of any API call. 5 for the MSR app.
• x-platform: Device platform. 1 for Web, 2 for iOS, 3 for Android.
• x-version: App release version of the app.
• user-agent: Optional, but recommended. User Agent used for calling the API.

Query

None

Body

None

curl

curl --location --request PUT 'https://api.assist.sassist.marutisuzuki.com/dev/auths/login' \
--header 'x-auth: a6ae1442161043ff959607da5e169172982ebbd4383144bbb374cbba083279a6' \
--header 'x-identifier: 046d050fd5d1b5b1' \
--header 'x-origin: 5' \
--header 'x-platform: 3' \
--header 'x-version: 1'

Response Type

JSON

Response

{
  "code": "success",
  "error": false,
  "message": "Successful"
}

5. Get Models

Description

Provides details about car models present in S-Assist. This includes mapped sales codes and owner manual information.

Method

GET

URL

/models

Headers

• x-auth: Session token for the end-user.
• x-identifier: Unique device identifier for the end-user.
• x-origin: Origin of any API call. 5 for the MSR app.
• x-platform: Device platform. 1 for Web, 2 for iOS, 3 for Android.
• x-version: App release version of the app.
• user-agent: Optional, but recommended. User Agent used for calling the API.

Query

• make_id: Optional. Filters results by make_id.
• model_id: Optional. Filters results by model_id.
• sales_code: Optional. Filters results by sales_code. This can be used to fetch owner manuals for specific codes.

Body

None

curl

curl --location --request GET 'https://api.cms.sassist.marutisuzuki.com/stage/models?sales_code=BARDCS3' \
--header 'x-auth: 712727bceaca40d48b500d4db8756d4533da9f66eddc4f9182c0d739338219e1' \
--header 'x-identifier: 046d050fd5d1b5b1' \
--header 'x-origin: 6' \
--header 'x-platform: 1' \
--header 'x-version: 1'

Response Type

JSON

Response

{
  "code": "success",
  "error": false,
  "message": "Successful",
  "data": {
    "models": [
      {
        "id": 1,
        "make_id": 1,
        "make": "nexa",
        "make_code": "nexa",
        "model": "Baleno",
        "model_code": "baleno",
        "metadata": [
          {
            "id": 11,
            "sales_code": "BARDCS3",
            "manual_url": "https://sassist-s3-assist-public-production.s3.ap-south-1.amazonaws.com/owner-manuals/BALENO_99011M68P17-74E.pdf",
            "active": 1
          }
        ]
      }
    ]
  }
}

6. Create interactions

Description

API for interacting with Xane’s AI. Understands text or image and suggests related actions and content.

Method

POST

URL

/interactions

Headers

• x-auth: Session token for the end-user.
• `x-identifier: Unique device identifier for the end-user.
• x-origin: Origin of any API call. 5 for the MSR app.
• x-platform: Device platform. 1 for Web, 2 for iOS, 3 for Android.
• x-version: App release version of the app.
• user-agent: Optional, but recommended. User Agent used for calling the API.

Query

None

Body

• sales_code: sales code of the models on which the prediction is being requested.
• text: In case of text and verbal queries, this is the text or the transcript of the voice training data. At least one of text or image is required.
• image_url: In case of vision queries, this is the image url of the image to be used for training. At least one of text or image is required.
• latitude: Optional. Latitude of the location from which the query originates.
• longitude: Optional. Longitude of the location from which the query originates.
• battery_percentage: Optional. Battery percentage of the device from which the query originates.
• wifi: Optional. Indicator for mode of data connectivity. 0 for data, 1 for mobile hotspot or wifi.

curl

curl --location --request POST 'https://api.assist.sassist.marutisuzuki.com/stage/interactions' \
--header 'x-auth: 6c77f88086ca4b5f95b767fa154db311e4a9ab8e435f4c958888e89ef5c8cab1' \
--header 'x-identifier: 046d050fd5d1b5b1' \
--header 'x-origin: 5' \
--header 'x-platform: 3' \
--header 'x-version: 1' \
--header 'Content-Type: application/json' \
--data '{
    "sales_code": "BAR4AV1",
    "text": "steering",
    "latitude": 12.45,
    "longitude": 45.123,
    "wifi": 0,
    "battery_percentage": 96
}'

Response Type

JSON

Response

{
  "code": "success",
  "error": false,
  "message": "Successful",
  "data": {
    "interaction": {
      "id": 17,
      "active": 1,
      "created_at": "2024-03-22T08:42:51.000Z",
      "feedback": null,
      "feedback_comment": null,
      "user": {"id": 3059, "phone": "9442931316"},
      "product": {"make": {"id": 1, "make": "nexa", "code": "nexa"}, "model": {"id": 1, "model": "Baleno", "code": "baleno", "sales_code": "BAR4AV1"}},
      "query": {"content_type": {"id": 1, "content_type": "text"}, "content": {"text": "steering", "image_url": null}},
      "predictions": [
        {
          "feature_id": 116,
          "part_id": 3493,
          "part": "steering_wheel_2",
          "confidence": 0.966105,
          "content": {
            "icon": "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_wheel_2/icon/c178900e4c65439daeb06a6312026889.jpg",
            "blurb": "",
            "files": ["https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/288.pdf"],
            "title": "Steering",
            "images": {"top": ["https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_wheel_2/illustration/top/fe8526d81ce6420abe71a3bbcba0a2c2.jpg"], "bottom": [], "middle": []},
            "videos": [],
            "caution": "",
            "chapter": "",
            "warning": "",
            "description": {
              "top": "Check the play of the steering wheel by gently turning it from left to right and right to left, with wheels in straight ahead position and engine in OFF condition. Measure the distance that the steering moves before you feel slight resistance. The play should be between the specified values.\nCheck that the steering wheel turns easily and smoothly without rattling by turning it all the way to the right and to the left while driving very slowly in an open area. If the amount of free play is not as specified or you find anything else to be wrong, an inspection must be performed by your Maruti Suzuki authorised workshop.",
              "bottom": "",
              "middle": ""
            },
            "related_feature_ids": []
          }
        },
        {
          "feature_id": 162,
          "part_id": 3481,
          "part": "steering_switch_bluetooth_controls_1",
          "confidence": 0.00437791,
          "content": {
            "icon": "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/icon/c9ef8408464942f7ab0734eb74eecbd4.jpg",
            "blurb": "",
            "files": [
              "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/238.pdf",
              "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/239.pdf",
              "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/240.pdf",
              "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/241.pdf",
              "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/242.pdf",
              "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/243.pdf"
            ],
            "title": "Bluetooth® hands-free (if equipped)",
            "images": {
              "top": [
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/492b86f68144484b9d442e8488d6dcaf.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/ebc85016f4684a3a881a98a8b9728b32.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/14ebf8023764416bbbf687d67553f654.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/285bbe46e6af43ff918714714e7d0679.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/4d59dd927cde46fcba20a6ad4c3e624d.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/d95fae69cb6040308d0b214f26da2051.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/54b21e08afd643fdac4b1249ed17407b.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/72b0e8357db14fa18d9fb5f66a538b6a.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/271feec3d175490dabfaeeaa792550d0.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/cc43966f72844fd8b8179f5d166d1946.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/d8dc047acd5442678520c499aa047a03.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/ae06b1e613e04841879ba69b54535e49.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/dfaceebef89545ce83a568b306a01123.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/3be7356cfee14025a7be01602a549a8c.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/e600756d6a734dd38ec9eb39c73b71cb.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/ea7dbcfd3425470cbac210c7bfc83e71.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/a37914285c8b4f8a8e2445201c6bdccb.jpg"
              ],
              "bottom": [],
              "middle": []
            },
            "videos": [],
            "caution": "",
            "chapter": "",
            "warning": "",
            "description": {"top": "", "bottom": "", "middle": ""},
            "related_feature_ids": []
          }
        }
      ],
      "metadata": {
        "device": {"id": 3755, "identifier": "046d050fd5d1b5b1", "app_version": 1, "user_agent": "curl/8.4.0", "battery_percentage": 96, "wifi": 0},
        "origin": {"id": 5, "origin": "assist"},
        "platform": {"id": 3, "platform": "Android"},
        "location": {"latitude": 12.45, "longitude": 45.123}
      }
    }
  }
}

7. Get interaction history

Description

A history of interactions done by a user can be fetched through this API.

Method

GET

URL

/interactions

Headers

• x-auth: Session token for the end-user.
• x-identifier: Unique device identifier for the end-user.
• x-origin: Origin of any API call. 5 for the MSR app.
• x-platform: Device platform. 1 for Web, 2 for iOS, 3 for Android.
• x-version: App release version of the app.
• user-agent: Optional, but recommended. User Agent used for calling the API.

Query

• from: Optional. Date in the yyyy-mm-dd format, from which interactions are to be queried.
• to: Optional. Date in the yyyy-mm-dd format, till which interactions are to be queried.
• limit: Optional. Limits the number of results to the specified number. To be used in conjunction with offset.
• offset: Optional. Offsets the results by the specified number. To be used in conjunction with limit.

Body

None

curl

curl --location --request GET 'https://api.assist.sassist.marutisuzuki.com/stage/interactions?limit=2&offset=1' \
--header 'x-auth: 6c77f88086ca4b5f95b767fa154db311e4a9ab8e435f4c958888e89ef5c8cab1' \
--header 'x-identifier: 046d050fd5d1b5b1' \
--header 'x-origin: 5' \
--header 'x-platform: 3' \
--header 'x-version: 1'

Response Type

JSON

Response

{
  "code": "success",
  "error": false,
  "message": "Successful",
  "data": {
    "interactions": [
      {
        "id": 16,
        "active": 1,
        "created_at": "2024-03-22T08:42:12.000Z",
        "feedback": null,
        "feedback_comment": null,
        "user": {"id": 3059, "phone": "9442931316"},
        "product": {"make": {"id": 1, "make": "nexa", "code": "nexa"}, "model": {"id": 1, "model": "Baleno", "code": "baleno", "sales_code": "BAR4AV1"}},
        "query": {"content_type": {"id": 1, "content_type": "text"}, "content": {"text": "steering", "image_url": null}},
        "predictions": [
          {
            "feature_id": 116,
            "part_id": 3493,
            "part": "steering_wheel_2",
            "confidence": 0.966105,
            "content": {
              "icon": "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_wheel_2/icon/c178900e4c65439daeb06a6312026889.jpg",
              "blurb": "",
              "files": ["https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/288.pdf"],
              "title": "Steering",
              "images": {"top": ["https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_wheel_2/illustration/top/fe8526d81ce6420abe71a3bbcba0a2c2.jpg"], "bottom": [], "middle": []},
              "videos": [],
              "caution": "",
              "chapter": "",
              "warning": "",
              "description": {
                "top": "Check the play of the steering wheel by gently turning it from left to right and right to left, with wheels in straight ahead position and engine in OFF condition. Measure the distance that the steering moves before you feel slight resistance. The play should be between the specified values.\nCheck that the steering wheel turns easily and smoothly without rattling by turning it all the way to the right and to the left while driving very slowly in an open area. If the amount of free play is not as specified or you find anything else to be wrong, an inspection must be performed by your Maruti Suzuki authorised workshop.",
                "bottom": "",
                "middle": ""
              },
              "related_feature_ids": []
            }
          },
          {
            "feature_id": 162,
            "part_id": 3481,
            "part": "steering_switch_bluetooth_controls_1",
            "confidence": 0.00437791,
            "content": {
              "icon": "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/icon/c9ef8408464942f7ab0734eb74eecbd4.jpg",
              "blurb": "",
              "files": [
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/238.pdf",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/239.pdf",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/240.pdf",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/241.pdf",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/242.pdf",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/243.pdf"
              ],
              "title": "Bluetooth® hands-free (if equipped)",
              "images": {
                "top": [
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/492b86f68144484b9d442e8488d6dcaf.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/ebc85016f4684a3a881a98a8b9728b32.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/14ebf8023764416bbbf687d67553f654.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/285bbe46e6af43ff918714714e7d0679.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/4d59dd927cde46fcba20a6ad4c3e624d.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/d95fae69cb6040308d0b214f26da2051.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/54b21e08afd643fdac4b1249ed17407b.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/72b0e8357db14fa18d9fb5f66a538b6a.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/271feec3d175490dabfaeeaa792550d0.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/cc43966f72844fd8b8179f5d166d1946.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/d8dc047acd5442678520c499aa047a03.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/ae06b1e613e04841879ba69b54535e49.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/dfaceebef89545ce83a568b306a01123.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/3be7356cfee14025a7be01602a549a8c.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/e600756d6a734dd38ec9eb39c73b71cb.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/ea7dbcfd3425470cbac210c7bfc83e71.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/a37914285c8b4f8a8e2445201c6bdccb.jpg"
                ],
                "bottom": [],
                "middle": []
              },
              "videos": [],
              "caution": "",
              "chapter": "",
              "warning": "",
              "description": {"top": "", "bottom": "", "middle": ""},
              "related_feature_ids": []
            }
          }
        ],
        "metadata": {
          "device": {"id": 3755, "identifier": "046d050fd5d1b5b1", "app_version": 1, "user_agent": "curl/8.4.0", "battery_percentage": 96, "wifi": 0},
          "origin": {"id": 5, "origin": "assist"},
          "platform": {"id": 3, "platform": "Android"},
          "location": {"latitude": 12.45, "longitude": 45.123}
        }
      },
      {
        "id": 15,
        "active": 1,
        "created_at": "2024-03-22T08:41:51.000Z",
        "feedback": null,
        "feedback_comment": null,
        "user": {"id": 3059, "phone": "9442931316"},
        "product": {"make": {"id": 1, "make": "nexa", "code": "nexa"}, "model": {"id": 1, "model": "Baleno", "code": "baleno", "sales_code": "BAR4AV1"}},
        "query": {"content_type": {"id": 1, "content_type": "text"}, "content": {"text": "steering", "image_url": null}},
        "predictions": [
          {
            "feature_id": 116,
            "part_id": 3493,
            "part": "steering_wheel_2",
            "confidence": 0.966105,
            "content": {
              "icon": "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_wheel_2/icon/c178900e4c65439daeb06a6312026889.jpg",
              "blurb": "",
              "files": ["https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/288.pdf"],
              "title": "Steering",
              "images": {"top": ["https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_wheel_2/illustration/top/fe8526d81ce6420abe71a3bbcba0a2c2.jpg"], "bottom": [], "middle": []},
              "videos": [],
              "caution": "",
              "chapter": "",
              "warning": "",
              "description": {
                "top": "Check the play of the steering wheel by gently turning it from left to right and right to left, with wheels in straight ahead position and engine in OFF condition. Measure the distance that the steering moves before you feel slight resistance. The play should be between the specified values.\nCheck that the steering wheel turns easily and smoothly without rattling by turning it all the way to the right and to the left while driving very slowly in an open area. If the amount of free play is not as specified or you find anything else to be wrong, an inspection must be performed by your Maruti Suzuki authorised workshop.",
                "bottom": "",
                "middle": ""
              },
              "related_feature_ids": []
            }
          },
          {
            "feature_id": 162,
            "part_id": 3481,
            "part": "steering_switch_bluetooth_controls_1",
            "confidence": 0.00437791,
            "content": {
              "icon": "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/icon/c9ef8408464942f7ab0734eb74eecbd4.jpg",
              "blurb": "",
              "files": [
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/238.pdf",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/239.pdf",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/240.pdf",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/241.pdf",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/242.pdf",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/243.pdf"
              ],
              "title": "Bluetooth® hands-free (if equipped)",
              "images": {
                "top": [
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/492b86f68144484b9d442e8488d6dcaf.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/ebc85016f4684a3a881a98a8b9728b32.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/14ebf8023764416bbbf687d67553f654.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/285bbe46e6af43ff918714714e7d0679.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/4d59dd927cde46fcba20a6ad4c3e624d.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/d95fae69cb6040308d0b214f26da2051.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/54b21e08afd643fdac4b1249ed17407b.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/72b0e8357db14fa18d9fb5f66a538b6a.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/271feec3d175490dabfaeeaa792550d0.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/cc43966f72844fd8b8179f5d166d1946.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/d8dc047acd5442678520c499aa047a03.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/ae06b1e613e04841879ba69b54535e49.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/dfaceebef89545ce83a568b306a01123.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/3be7356cfee14025a7be01602a549a8c.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/e600756d6a734dd38ec9eb39c73b71cb.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/ea7dbcfd3425470cbac210c7bfc83e71.jpg",
                  "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/a37914285c8b4f8a8e2445201c6bdccb.jpg"
                ],
                "bottom": [],
                "middle": []
              },
              "videos": [],
              "caution": "",
              "chapter": "",
              "warning": "",
              "description": {"top": "", "bottom": "", "middle": ""},
              "related_feature_ids": []
            }
          }
        ],
        "metadata": {
          "device": {"id": 3755, "identifier": "046d050fd5d1b5b1", "app_version": 1, "user_agent": "curl/7.76.1", "battery_percentage": 96, "wifi": 0},
          "origin": {"id": 5, "origin": "assist"},
          "platform": {"id": 3, "platform": "Android"},
          "location": {"latitude": 12.45, "longitude": 45.123}
        }
      }
    ]
  }
}

8. Get interaction details

Description

Details for a particular training can be fetched using an id.

Method

GET

URL

/interactions/:id

Headers

• x-auth: Session token for the end-user.
• x-identifier: Unique device identifier for the end-user.
• x-origin: Origin of any API call. 5 for the MSR app.
• x-platform: Device platform. 1 for Web, 2 for iOS, 3 for Android.
• x-version: App release version of the app.
• user-agent: Optional, but recommended. User Agent used for calling the API.

Query

None

Body

None

curl

curl --location --request GET 'http://api.assist.sassist.marutisuzuki.com/stage/interactions/13' \
--header 'x-auth: 6c77f88086ca4b5f95b767fa154db311e4a9ab8e435f4c958888e89ef5c8cab1' \
--header 'x-identifier: 046d050fd5d1b5b1' \
--header 'x-origin: 5' \
--header 'x-platform: 3' \
--header 'x-version: 1' \
--data ''

Response Type

JSON

Response

{
    "code": "success",
    "error": false,
    "message": "Successful",
    "data": {
        "interaction": {
            "id": 13,
            "active": 1,
            "created_at": "2024-03-22T07:52:18.000Z",
            "feedback": null,
            "feedback_comment": null,
            "user": {
                "id": 3059,
                "phone": "9442931316"
            },
            "product": {
                "make": {
                    "id": 1,
                    "make": "nexa",
                    "code": "nexa"
                },
                "model": {
                    "id": 1,
                    "model": "Baleno",
                    "code": "baleno",
                    "sales_code": "BAR4AV1"
                }
            },
            "query": {
                "content_type": {
                    "id": 1,
                    "content_type": "text"
                },
                "content": {
                    "text": "steering",
                    "image_url": null
                }
            },
            "predictions": [
                {
                    "feature_id": 116,
                    "part_id": 3493,
                    "part": "steering_wheel_2",
                    "confidence": 0.966105,
                    "content": {
                        "icon": "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_wheel_2/icon/c178900e4c65439daeb06a6312026889.jpg",
                        "blurb": "",
                        "files": [
                            "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/288.pdf"
                        ],
                        "title": "Steering",
                        "images": {
                            "top": [
                                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_wheel_2/illustration/top/fe8526d81ce6420abe71a3bbcba0a2c2.jpg"
                            ],
                            "bottom": [],
                            "middle": []
                        },
                        "videos": [],
                        "caution": "",
                        "chapter": "",
                        "warning": "",
                        "description": {
                            "top": "Check the play of the steering wheel by gently turning it from left to right and right to left, with wheels in straight ahead position and engine in OFF condition. Measure the distance that the steering moves before you feel slight resistance. The play should be between the specified values.\nCheck that the steering wheel turns easily and smoothly without rattling by turning it all the way to the right and to the left while driving very slowly in an open area. If the amount of free play is not as specified or you find anything else to be wrong, an inspection must be performed by your Maruti Suzuki authorised workshop.",
                            "bottom": "",
                            "middle": ""
                        },
                        "related_feature_ids": []
                    }
                },
                {
                    "feature_id": 162,
                    "part_id": 3481,
                    "part": "steering_switch_bluetooth_controls_1",
                    "confidence": 0.00437791,
                    "content": {
                        "icon": "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/icon/c9ef8408464942f7ab0734eb74eecbd4.jpg",
                        "blurb": "",
                        "files": [
                            "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/238.pdf",
                            "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/239.pdf",
                            "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/240.pdf",
                            "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/241.pdf",
                            "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/242.pdf",
                            "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/243.pdf"
                        ],
                        "title": "Bluetooth® hands-free (if equipped)",
                        "images": {
                            "top": [
                                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/492b86f68144484b9d442e8488d6dcaf.jpg",
                                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/ebc85016f4684a3a881a98a8b9728b32.jpg",
                                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/14ebf8023764416bbbf687d67553f654.jpg",
                                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/285bbe46e6af43ff918714714e7d0679.jpg",
                                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/4d59dd927cde46fcba20a6ad4c3e624d.jpg",
                                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/d95fae69cb6040308d0b214f26da2051.jpg",
                                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/54b21e08afd643fdac4b1249ed17407b.jpg",
                                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/72b0e8357db14fa18d9fb5f66a538b6a.jpg",
                                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/271feec3d175490dabfaeeaa792550d0.jpg",
                                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/cc43966f72844fd8b8179f5d166d1946.jpg",
                                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/d8dc047acd5442678520c499aa047a03.jpg",
                                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/ae06b1e613e04841879ba69b54535e49.jpg",
                                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/dfaceebef89545ce83a568b306a01123.jpg",
                                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/3be7356cfee14025a7be01602a549a8c.jpg",
                                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/e600756d6a734dd38ec9eb39c73b71cb.jpg",
                                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/ea7dbcfd3425470cbac210c7bfc83e71.jpg",
                                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/a37914285c8b4f8a8e2445201c6bdccb.jpg"
                            ],
                            "bottom": [],
                            "middle": []
                        },
                        "videos": [],
                        "caution": "",
                        "chapter": "",
                        "warning": "",
                        "description": {
                            "top": "",
                            "bottom": "",
                            "middle": ""
                        },
                        "related_feature_ids": []
                    }
                }
            ],
            "metadata": {
                "device": {
                    "id": 3755,
                    "identifier": "046d050fd5d1b5b1",
                    "app_version": 1,
                    "user_agent": "PostmanRuntime/7.37.0",
                    "battery_percentage": 96,
                    "wifi": 0
                },
                "origin": {
                    "id": 5,
                    "origin": "assist"
                },
                "platform": {
                    "id": 3,
                    "platform": "Android"
                },
                "location": {
                    "latitude": 12.45,
                    "longitude": 45.123
                }
            }
        }
    }
}

9. Update interactions

Description

Limited updates are allowed on an interaction. A user is allowed to provide feedback for an interaction that has returned a prediction.

Method

PUT

URL

/interactions/:id

Headers

• x-auth: Session token for the end-user.
• x-identifier: Unique device identifier for the end-user.
• x-origin: Origin of any API call. 5 for the MSR app.
• x-platform: Device platform. 1 for Web, 2 for iOS, 3 for Android.
• x-version: App release version of the app.
• user-agent: Optional, but recommended. User Agent used for calling the API.

Query

None

Body

• feedback: description of param1
• feedback_comment: description of param2
• active: Optional. Allows deletion and undoing of deletion for the interactions

curl

curl --location --request PUT 'https://api.assist.sassist.marutisuzuki.com/stage/interactions/13' \
--header 'x-auth: 6c77f88086ca4b5f95b767fa154db311e4a9ab8e435f4c958888e89ef5c8cab1' \
--header 'x-identifier: 046d050fd5d1b5b1' \
--header 'x-origin: 5' \
--header 'x-platform: 3' \
--header 'x-version: 1' \
--header 'Content-Type: application/json' \
--data '{
    "feedback": 1,
    "feedback_comment": "Accurate"
}'

Response Type

JSON

Response

{
  "code": "success",
  "error": false,
  "message": "Successful",
  "data": {
    "interaction": {
      "id": 13,
      "active": 1,
      "created_at": "2024-03-22T07:52:18.000Z",
      "feedback": 1,
      "feedback_comment": "Accurate",
      "user": {"id": 3059, "phone": "9442931316"},
      "product": {"make": {"id": 1, "make": "nexa", "code": "nexa"}, "model": {"id": 1, "model": "Baleno", "code": "baleno", "sales_code": "BAR4AV1"}},
      "query": {"content_type": {"id": 1, "content_type": "text"}, "content": {"text": "steering", "image_url": null}},
      "predictions": [
        {
          "feature_id": 116,
          "part_id": 3493,
          "part": "steering_wheel_2",
          "confidence": 0.966105,
          "content": {
            "icon": "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_wheel_2/icon/c178900e4c65439daeb06a6312026889.jpg",
            "blurb": "",
            "files": ["https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/288.pdf"],
            "title": "Steering",
            "images": {"top": ["https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_wheel_2/illustration/top/fe8526d81ce6420abe71a3bbcba0a2c2.jpg"], "bottom": [], "middle": []},
            "videos": [],
            "caution": "",
            "chapter": "",
            "warning": "",
            "description": {
              "top": "Check the play of the steering wheel by gently turning it from left to right and right to left, with wheels in straight ahead position and engine in OFF condition. Measure the distance that the steering moves before you feel slight resistance. The play should be between the specified values.\nCheck that the steering wheel turns easily and smoothly without rattling by turning it all the way to the right and to the left while driving very slowly in an open area. If the amount of free play is not as specified or you find anything else to be wrong, an inspection must be performed by your Maruti Suzuki authorised workshop.",
              "bottom": "",
              "middle": ""
            },
            "related_feature_ids": []
          }
        },
        {
          "feature_id": 162,
          "part_id": 3481,
          "part": "steering_switch_bluetooth_controls_1",
          "confidence": 0.00437791,
          "content": {
            "icon": "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/icon/c9ef8408464942f7ab0734eb74eecbd4.jpg",
            "blurb": "",
            "files": [
              "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/238.pdf",
              "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/239.pdf",
              "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/240.pdf",
              "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/241.pdf",
              "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/242.pdf",
              "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/243.pdf"
            ],
            "title": "Bluetooth® hands-free (if equipped)",
            "images": {
              "top": [
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/492b86f68144484b9d442e8488d6dcaf.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/ebc85016f4684a3a881a98a8b9728b32.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/14ebf8023764416bbbf687d67553f654.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/285bbe46e6af43ff918714714e7d0679.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/4d59dd927cde46fcba20a6ad4c3e624d.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/d95fae69cb6040308d0b214f26da2051.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/54b21e08afd643fdac4b1249ed17407b.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/72b0e8357db14fa18d9fb5f66a538b6a.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/271feec3d175490dabfaeeaa792550d0.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/cc43966f72844fd8b8179f5d166d1946.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/d8dc047acd5442678520c499aa047a03.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/ae06b1e613e04841879ba69b54535e49.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/dfaceebef89545ce83a568b306a01123.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/3be7356cfee14025a7be01602a549a8c.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/e600756d6a734dd38ec9eb39c73b71cb.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/ea7dbcfd3425470cbac210c7bfc83e71.jpg",
                "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/steering_switch_bluetooth_controls_1/illustration/top/a37914285c8b4f8a8e2445201c6bdccb.jpg"
              ],
              "bottom": [],
              "middle": []
            },
            "videos": [],
            "caution": "",
            "chapter": "",
            "warning": "",
            "description": {"top": "", "bottom": "", "middle": ""},
            "related_feature_ids": []
          }
        }
      ],
      "metadata": {
        "device": {"id": 3755, "identifier": "046d050fd5d1b5b1", "app_version": 1, "user_agent": "PostmanRuntime/7.37.0", "battery_percentage": null, "wifi": null},
        "origin": {"id": 5, "origin": "assist"},
        "platform": {"id": 3, "platform": "Android"},
        "location": {"latitude": 12.45, "longitude": 45.123}
      }
    }
  }
}

10. Get documents

Description

Business users and consumers can fetch documents that have been previously created and approved on the CMS.

Method

GET

URL

/documents

Headers

• x-auth: Session token for the end-user.
• x-identifier: Unique device identifier for the end-user.
• x-origin: Origin of any API call. 5 for the MSR app.
• x-platform: Device platform. 1 for Web, 2 for iOS, 3 for Android.
• x-version: App release version of the app.
• user-agent: Optional, but recommended. User Agent used for calling the API.

Query

• model_id: The model ID for which documents are being fetched. At least one of model_id or feature_id is mandatory.
• feature_id: The feature ID for which documents are being fetched. At least one of model_id or feature_id is mandatory.
• version: Optional. Filter for getting a specific version of documents.
• approved: Optional. Filter for getting approved documents.
• active: Optional. Filter for documents based on active.
• model_metadata_id: Optional. The ID of the model metadata object for which results may be filtered.
• sales_code: Optional. The sales code of the variant for which documents may be filtered.

Body

None

curl

curl --location --request GET 'https://api.assist.sassist.marutisuzuki.com/stage/documents?feature_id=1&sales_code=ER4CS3' \
--header 'x-auth: 6c77f88086ca4b5f95b767fa154db311e4a9ab8e435f4c958888e89ef5c8cab1' \
--header 'x-identifier: 046d050fd5d1b5b1' \
--header 'x-origin: 5' \
--header 'x-platform: 3' \
--header 'x-version: 1' \
--header 'Content-Type: application/json' \
--data ''

Response Type

JSON

Response

{
  "code": "success",
  "error": false,
  "message": "Successful",
  "data": {
    "documents": [
      {
        "id": 1,
        "name": "Version 1",
        "description": "version 1",
        "feature_id": 1,
        "make": "nexa",
        "model": "Baleno",
        "part": "air_conditioning_filter_element_2",
        "verbal": 1,
        "vision": 1,
        "critical": 0,
        "content": {
          "icon": "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/air_conditioning_filter_element_2/icon/e373fb8ce83f4e4d9f6363a8b84639b0.jpg",
          "blurb": "Since special procedures are required, we recommend you take your vehicle to your Maruti Suzuki authorised workshop for the air conditioner filter replacement.",
          "files": ["https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/308.pdf", "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/split/Baleno/309.pdf"],
          "title": "Replacement of the Air Conditioner Filter",
          "images": {
            "top": [],
            "bottom": ["https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/air_conditioning_filter_element_2/illustration/bottom/4779488849db4b1db20badd0406dcfe0.jpg"],
            "middle": ["https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/air_conditioning_filter_element_2/illustration/middle/bf348cd3a71847a2ae5e38f59d5af5eb.jpg"]
          },
          "videos": [
            "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/air_conditioning_filter_element_2/video/7dc7fb6ab42f46ab9bf4a3817a4d799f.mp4",
            "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-staging/cms/nexa/baleno/air_conditioning_filter_element_2/videos/5e50a46fcad04e5aa3e939fc0d11537a.mp4"
          ],
          "caution": "",
          "chapter": "",
          "warning": "",
          "description": {
            "top": "Since special procedures are required, we recommend you take your vehicle to your Maruti Suzuki authorised workshop for the air conditioner filter replacement.",
            "bottom": "2) Remove the cover (1) and pull out the air conditioner filter (2)",
            "middle": "1) To approach the air conditioner filter, press inward on both sides of the grove box, pull it frontward and remove it."
          },
          "related_features": [
            {
              "id": 2,
              "part": "airbag_label_2",
              "content": {"title": "Airbag symbol meaning", "icon": "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/airbag_label_2/icon/424479479bd4476386f0387c6658eefb.jpg"}
            },
            {
              "id": 4,
              "part": "anti_lock_brake_system_abs_warning_light_2",
              "content": {
                "title": "Anti-Lock Brake System (ABS) Warning Light",
                "icon": "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/anti_lock_brake_system_abs_warning_light_2/icon/54a498c09bef48ed8b1c0549740a68c7.jpg"
              }
            },
            {
              "id": 83,
              "part": "manual_heating_and_air_conditioning_system_2",
              "content": {
                "title": "Manual Heating and Air Conditioning System",
                "icon": "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-data-production/cms/nexa/baleno/manual_heating_and_air_conditioning_system_2/icon/354d597054374946afc8d8e2fcfc09c4.jpg"
              }
            }
          ],
          "related_feature_ids": [2, 4, 83]
        },
        "version": 5,
        "approved": 1,
        "editor_user_id": 37827,
        "editor_user_first_name": "Shilpa",
        "approver_user_first_name": "MSIL",
        "approver_user_id": 58,
        "active": 1,
        "created_at": "2024-02-15T13:46:50.000Z",
        "metadata": [
          {"id": 3, "active": 1, "model_metadata_id": 58, "model_metadata_active": 1, "sales_code": "ER4CS3", "manual_url": "https://s3.ap-south-1.amazonaws.com/sassist-s3-assist-public-production/owner-manuals/BALENO_99011M68P17-74E.pdf"}
        ]
      }
    ]
  }
}