Types, Examples, and Response

In this article, you will find important information about how to use the Testinvite’s API for fetching test results according to ticket ids. First, structure and types of the request body will be explained, then some examples of calls are given in Postman and in different programming languages. Lastly, the structure of the response body will be explained.

To try the available API requests immediately, you can check the Postman collection provided for you. Please click here to download the Postman collection.

Types

There are 4 required properties for fetching test results related with a ticket: "requester", "taskId", "kind", and "tickets".

• requester is an object consisting of two properties: "auth" and "name". In the "auth" object, you need to include your organization's id and organization's private key. For "name", you can put your institution's name. It is how you'll be known as in our logs.
• taskId is the id of the task that contains the test results you are fetching. In one request, you can only fetch test results which are under the same task.
• kind is the method of fetching test results. The only method implemented is by using a ticket id. Therefore, its value is "by-ticket".
• tickets is an array of objects. Each object has 2 properties: "ticketId" and "stepTestCustomReporting".
  • ticketId is the id of the ticket whose test results you are fetching. You can find ids of tickets in the response of the ticket creation.
  • stepTestCustomReporting is an optional object that can have one of two values. If provided, the renders of custom reports will be sent back along with the test results for the provided ticket id.

You can find request body's types in chart below representing body in tree view.

Examples

In the examples below, you can see different fetch requests with slightly different bodies. In each example, there is a request body in JSON format and a request example written in cURL. You can copy and use these examples for your own account simply by swapping in your organization's id, private key, task id etc. To fetch your candidates' test results you should employ ticket ids that you got from ticket creation request's response.

Fetching Results

Code examples below contain only required properties and are created for one ticket. You can see one object with "ticketId" property in the "tickets" array.

{
   "requester": {
      "name": "Organization Name",
      "auth": {
        "organizationId": "zUH8oMYJ60As4HYP",
        "privateKey": "a8faef00-43c1-11ed-81bc-976010"
      }
   },
   "taskId": "tcxHArKva33C8VxCZcjy",
   "kind": "by-ticket",
   "tickets": [
      {
        "ticketId": "33C8VxCZcjytcxHAr"
      }
   ]
}
                    

curl --location --request POST 
'https://www.testinvite.com/api/v1/fatih/query-test-results' \
--header 'Content-Type: application/json' \
--data-raw '{
   "requester": {
      "name": "Organization Name",
      "auth": {
        "organizationId": "zUH8oMYJ60As4HYP48Zx",
        "privateKey": "76f75bd0-4315-11ed-98ad-1127beb80c0d"
      }
   },
   "taskId": "Qj33evNTg7IjLnao2Ux1",
   "kind": "by-ticket",
   "tickets": [
      {
        "ticketId": "0dxZm5WJ42cbxCP6DQbn"
      }
   ]
}'
          

Fetching Results With Custom Reporting

The example below shows a request used to obtain the render of a custom a report of your choosing along with the result data.

{
   "requester": {
      "name": "Organization Name",
      "auth": {
        "organizationId": "zUH8oMYJ60As4HYP",
        "privateKey": "a8faef00-43c1-11ed-81bc-976010"
      }
   },
   "taskId": "tcxHArKva33C8VxCZcjy",
   "kind": "by-ticket",
   "tickets": [
      {
        "ticketId": "33C8VxCZcjytcxHAr",
        "stepTestCustomReporting": {
            "kind": "custom",
            "id": "bsfDAS67ds5p34ab"
        }
      }
   ]
}
                    

curl --location --request POST 
'https://www.testinvite.com/api/v1/fatih/query-test-results' \
--header 'Content-Type: application/json' \
--data-raw '{
   "requester": {
      "name": "Organization Name",
      "auth": {
        "organizationId": "zUH8oMYJ60As4HYP48Zx",
        "privateKey": "76f75bd0-4315-11ed-98ad-1127beb80c0d"
      }
   },
   "taskId": "Qj33evNTg7IjLnao2Ux1",
   "kind": "by-ticket",
   "tickets": [
      {
        "ticketId": "0dxZm5WJ42cbxCP6DQbn",
        "stepTestCustomReporting": {
            "kind": "custom",
            "id": "bsfDAS67ds5p34ab"
        }
      }
   ]
}'
          

Fetching Results for Multiple Tickets

Requests below have two ticket ids in the tickets array which means that response will include multiple results in its "payload" array.

{
   "requester": {
      "name": "Organization Name",
      "auth": {
        "organizationId": "zUH8oMYJ60As4HYP48Zx",
        "privateKey": "76f75bd0-4315-11ed-98ad-1127beb80c"   
      }
   },
   "taskId": "Qj33evNTg7IjLnao2Ux1",
   "kind": "by-ticket",
   "tickets": [
      {
        "ticketId": "0dxZm5WJ42cbxCP6DQbn"
      },
      {
        "ticketId": "xCP6DQbn0dxZm5WJ42cb"
      }
   ]
}
          

curl --location --request POST 
'https://www.testinvite.com/api/v1/fatih/query-test-results' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requester": {
      "name": "Organization Name",
      "auth": {
        "organizationId": "zUH8oMYJ60As4HYP48Zx",
        "privateKey": "76f75bd0-4315-11ed-98ad-1127beb80c0d"
       }
    },
    "taskId": "Qj33evNTg7IjLnao2Ux1",
    "kind": "by-ticket",
    "tickets": [
       {
          "ticketId": "0dxZm5WJ42cbxCP6DQbn"
       },
       {
          "ticketId": "ggHtHoz0LbATu5C2VGGn"
       }
    ]
}'