POST api/Visit
Request Information
URI Parameters
None.
Body Parameters
StartVisitModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Location | LocationModel |
None. |
|
| Visit | VisitModel |
None. |
|
| Activities | Collection of ActivityModel |
None. |
|
| IsClientNotRemainingHours | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Location": {
"Id": 1,
"LocationName": "sample string 2",
"StreetAddress": "sample string 3",
"Latitude": "sample string 4",
"Longitude": "sample string 5",
"Address": "sample string 6",
"City": "sample string 7",
"State": "sample string 8",
"Zip": "sample string 9",
"TimeStamp": "2025-12-05T22:14:19.2612361-06:00",
"FullAddress": "sample string 11",
"ManualEntry": true,
"DateTime": "sample string 13",
"IsConsumerHome": true,
"IsEmployeeHome": true,
"IsNotInMeasure": true,
"Mileage": 17.0,
"ActivityId": 18,
"LocationNo": 19,
"LocationReason": "sample string 20",
"ChangedBy": "sample string 21",
"ClientId": "sample string 22"
},
"Visit": {
"Id": 1,
"StaffId": 2,
"VisitName": "sample string 3",
"IsManualVisit": true,
"ChangedBy": "sample string 5"
},
"Activities": [
{
"Id": 1,
"ActivityId": 2,
"VisitId": 3,
"ClientId": "sample string 4",
"LocationId": 1,
"CurrentLocationId": 1,
"Timestamp": "2025-12-05T22:14:19.2768567-06:00",
"ActivityNarrativeId": 1,
"ActivityType": "sample string 5",
"LocationName": "sample string 6",
"ActivityState": "sample string 7",
"ManualEntry": true,
"AuthenticationId": 1,
"TransactionType": 1,
"InjuriesAndIllness": "sample string 9",
"MedicationId": 1,
"VerificationCode": "sample string 10",
"FormCompeleted": true,
"ClientIds": "sample string 12",
"isStartActivity": true,
"IsSaved": "sample string 14",
"Screen": "sample string 15",
"TimestampStart": "2025-12-05T22:14:19.2768567-06:00",
"ChangedBy": "sample string 16",
"IsOvertime": true,
"StartDate": "2025-12-05T22:14:19.2768567-06:00",
"EndDate": "2025-12-05T22:14:19.2768567-06:00",
"IsPast": "sample string 20",
"IsNoApprovedHrs": true,
"ChangedByName": "sample string 22",
"HoursPerWeek": 23.1,
"IsMedication": true
},
{
"Id": 1,
"ActivityId": 2,
"VisitId": 3,
"ClientId": "sample string 4",
"LocationId": 1,
"CurrentLocationId": 1,
"Timestamp": "2025-12-05T22:14:19.2768567-06:00",
"ActivityNarrativeId": 1,
"ActivityType": "sample string 5",
"LocationName": "sample string 6",
"ActivityState": "sample string 7",
"ManualEntry": true,
"AuthenticationId": 1,
"TransactionType": 1,
"InjuriesAndIllness": "sample string 9",
"MedicationId": 1,
"VerificationCode": "sample string 10",
"FormCompeleted": true,
"ClientIds": "sample string 12",
"isStartActivity": true,
"IsSaved": "sample string 14",
"Screen": "sample string 15",
"TimestampStart": "2025-12-05T22:14:19.2768567-06:00",
"ChangedBy": "sample string 16",
"IsOvertime": true,
"StartDate": "2025-12-05T22:14:19.2768567-06:00",
"EndDate": "2025-12-05T22:14:19.2768567-06:00",
"IsPast": "sample string 20",
"IsNoApprovedHrs": true,
"ChangedByName": "sample string 22",
"HoursPerWeek": 23.1,
"IsMedication": true
}
],
"IsClientNotRemainingHours": true
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | 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. |