POST api/v1/{providerId}/infrastructure/reminders/{reminderId}/complete

Complete reminder

Request Information

URI Parameters

NameDescriptionTypeAdditional information
providerId

globally unique identifier

Required
reminderId

globally unique identifier

Required

Body Parameters

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.ReminderVo
NameDescriptionTypeAdditional information
ReminderId

globally unique identifier

None.
Index

integer

None.
ProviderId

globally unique identifier

None.
CreatedDate

date

None.
DueDate

date

None.
Title

string

None.
Description

string

None.
Completed

boolean

None.
Type

Com.Healthbridge.Hhas.Claiming.Interface.ValueObjects.EnumReminderType

None.
References

Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.ReminderReferenceVo

None.

Request Formats

application/json, text/json

Sample: 
{
  "ReminderId": "8997f44d-cc05-4a63-89ec-7200fbe760b6",
  "Index": 2,
  "ProviderId": "2bbe6d68-051b-405e-be9f-94042ea2857e",
  "CreatedDate": "2025-11-19T17:44:14Z",
  "DueDate": "2025-11-19T17:44:14Z",
  "Title": "sample string 5",
  "Description": "sample string 6",
  "Completed": true,
  "Type": 0,
  "References": [
    {
      "ReferenceId": "sample string 1",
      "Name": "sample string 2",
      "ReferenceType": "sample string 3"
    },
    {
      "ReferenceId": "sample string 1",
      "Name": "sample string 2",
      "ReferenceType": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample: 
<ReminderVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Completed>true</Completed>
  <CreatedDate>2025-11-19T17:44:14.9005826+02:00</CreatedDate>
  <Description>sample string 6</Description>
  <DueDate>2025-11-19T17:44:14.9005826+02:00</DueDate>
  <Index>2</Index>
  <ProviderId>2bbe6d68-051b-405e-be9f-94042ea2857e</ProviderId>
  <References>
    <ReminderReferenceVo>
      <Name>sample string 2</Name>
      <ReferenceId>sample string 1</ReferenceId>
      <ReferenceType>sample string 3</ReferenceType>
    </ReminderReferenceVo>
    <ReminderReferenceVo>
      <Name>sample string 2</Name>
      <ReferenceId>sample string 1</ReferenceId>
      <ReferenceType>sample string 3</ReferenceType>
    </ReminderReferenceVo>
  </References>
  <ReminderId>8997f44d-cc05-4a63-89ec-7200fbe760b6</ReminderId>
  <Title>sample string 5</Title>
  <Type>Email</Type>
</ReminderVo>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'ReminderVo'.

Response Information

Resource Description

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfSystem.Guid
NameDescriptionTypeAdditional information
Sucess

boolean

None.
ResponseCode

integer

None.
ResponseMessage

string

None.
Data

globally unique identifier

None.
Links

Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiLink

None.

Response Formats

application/json, text/json

Sample: 
{
  "Sucess": true,
  "ResponseCode": 2,
  "ResponseMessage": "sample string 3",
  "Data": "14c1afca-38de-4fa4-931e-f30fb78de20e",
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<RestApiResultOfguid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data>14c1afca-38de-4fa4-931e-f30fb78de20e</Data>
  <Links>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
  </Links>
  <ResponseCode>2</ResponseCode>
  <ResponseMessage>sample string 3</ResponseMessage>
  <Sucess>true</Sucess>
</RestApiResultOfguid>