Note

URL

https://external-api.seamless.insure/task/api/v1/notes

Method

POST

Headers

Content-Type: application/json

Authorization: Bearer {{accessToken}}

seamless-as-user: {{username}}

Body

{

    "Header": "Test 1",

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

    "NoteRelatedRecords": [

        {

            "ReferenceId": {{case-id}},

            "ReferenceType": "task"

        }

    ]

}

• This is a example request body, please see the sample request in Postman file.

• Note:

Replace {{case-id}} by the Id of Case data (see Case_API_Guide PDF file) in order to create note for a case.

"ReferenceType": default value is "task".

Response data

Please see the sample response in Postman file.

URL

https://external-api.seamless.insure/task/api/v1/notes/{{id}}

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

Method

PUT

Headers

Content-Type: application/json

Authorization: Bearer {{accessToken}}

seamless-as-user: {{username}}

Body

Same with Body of Create a note section

Response data

Please see the sample response in Postman file.

URL

https://external-api.seamless.insure/task/api/v1/notes/{{id}}

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

Method

DELETE

Headers

Content-Type: application/json

Authorization: Bearer {{accessToken}}

Response data

Success of failure status code

URL

https://external-api.seamless.insure/task/api/v1/notes/{{id}}

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

Method

GET

Headers

Content-Type: application/json

Authorization: Bearer {{accessToken}}

Response data

Please see the sample response in Postman file

URL

https://external-api.seamless.insure/task/api/v1/notes/getNotes

Method

POST

Headers

Content-Type: application/json

Authorization: Bearer {{accessToken}}

Request Body

{

    "Criteria": {

        "NoteRelatedRecords": [

            {

                "ReferenceType": "task",

                "ReferenceId": {{case-id}}

            }

        ]

    },

    "Page": 1,

    "ItemsPerPage": 10

}

• Please see the sample request in Postman file.

• Note:

Replace {{case-id}} by the Id of Case data (see Case_API_Guide PDF file) in order to create note for a case

Response data

Please see the sample response in Postman file