...
Documents that a client needs to receive as a result of an order should be send in POST request to endpoint.
This is an example URL: https://saapi.yourlawyersmartadvocate.com:4430/sasvcdevsasvc/SAWebService.svc/Retrieval/Documents
Note that it will be generally different for different clients (SaaS clients can share the same URL).
...
Large binary documents can be sent to URL: https://sa.yourlawyeryourdomain.com:4430/sasvcdevsasvc/SAWebService.svc/Retrieval/UploadDocument?filename={filename}&RecordID={RecordID}&SACaseNumber={SACaseNumber}&SADocumentSubcategoryTypeID={SADocumentSubcategoryTypeID}&TypeName={TypeName}
Parameters:
Filename – a name of an uploaded file
RecordID – SA record ID
SACaseNumber – SmartAdvocate case number
...
PUT request should be send to endpoint: https://saapi.yourlawyersmartadvocate.com:4430/sasvcdevsasvc/SAWebService.svc/Retrieval/MedicalRequests/StatusUpdate
Code Block |
---|
[ { "RecordId": 30983, "Status": "Progress" }, { "RecordId": 473, "Status": "Completed" }, { "RecordId": 655, "Status": "Canceled" }, { "RecordId": 98547, "Status": "No Records" }, { "RecordId": 98547, "Status": "Rejected" } ] |
...
Invoice for service should be send in POST request to endpoint: https://saapi.yourlawyersmartadvocate.com:4430/sasvcdevsasvc/SAWebService.svc/Retrieval/MedicalRequests/Invoice
It will create a records in case Disbursements (costs) section.
...
Code Block |
---|
[{ "RecordID": 30969, "Type": "Medical Records", "InvoiceNo": "123456P", "InvoiceDate": "2020-05-26T00:00:00", "Amount": 1235.99, "Comments": "test comment", "DueDate" : "2020-05-26T00:00:00", "Description": "Smithtown hospital X-Ray", "PayeeName": "Best Retrieval Provider", }] |
...
"CheckNumber": "35648",
"DocumentID": 9876543
}]
|
Fields description:
RecordID(integer) – SA record ID
Type(string(100)) – Type of record (should match with client's record otherwise default parameter will be used)
InvoiceNo(string(5020)) – Invoice number
InvoiceDate(date) – Invoice date
Amount(decimal) – Invoice amount
Comments(string) – text comments if need to be added to invoice record
DueDate(date) – Invoice due date
Description(string(255)) – Invoice description (for example medical provider name)
PayeeName(string(500)) – Name of payee (should exact match with contact name in SmartAdvocate) CheckNumber(string(255)) – Check number
DocumentID (int) - ID of the uploaded document that needs to be linked to the invoice
Response:
if you submit two records in one request and one of those records fails, you will only receive one successfully recorded entry in the response and Status Code 200.
...
Sending Invoices (costs) to SmartAdvocate (Alternative Interface without RecordID)
https://saapi.yourlawyersmartadvocate.com:4430/sasvcdevsasvc/SAWebService.svc/Retrieval/MedicalRequests/Invoice
JSON structure:
Code Block |
---|
[{ "CaseNumber": "9000002", "CaseID": 3256, "Type": "Medical Records", "InvoiceNo": "123456P", "InvoiceDate": "2020-05-26T00:00:00", "Amount": 1235.99, "Comments": "test", "DueDate" : "2020-05-26T00:00:00", "Description": "Smithtown hospital X-Ray", "PayeeName": "Best Retrieval Provider" }] |
...
Message should be send in POST request to endpoint: https://saapi.yourlawyersmartadvocate.com:4430/sasvcdevsasvc/SAWebService.svc/Retrieval/MedicalRequests/Message
JSON structure:
Code Block | ||
---|---|---|
| ||
[ { "RecordID": 123465, "Message": "test" } ] |
...
Message should be send in POST request to endpoint: https://saapi.yourlawyersmartadvocate.com:4430/sasvcdevsasvc/SAWebService.svc/Retrieval/MedicalRequests/RequestNote
JSON structure:
Code Block | ||
---|---|---|
| ||
[ { "RecordID": 123465, "Message": "test" } ] |
...
Message should be send in PUT request to endpoint: https://saapi.yourlawyersmartadvocate.com:4430/sasvcdevsasvc/SAWebService.svc/Retrieval/MedicalRequests/RequestNote
JSON structure:
Code Block | ||
---|---|---|
| ||
[ { "RecordID": 123465, "Message": "test" } ] |
...
Retrieval service Order Id (number) should be send in POST request to the endpoint: https://saapi.yourlawyersmartadvocate.com:4430/sasvcdevsasvc/SAWebService.svc/Retrieval/MedicalRequests/InsertOrderID
JSON structure:
Code Block | ||
---|---|---|
| ||
[ { "RecordId": 11585, "OrderId": "123xyz" } ] |
...
POST request should be send to the endpoint: https://saapi.yourlawyersmartadvocate.com:4430/sasvcdevsasvc/SAWebService.svc/Retrieval/MedicalRequests/Copy
JSON structure:
Code Block | ||
---|---|---|
| ||
{ "RecordId":11585, "OrderId":"123xyz3", "Message":"test copy", "Status":"Completed" } |
...