POST api/v1/Provider/Patient/Reminder

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PatientID	integer	None.
ReminderID	integer	None.
ReminderTypeID	byte	None.
WeekDays	Dictionary of WeekDay [key] and boolean [value]	Required
Hours	integer	Required Range: inclusive between 0 and 24
Minutes	integer	Required Range: inclusive between 0 and 60
IsSameOtherReminder	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "PatientID": 1,
  "ReminderID": 2,
  "ReminderTypeID": 64,
  "WeekDays": {
    "Monday": true
  },
  "Hours": 4,
  "Minutes": 5,
  "IsSameOtherReminder": true
}

application/xml, text/xml

Sample:

<PatientSpecificReminderViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Consensus.Ortho.Services.ViewModels.ProviderViewModels">
  <Hours>4</Hours>
  <IsSameOtherReminder>true</IsSameOtherReminder>
  <Minutes>5</Minutes>
  <ReminderID>2</ReminderID>
  <ReminderTypeID>64</ReminderTypeID>
  <WeekDays xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfWeekDaybooleanfPjyv8OE>
      <d2p1:Key>Monday</d2p1:Key>
      <d2p1:Value>true</d2p1:Value>
    </d2p1:KeyValueOfWeekDaybooleanfPjyv8OE>
  </WeekDays>
  <PatientID>1</PatientID>
</PatientSpecificReminderViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ActionResultViewModelOfString

Name	Type	Additional information
StatusCode	integer	None.
Success	boolean	None.
Message	string	None.
Result	string	None.

Response Formats

application/json, text/json

Sample:

{
  "StatusCode": 1,
  "Success": true,
  "Message": "sample string 3",
  "Result": "sample string 4"
}

application/xml, text/xml

Sample:

<ActionResultViewModelOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Consensus.Ortho.Web.ViewModels.ResultViewModels">
  <Message>sample string 3</Message>
  <Result>sample string 4</Result>
  <StatusCode>1</StatusCode>
  <Success>true</Success>
</ActionResultViewModelOfstring>