POST api/ClinicalDocument/Get

Return Export Summary

Request Information

URI Parameters

None.

Body Parameters

BaseRequest
NameDescriptionTypeAdditional information
PersonUid

Encryped passcode for the authenticated user.

 string

Required
StartDate

Start date of the request. A time component is not used when passing the start date.

 date

[Optional]
EndDate

End date of the request. A time component is not used when passing the end date.

 date

[Optional]

Request Formats

application/json, text/json

Sample: 
{
  "PersonUid": "sample string 1",
  "StartDate": "2025-11-09T07:15:41.0945013-05:00",
  "EndDate": "2025-11-09T07:15:41.0945013-05:00"
}

Response Information

Resource Description

CcdSummaryResponse
NameDescriptionTypeAdditional information
CcdSummary

string
ErrorMessage

If the success property is false, the ErrorMessage property will contain error text, otherwise it will be null.

 string
ErrorType

Text of the type of error that has occured (See the Error Handling section for more information).

 string
Success

Represents the success of the call.

 boolean

Response Formats

application/json, text/json

Sample: 
{
  "CcdSummary": "sample string 1",
  "ErrorMessage": "sample string 2",
  "ErrorType": "sample string 3",
  "Success": true
}