Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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://sa.yourlawyer.com:4430/sasvcdev/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.yourlawyer.com:4430/sasvcdev/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

SADocumentSubcategoryTypeID - Document Subcategory Type ID

TypeName - Document Type Name

Update Status of Requests

PUT request should be send to endpoint: https://sa.yourlawyer.com:4430/sasvcdev/SAWebService.svc/Retrieval/MedicalRequests/StatusUpdate

Code Block
[
    {
        "RecordId": 1,
        "Status": "Progress"
    },
    {
        "RecordId": 2,
        "Status": "Completed"
    },
    {
        "RecordId": 3,
        "Status": "Canceled"
    },
    {
        "RecordId": 4,
        "Status": "No Records"
    }
]

Fields description:
RecordID(integer) – SA record ID (Record have to marked as Read.)
Status(string)   – Status of request. Request in SA will update depends of settings. 

...

Invoice for servicing should be send in POST request to endpoint: https://sa.yourlawyer.com:4430/sasvcdev/SAWebService.svc/Retrieval/MedicalRequests/Invoice

JSON structure:

Code Block
{
	"RecordID": 30969,
	"Type": "Medical Records",
	"InvoiceNo": "123456P",
	"InvoiceDate": "2020-05-26T00:00:00",
	"Amount": 1235.99,
	"Comments": ""
}

...

Sending Invoices to SmartAdvocate (Alternative Interface without RecordID)

https://sa.yourlawyer.com:4430/sasvcdev/sawebservice.svc/receiver/RetrievalService/Invoice/

JSON structure:

Code Block
{
	"CaseNumber": "9000002",
	"Type": "Medical Records",
	"InvoiceNo": "123456P",
	"InvoiceDate": "2020-05-26T00:00:00",
	"Amount": 1235.99,
	"Comments": "test"
}


Fields description:
CaseNumber(string) – SA Case number
Type(string) – Type of record (should match with client's record otherwise default parameter will be used)
InvoiceNo(string) – Invoice number
InvoiceDate(date) – Invoice date
Amount(decimal) – Invoice Amount
Comments(string) – text comments if need to be added to invoice record

...

Sending message from retrieval service (POST request from Retrieval service)

Message should be send in POST request to endpoint: https://sa.yourlawyer.com:4430/sasvcdev/SAWebService.svc/Retrieval/MedicalRequests/Message

JSON structure:

Code Block
languagejson
[
    {
        "RecordID": 123465,
        "Message": "test"
    }
]


Fields description:
RecordID(integer) – SA record ID
Message (string) – message

Add retrieval service Note to Medical request (POST request from Retrieval service)

Text will be added to Retrieval Provider Notes of Medical request.

Message should be send in POST request to endpoint: https://sa.yourlawyer.com:4430/sasvcdev/SAWebService.svc/Retrieval/MedicalRequests/RequestNote

JSON structure:

Code Block
languagejson
[
    {
        "RecordID": 123465,
        "Message": "test"
    }
]


Fields description:
RecordID(integer) – SA record ID
Message (string) – message

Responce:

Code Block
languagejson
[
  {
    "ID": null,
    "RecordId": 30983,
    "Message": "test123/r/ntest"
  }
]

Update retrieval service Note in Medical request (PUT request from Retrieval service)

Text will replace Retrieval Provider Notes of Medical request.

Message should be send in PUT request to endpoint: https://sa.yourlawyer.com:4430/sasvcdev/SAWebService.svc/Retrieval/MedicalRequests/RequestNote

JSON structure:

Code Block
languagejson
[
    {
        "RecordID": 123465,
        "Message": "test"
    }
]


Fields description:
RecordID(integer) – SA record ID
Message (string) – message

Responce:

Code Block
languagejson
[
  {
    "ID": null,
    "RecordId": 30983,
    "Message": "test"
  }
]