Please enable JavaScript.
Coggle requires JavaScript to display documents.
API - Get Assessment Invitations by PhysioWizardAssessmentInvitationID,…
API - Get Assessment Invitations by PhysioWizardAssessmentInvitationID
Request
Headers
PWClientIdentifier
Value: <Client Identifier>
Length: 64
Data Type: Text
Status : Mandatory
MessageDatetime
Value: yyyy-MM-dd'T'HH:mm:ss
Length: 64
Data Type: Text
Status : Mandatory
Authorization
Value: <GUID>
Length: 64
Data Type: Text
Status : Mandatory
MessageDatetime
Value: Bearer <access_token>
Length: 64
Data Type: Text
Status : Mandatory
Method: GET
Endpoint: /assessmentInvitations/{PhysioWizardAssessmentInvitationID}
payload
N/A
Response
Response code: 200
payload
{
"physioWizardPatientID": string,
"clientPatientID": string,
"caseID": string,
"physioWizardPatientInvitationID": string,
"assessmentInvitationURL": string,
"assessmentInvitationStatus": string
}
physioWizardPatientInvitationID
necessity: Mandatory
Data type: Text
length: 64
assessmentInvitationURL
necessity: Mandatory
Data type: Text
length: 256
assessmentInvitationStatus
necessity: Mandatory
Data type: Text
length: 64
remarks: Created/ InProgress/ Completed/ Expired
physioWizardPatientID
necessity: Mandatory
date type: Text
length: 64
clientPatientID
necessity: Mandatory
Data type: Text
length: 64
caseID
necessity: Mandatory/ Unique
Data type: Text
length: 64
Error messages
HTTP Error Code 405 Method Not Allowed
If the request was made with any other request method (HTTP verb) than specified above, the request will not be allowed. API will return an error response with 405 Method Not Allowed as response code.
HTTP Error Code 500 - Internal Server Error
If the endpoint returns HTTP error code 500 that means something that has not been anticipated has happened hence the API hasn’t handled that error. Please reach out to support team.
HTTP Error Code 404 – Not Found
Scenario 1: PhysioWizardPatient Not found for PhysioWizardAssessmentInvitationID.
{
"PhysioWizardAssessmentInvitationID":
"PhysioWizard Assessment Invitation not found for ID <PhysioWizardAssessmentInvitationID>"
]
}
HTTP Error Code 400 - Bad Request
Scenario 1: Scenario 1: Invalid PhysioWizardAssessmentInvitationID.
Sample error message:
{
"PhysioWizardAssessmentInvitationID":[:
"Invalid PhysioWizardAssessmentInvitationID."
]
}
API - Get Assessment Invitations by PhysioWizardAssessmentInvitationID