POST api/schedules/Add

Adds an item to the schedule.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ClientId	integer	None.
PlannerGroupId	integer	None.
PlanDateTime	date	Required
Duration	integer	Required
Note	string	None.
ProgramId	integer	Required
LocationId	integer	Required
VisitTypeId	integer	Required
IsPlanned	boolean	None.
IsForced	boolean	None.
FormGroupId	integer	None.
IsForcedClient	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientId": 1,
  "PlannerGroupId": 1,
  "PlanDateTime": "2026-05-05T07:15:55.1606194-04:00",
  "Duration": 2,
  "Note": "sample string 3",
  "ProgramId": 4,
  "LocationId": 5,
  "VisitTypeId": 6,
  "IsPlanned": true,
  "IsForced": true,
  "FormGroupId": 1,
  "IsForcedClient": true
}

application/xml, text/xml

Sample:

<AddScheduleInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CWI.Mobile.Domain.DTO.ActionInputs">
  <ClientId>1</ClientId>
  <Duration>2</Duration>
  <FormGroupId>1</FormGroupId>
  <IsForced>true</IsForced>
  <IsForcedClient>true</IsForcedClient>
  <IsPlanned>true</IsPlanned>
  <LocationId>5</LocationId>
  <Note>sample string 3</Note>
  <PlanDateTime>2026-05-05T07:15:55.1606194-04:00</PlanDateTime>
  <PlannerGroupId>1</PlannerGroupId>
  <ProgramId>4</ProgramId>
  <VisitTypeId>6</VisitTypeId>
</AddScheduleInput>

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 'AddScheduleInput'.

Response Information

Resource Description

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

integer

Response Formats

application/json, text/json

Sample:

application/xml, text/xml

Sample:

<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>