PUT api/schedules/Update
Updates an item in the schedule.
Request Information
URI Parameters
None.
Body Parameters
UpdateScheduleInput| Name | Description | Type | Additional information |
|---|---|---|---|
| PlanId | integer |
Required |
|
| PlanDateTime | date |
None. |
|
| Duration | integer |
None. |
|
| Status | string |
None. |
|
| Note | string |
None. |
|
| ProgramId | integer |
None. |
|
| LocationId | integer |
None. |
|
| VisitTypeId | integer |
None. |
|
| IsPlanned | boolean |
None. |
|
| IsForced | boolean |
None. |
|
| FormGroupId | integer |
None. |
|
| GroupId | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"PlanId": 1,
"PlanDateTime": "2026-05-03T10:35:37.678246-04:00",
"Duration": 1,
"Status": "sample string 2",
"Note": "sample string 3",
"ProgramId": 1,
"LocationId": 1,
"VisitTypeId": 1,
"IsPlanned": true,
"IsForced": true,
"FormGroupId": 1,
"GroupId": 1
}
application/xml, text/xml
Sample:
<UpdateScheduleInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CWI.Mobile.Domain.DTO.ActionInputs"> <Duration>1</Duration> <FormGroupId>1</FormGroupId> <GroupId>1</GroupId> <IsForced>true</IsForced> <IsPlanned>true</IsPlanned> <LocationId>1</LocationId> <Note>sample string 3</Note> <PlanDateTime>2026-05-03T10:35:37.678246-04:00</PlanDateTime> <PlanId>1</PlanId> <ProgramId>1</ProgramId> <Status>sample string 2</Status> <VisitTypeId>1</VisitTypeId> </UpdateScheduleInput>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
An Http response message with the folliwing status codes: 204 = success (no Json), 400 = bad request (the request is malformed or with invalid data), 500 = something went wrong (the request was not processed)
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. |