GET api/v1/{providerId}/infrastructure/reminders
Get reminders for provider
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| providerId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.ReminderVo| Name | Description | Type | Additional 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. |
Response Formats
application/json, text/json
Sample:
[
{
"ReminderId": "d7f2b168-57ca-460b-ae37-c0088e79d4d0",
"Index": 2,
"ProviderId": "4f97fcf5-df5d-497a-b22c-231b107bf146",
"CreatedDate": "2025-04-10T18:06:59Z",
"DueDate": "2025-04-10T18:06:59Z",
"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"
}
]
},
{
"ReminderId": "d7f2b168-57ca-460b-ae37-c0088e79d4d0",
"Index": 2,
"ProviderId": "4f97fcf5-df5d-497a-b22c-231b107bf146",
"CreatedDate": "2025-04-10T18:06:59Z",
"DueDate": "2025-04-10T18:06:59Z",
"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:
<ArrayOfReminderVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
<ReminderVo>
<Completed>true</Completed>
<CreatedDate>2025-04-10T18:06:59.0513656+02:00</CreatedDate>
<Description>sample string 6</Description>
<DueDate>2025-04-10T18:06:59.0513656+02:00</DueDate>
<Index>2</Index>
<ProviderId>4f97fcf5-df5d-497a-b22c-231b107bf146</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>d7f2b168-57ca-460b-ae37-c0088e79d4d0</ReminderId>
<Title>sample string 5</Title>
<Type>Email</Type>
</ReminderVo>
<ReminderVo>
<Completed>true</Completed>
<CreatedDate>2025-04-10T18:06:59.0513656+02:00</CreatedDate>
<Description>sample string 6</Description>
<DueDate>2025-04-10T18:06:59.0513656+02:00</DueDate>
<Index>2</Index>
<ProviderId>4f97fcf5-df5d-497a-b22c-231b107bf146</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>d7f2b168-57ca-460b-ae37-c0088e79d4d0</ReminderId>
<Title>sample string 5</Title>
<Type>Email</Type>
</ReminderVo>
</ArrayOfReminderVo>