POST api/cleaning-appointment

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
GuestUserId	integer	None.
PrefferedDate1	date	None.
PrefferedDate2	date	None.
PrefferedDate3	date	None.
IsSoonestAvailable	boolean	None.
PrefferedTime	PreferredTimeRange	None.
MethodOfEntry	string	None.
IsFlexibleScheduling	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "GuestUserId": 1,
  "PrefferedDate1": "2026-03-24T06:22:57.892265-05:00",
  "PrefferedDate2": "2026-03-24T06:22:57.892265-05:00",
  "PrefferedDate3": "2026-03-24T06:22:57.892265-05:00",
  "IsSoonestAvailable": true,
  "PrefferedTime": 0,
  "MethodOfEntry": "sample string 2",
  "IsFlexibleScheduling": true
}

application/xml, text/xml

Sample:

<AppointmentMappers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CottageCareOnlinePricing.BAL.ServiceClass">
  <GuestUserId>1</GuestUserId>
  <IsFlexibleScheduling>true</IsFlexibleScheduling>
  <IsSoonestAvailable>true</IsSoonestAvailable>
  <MethodOfEntry>sample string 2</MethodOfEntry>
  <PrefferedDate1>2026-03-24T06:22:57.892265-05:00</PrefferedDate1>
  <PrefferedDate2>2026-03-24T06:22:57.892265-05:00</PrefferedDate2>
  <PrefferedDate3>2026-03-24T06:22:57.892265-05:00</PrefferedDate3>
  <PrefferedTime>TimeSlot2</PrefferedTime>
</AppointmentMappers>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Result

Name	Type	Additional information
HasError	boolean	None.
HasSuccess	boolean	None.
IsServiceable	boolean	None.
Status	StatusType	None.
MessageTitle	string	None.
Message	string	None.
ExceptionMessage	string	None.
ExceptionStackTrace	string	None.
ResultException	Exception	None.
ResultObject	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "ResultObject": {},
  "HasError": false,
  "HasSuccess": true,
  "IsServiceable": true,
  "Status": 200,
  "MessageTitle": "sample string 4",
  "Message": "sample string 5",
  "ExceptionMessage": "sample string 6",
  "ExceptionStackTrace": "sample string 7",
  "ResultException": {
    "ClassName": "System.Exception",
    "Message": null,
    "Data": null,
    "InnerException": null,
    "HelpURL": "sample string 1",
    "StackTraceString": null,
    "RemoteStackTraceString": null,
    "RemoteStackIndex": 0,
    "ExceptionMethod": null,
    "HResult": 3,
    "Source": "sample string 2",
    "WatsonBuckets": null
  }
}

application/xml, text/xml

Sample:

<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CottageCare.BAL.ServiceClass">
  <ExceptionMessage>sample string 6</ExceptionMessage>
  <ExceptionStackTrace>sample string 7</ExceptionStackTrace>
  <HasError>false</HasError>
  <HasSuccess>true</HasSuccess>
  <IsServiceable>true</IsServiceable>
  <Message>sample string 5</Message>
  <MessageTitle>sample string 4</MessageTitle>
  <ResultException xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <ClassName xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">System.Exception</ClassName>
    <Message i:nil="true" xmlns="" />
    <Data i:nil="true" xmlns="" />
    <InnerException i:nil="true" xmlns="" />
    <HelpURL xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 1</HelpURL>
    <StackTraceString i:nil="true" xmlns="" />
    <RemoteStackTraceString i:nil="true" xmlns="" />
    <RemoteStackIndex xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">0</RemoteStackIndex>
    <ExceptionMethod i:nil="true" xmlns="" />
    <HResult xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">3</HResult>
    <Source xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 2</Source>
    <WatsonBuckets i:nil="true" xmlns="" />
  </ResultException>
  <ResultObject />
  <Status>Success</Status>
</Result>