GET api/forms/{planId}/GetOrCreateIncompleteVisit

Gets all existing incomplete visits associated to the provided plan, if none are found then it creates them. This opperation supports group visits and form groups; however in the case of group visits, it will only create the visits for the clients in the group that are also assigned to the employee making the request.

Request Information

URI Parameters

Name	Description	Type	Additional information
planId	The plan to use.	integer	Required

Body Parameters

None.

Response Information

Resource Description

An Http response message with the folliwing status codes: 200 = success (always includes a list of incomplete visit ids), 400 = bad request (the request is malformed or with invalid data), 500 = something went wrong (the request was not processed)

Collection of UiIncompleteVisitFull

Name	Description	Type	Additional information
incompleteVisitData		UiIncompleteVisit	None.
savedAnswers		Collection of UiSavedAnswer	None.
categoryNotes		Collection of UiSavedCategoryNotes	None.
savedTxPlusAnswers		Collection of UiSavedTxPlusAnswer	None.
savedEmbeddedSignatures		Collection of UiSavedEmbeddedSignature	None.
savedSignAndSubmitSignatures		Collection of UiSavedTemporarySignature	None.
savedTxPlusExtendedAnswers		Collection of TxPlusExtendedAnswerDto	None.
savedCrediblePlanDocumentation		Collection of TzCrediblePlanSavedDocumentation	None.
savedExtendedFieldValues		Collection of CrediblePlanElementExtendedFieldValue	None.

Response Formats