Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
  • Postman: Postman_example

  • Fields specs: Case_fields.specs.xlsx

  • Swagger: https://api.seamless.insure/task/documentation/#/tasks

1. Create a case

URL

https://external-api.seamless.insure/task/api/v2/tasks

Method

POST

Headers

Content-Type: application/json

Authorization: Bearer {{accessToken}}

Body

{

    "priority": 4,

    "title": "Test Case",

    "dueDate": "2023-12-25T16:59:59.999Z",

    "description": "<p>Test description</p>",

    "referenceType": {{workflow-id}},

    "queueId": {{queue-id}},

    "type": {{case-type-value}},

    "taskRelatedRecords": []

}

 

  • These values are example, please see the sample request in Postman file and fields specs in the sheet file for more details.

  • See priority options in the specs file.

  • We must make a request to Get case types API, we have response data ($ is at root):

Replace {{workflow-id}} by $.data.results[].workflowId of the response data.

Replace {{queue-id}} by $.data.results[].queueId of the response data.

Replace {{case-type-value}} by $.data.results[].value of the response data.

Response data

Please see the sample response in Postman file and fields specs in the sheet file

...

URL

https://external-api.seamless.insure/task/api/v2/tasks/{{id}}

(Please replace {{id}} with guid Id of Case on Seamless)

Method

PUT

Headers

Content-Type: application/json

Authorization: Bearer {{accessToken}}

Body

Same with Body of Create a case section

Response data

Please see the sample response in Postman file and fields specs in the sheet file

...

URL

https://external-api.seamless.insure/task/api/v2/tasks/getTasks

Method

POST

Headers

Content-Type: application/json

Authorization: Bearer {{accessToken}}

Request Body

{

    "page": 1,

    "itemsPerPage": 10,

    "criteria": {

        "order": {"reference": "DESC"},

        "assignee": {{username}}

    }

}

 

  • Note: these values are example, we can modify it.

Order direction value: ASC or DESC

Replace {{username}} with an username or null (default value is null)

Response data

Please see the sample response in Postman file and fields specs in the sheet file

...

URL

https://external-api.seamless.insure/task/api/v2/caseTypes/search

Method

POST

Headers

Content-Type: application/json

Authorization: Bearer {{accessToken}}

Request Body

{

"page": 1,

"itemsPerPage": 10,

"criteria": {

"order": {"name": "DESC"}

}

}

 

  • Note: these values is example, we can modify it.

Order direction value: ASC or DESC

Response data

Please see the sample response in Postman file and fields specs in the sheet file

 

image-20240221-071919.png

7. Add a task to the case

URL

https://external-api.seamless.insure/task/api/v2/tasks/{{caseID}}/subtasks/

Method

POST

Headers

Content-Type: application/json

Authorization: Bearer {{accessToken}}

Body

{
"title": "Checklist Item 1",
"description": "Important part of handling the case",
"priority": "Low/Normal/High/Critical",
"assignee": "",
"status": "10",
"dueDate": "2024-03-07T13:16:07.562Z"
}

Response data

Created task