Import QuestionSet

This API is used to import QuestionSet from one instance of sunbird to another instance of sunbird.

This API is used to import QuestionSet from one instance of sunbird to another instance of sunbird.

POST /questionset/v2/import

• The endpoint for Import QuestionSet is /questionset/v2/import • It points to inquiry-api-service (assessment service) - /questionset/v5/import • All parameters marked with * are mandatory. You must provide values for these parameters. • Mandatory fields cannot be null or empty.

Path Parameters

Name	Type	Description
Content-Type*	String	The Content-Type entity is the media type of the resource. The possible media types can be: Application/json
Authorization*	String	You require authorization to make use of the API. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here. Set Bearer {{api_key}}
x-channel-id	String	Unique identification number associated with a root organization.

Request Body

Name	Type	Description
request*	Object	The body is the representation of the resource object for importing a question set

200: OK The Import QuestionSet operation was successful!

{
  "id": "api.questionset.import",
  "ver": "5.0",
  "ts": "2023-06-29T07:51:03ZZ",
  "params": {
    "resmsgid": "7cce8934-0a2f-46bf-a0ee-be5f49874cae",
    "msgid": null,
    "err": null,
    "status": "successful"2
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "processId": "80a765c7-2202-4b3f-b473-448b5c2cd20e"
  }
}

400: Bad Request The Import QuestionSet operation failed. You may have missed providing input for a mandatory parameter.'

{
  "id": "api.questionset.import",
  "ver": "5.0",
  "ts": "2023-06-29T07:51:03ZZ",
  "params": {
    "resmsgid": "31f88a39-2514-4d86-b424-240166e315be"
  },
  "msgid": null,
  "err": "ERR_REQUIRED_PROPS_VALIDATION",
  "status": "failed",
  "errmsg": "Validation Failed! Mandatory Properties Are [name, code, mimeType, primaryCategory, framework]",
  "responseCode": "CLIENT_ERROR",
  "result": {
    "messages": null
  }
}

500: Internal Server Error We track these errors automatically and try to set it right at the earliest.

{
  "id": "api.question.import",
  "ver": "5.0",
  "ts": "2023-06-29T07:51:03ZZ",
  "params": {
    "resmsgid": "f234a6f0-3ac4-11eb-b0a2-8d5c9f561887",
    "msgid": null,
    "status": "failed",
    "err": null,
    "errmsg": null
  },
  "responseCode": "SERVER_ERROR",
  "result": {}
}

Sample Request

{
  "request": {
    "questionset": [
      {
        "source": "https://dock.sunbirded.org/api/questionset/v2/read/do_1132613027022684161119",
        "metadata": {
          "framework": "ekstep_ncert_k-12",
          "channel": "01309282781705830427",
          "name": "QustionSet-1",
          "code": "9ae33d1e-a682-f30c-04b5-9bda236650ac",
          "lastPublishedBy": "5a587cc1-e018-4859-a0a8-e842650b9d64"
        },
        "collection": [
          {
            "identifier": "do_11324642736155033614",
            "unitId": "do_11324642761348710417"
          }
        ]
      }
    ]
  }
}

Request schema

Attribute	Description	Type
source	Represents the source of questionset object	string
metadata	Represents the additional metadata for the questionset object	Object
collection	Represents the collection with which Questionset can be linked.	Array of strings

Success result schema

Attribute	Type	Description
processId	String	Unique process ID

cURL

curl --location -g --request POST '{{host}}/questionset/v2/import' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{api_key}}' \
--header 'X-Channel-Id: {{channel_id}}' \
--data-raw '{
  "request": {
    "questionset": [
      {
        "source": "https://dock.sunbirded.org/api/questionset/v2/read/do_1132613027022684161119",
        "metadata": {
          "framework": "ekstep_ncert_k-12",
          "channel": "01309282781705830427",
          "name": "QustionSet-1",
          "code": "9ae33d1e-a682-f30c-04b5-9bda236650ac",
          "lastPublishedBy": "5a587cc1-e018-4859-a0a8-e842650b9d64"
        },
        "collection": [
          {
            "identifier": "do_11324642736155033614",
            "unitId": "do_11324642761348710417"
          }
        ]
      }
    ]
  }
}'