Postman Documentation with Examples
https://documenter.getpostman.com/view/5921778/UVeJM5kQ#58b4c01b-291d-49a4-b04c-d71e90e1ba07
Authentication
To authenticate your integration you will need to provide user id and password of an actual user defined in SmartAdvocate system. System administrators will be able to set permissions for this user to ensure that the integration only has access to appropriate cases and operations. This means that you might not be able to access certain cases and some of the operations (for example, Insert Note) might not be available.
POST RequestToken
https://app.smartadvocate.com/CaseSyncAPI/Users/authenticate
BODY raw
| Code Block | ||
|---|---|---|
| ||
{
"Username":"test",
"Password":"test"
} |
Returns user name, id and token.
| Code Block | ||
|---|---|---|
| ||
{
"username": "test",
"userID": 677,
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3NyIsImhvc3QiOiIiLCJuYmYiOjE2MjA2NjU2MjYsImV4cCI6MTYyMDY3MjgyNiwiaWF0IjoxNjIwNjY1NjI2LCJpc3MiOiJTbWFydEFkdm9jYXRlVGVzdCJ9.LA2ObLE4AAa_DvoYGSBP0A44aonFB_O7mqKcrZYrLXc"
} |
All other methods require authorization using bearer token - you will need to set the header "Authorization" with the value of "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3NyIsImhvc3QiOiIiLCJuYmYiOjE2MjA2NjU2MjYsImV4cCI6MTYyMDY3MjgyNiwiaWF0IjoxNjIwNjY1NjI2LCJpc3MiOiJTbWFydEFkdm9jYXRlVGVzdCJ9.LA2ObLE4AAa_DvoYGSBP0A44aonFB_O7mqKcrZYrLXc" for the above example.
Case
GET GetCaseInfo
https://app.smartadvocate.com/CaseSyncAPI/case/CaseInfo?Casenumber=9000002%
PARAMS
Casenumber 9000002%
Example Response
| Code Block | ||
|---|---|---|
| ||
[
{
"caseID": 516718,
"caseNumber": "9000002",
"caseTypeID": 1249,
"caseType": "ATS-Guatemala",
"caseStatusID": 827,
"caseStatus": "UM Arb Filed",
"caseStatusFrom": "2021-02-17T21:14:00Z",
"officeID": 2,
"officeName": "New York",
"plaintiffs": [
{
"id": 620837,
"name": "Tim, Berton",
"role": "(P)-Point of Contact",
"contactID": 1695568,
"primary": true,
"primaryContact": true
}
],
"secondStatuses": [
{
"statusID": 890,
"fromDate": "2021-04-30T16:37:00Z",
"statusTypeName": "Dialer Status",
"statusName": "Do not dial"
}
],
"createdDate": "2019-01-03T16:06:34.663Z",
"modifiedDate": "2021-08-03T20:22:58.41Z"
}
] |
CaseNotes
GET byCaseNumber
Get a list of notes by case number.
https://app.smartadvocate.com/CaseSyncAPI/case/notes/byCaseNumber?CaseNumber=9000002
PARAMS
CaseNumber
9000002
Example Response
| Code Block |
|---|
[
{
"noteID": 2764065,
"caseID": 516718,
"caseNumber": "9000002",
"noteTypeID": 42,
"noteTypeName": "Adjuster Defendant",
"noteText": "test <strong>sdfsdfsdf </strong>sdfsdfsdf",
"uniqueContactId": 1631752,
"uniqueContactName": "Ilinykh, Andrey",
"priority": "Normal",
"userID": 488,
"noteDate": "2021-05-03T20:08:00Z",
"createdDate": "2021-05-03T20:08:24.237Z",
"subject": "",
"isSharedinCP": false,
"isSharedWithAll": false
},
{
"noteID": 2762816,
"caseID": 516718,
"caseNumber": "9000002",
"noteTypeID": 10,
"noteTypeName": "Case",
"noteText": "Case Retained SignUp kit received",
"uniqueContactId": 1631752,
"uniqueContactName": "Selizhuk, Igor V., Esq.",
"priority": "Normal",
"userID": 345,
"noteDate": "2020-05-05T21:18:00Z",
"createdDate": "2020-05-05T21:17:46.97Z",
"subject": "",
"isSharedinCP": false,
"isSharedWithAll": false
}
] |
GET byCaseID
Get a list of notes by case id.
https://app.smartadvocate.com/CaseSyncAPI/case/5/notes
Example Response
| Code Block |
|---|
[
{
"noteID": 2764065,
"caseID": 516718,
"caseNumber": "9000002",
"noteTypeID": 42,
"noteTypeName": "Adjuster Defendant",
"noteText": "test <strong>sdfsdfsdf </strong>sdfsdfsdf",
"uniqueContactId": 1631752,
"uniqueContactName": "Ilinykh, Andrey",
"priority": "Normal",
"userID": 488,
"noteDate": "2021-05-03T20:08:00Z",
"createdDate": "2021-05-03T20:08:24.237Z",
"subject": "",
"isSharedinCP": false,
"isSharedWithAll": false
},
{
"noteID": 2762816,
"caseID": 516718,
"caseNumber": "9000002",
"noteTypeID": 10,
"noteTypeName": "Case",
"noteText": "Case Retained SignUp kit received",
"uniqueContactId": 1631752,
"uniqueContactName": "Selizhuk, Igor V., Esq.",
"priority": "Normal",
"userID": 345,
"noteDate": "2020-05-05T21:18:00Z",
"createdDate": "2020-05-05T21:17:46.97Z",
"subject": "",
"isSharedinCP": false,
"isSharedWithAll": false
}
] |
POST InsertNote
Insert a new note into a case.
https://app.smartadvocate.com/CaseSyncAPI/case/note
BODY Raw
| Code Block |
|---|
{
"caseID": 516718,
"noteTypeID": 90,
"noteText": "<b>UTC test - 2021-04-22T11:40:51 +05:00</b>",
"uniqueContactId": 1694683,
"priority": "Normal",
"formID": 0,
"noteDate": "2021-04-22T11:40:51+05:00",
"subject": "test",
"isSharedinCP": false,
"isSharedWithAll": false
} |
PUT UpdateNote
Update an existing note in a case.
https://app.smartadvocate.com/CaseSyncAPI/case/note
BODY Raw
| Code Block |
|---|
{
"noteID": 2763942,
"noteTypeID": 90,
"noteText": "test insert2",
"isSharedinCP": true,
"isSharedWithAll": false
} |
POST FilteredCaseNotes
Returns recently inserted/modified notes. List of case numbers is optional. Supports paging.
https://app.smartadvocate.com/CaseSyncAPI/case/notes/byDatePaged
BODY Raw
| Code Block |
|---|
{
"modifiedFromDateTime": "2020-05-01T05:00:00.0000000\u002B00:00",
"modifiedToDateTime": "2021-05-07T01:16:18.2190000\u002B00:00",
"caseNumbers": [
],
"pageRequest": {
"currentPage": 0,
"pageSize": 11
}
} |
...
Returns specific note identified by the note id.
https://app.smartadvocate.com/CaseSyncAPI/case/note/2763942
...
Returns note types defined in SmartAdvocate system.
https://app.smartadvocate.com/CaseSyncAPI/case/note/types
Example Response
...
| Child pages (Children Display) | ||
|---|---|---|
|