POST api/forms/CreateIncompleteVisit

Creates one or many incomplete visit depending on the input data.

Request Information

URI Parameters

None.

Body Parameters

input data.

Name	Type	Additional information
clientId	integer	None.
employeeId	integer	None.
planId	integer	None.
visitTypeId	integer	None.
programId	integer	Required
locationId	integer	None.
recipientId	integer	None.
timeIn	date	Required
timeOut	date	None.
billingGroupId	integer	None.
formGroupId	integer	None.
formVersionId	integer	None.
PlannerGroupId	integer	None.
IsOrphan	boolean	None.
visitTypeIdFormVersionIdList	Collection of VisitTypeFormVersionRelation	None.
CreateSingleInGroup	boolean	None.
crediblePlanId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "clientId": 1,
  "employeeId": 1,
  "planId": 1,
  "visitTypeId": 1,
  "programId": 1,
  "locationId": 1,
  "recipientId": 1,
  "timeIn": "2026-05-05T07:15:32.7962209-04:00",
  "timeOut": "2026-05-05T07:15:32.7962209-04:00",
  "billingGroupId": 1,
  "formGroupId": 1,
  "formVersionId": 1,
  "PlannerGroupId": 1,
  "IsOrphan": true,
  "visitTypeIdFormVersionIdList": [
    {
      "VisitTypeId": 1,
      "FormVersionId": 2
    },
    {
      "VisitTypeId": 1,
      "FormVersionId": 2
    }
  ],
  "CreateSingleInGroup": true,
  "crediblePlanId": 1
}

application/xml, text/xml

Sample:

<CreateIncompleteVisitInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CWI.Mobile.Domain.DTO.ActionInputs">
  <CreateSingleInGroup>true</CreateSingleInGroup>
  <IsOrphan>true</IsOrphan>
  <PlannerGroupId>1</PlannerGroupId>
  <billingGroupId>1</billingGroupId>
  <clientId>1</clientId>
  <crediblePlanId>1</crediblePlanId>
  <employeeId>1</employeeId>
  <formGroupId>1</formGroupId>
  <formVersionId>1</formVersionId>
  <locationId>1</locationId>
  <planId>1</planId>
  <programId>1</programId>
  <recipientId>1</recipientId>
  <timeIn>2026-05-05T07:15:32.7962209-04:00</timeIn>
  <timeOut>2026-05-05T07:15:32.7962209-04:00</timeOut>
  <visitTypeId>1</visitTypeId>
  <visitTypeIdFormVersionIdList>
    <VisitTypeFormVersionRelation>
      <FormVersionId>2</FormVersionId>
      <VisitTypeId>1</VisitTypeId>
    </VisitTypeFormVersionRelation>
    <VisitTypeFormVersionRelation>
      <FormVersionId>2</FormVersionId>
      <VisitTypeId>1</VisitTypeId>
    </VisitTypeFormVersionRelation>
  </visitTypeIdFormVersionIdList>
</CreateIncompleteVisitInput>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreateIncompleteVisitInput'.

Response Information

Resource Description

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

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.