Please enable JavaScript.
Coggle requires JavaScript to display documents.
API - Create PatientInvitation, API - Create PatientInvitation - Coggle…
API - Create PatientInvitation
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: POST
Endpoint: /patientinvitations
payload
{
"physioWizardPatientID": string,
"clientPatientID": string
}
physioWizardPatientID
necessity: Mandatory
date type: Text
length: 64
remarks:
Either one of the PhysioWizardPatientID or ClientPatientID is required to generate an invite.
clientPatientID
necessity: Mandatory
Data type: Text
length: 64
remarks:
Either one of the PhysioWizardPatientID or ClientPatientID is required to generate an invite.
Response
Response code: 201
payload
{
"physioWizardPatientInvitationID": string,
"patientInvitationURL": string
}
physioWizardPatientInvitationID
necessity: Mandatory
Data type: Text
length: 64
patientInvitationURL
necessity: Mandatory
Data type: Text
length: 256
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 ID
Sample error message:
{
"PhysioWizardPatientID":
"PhysioWizardPatient not found for ID <PhysioWizardPatientID>."
]
}
Scenario 3: PhysioWizardPatient Not found for the email <PatientEmailAddress>.
Sample error message:
{
"PatientEmailAddress":
"PhysioWizardPatient not found for email <PatientEmailAddress>"
]
}
Scenario 2: PhysioWizardPatient Not found for the ID <ClientPatientID>.
Sample error message:
{
"ClientPatientID":
"PhysioWizardPatient not found for ID <ClientPatientID>"
]
}
HTTP Error Code 400 - Bad Request
Scenario 1: Either PhysioWizardPatientID or ClientPatientID is required.
Sample error message:
{
"ClientPatientID":[:
"ClientPatientID is required"
],
"PhysioWizardPatientID":[
"PhysioWizardPatientID is required"
]
}
API - Create PatientInvitation