POST api/v1/xref/{providerXRef}/infrastructure/notifications/xref/{notificationXRef}/action

Action notification

Request Information

URI Parameters

NameDescriptionTypeAdditional information
providerXRef

string

Required
notificationXRef

string

Required

Body Parameters

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.NotificationActionVo
NameDescriptionTypeAdditional information
Description

string

None.
Name

string

None.
ActionLink

string

None.
Modal

boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "Description": "sample string 1",
  "Name": "sample string 2",
  "ActionLink": "sample string 3",
  "Modal": true
}

application/xml, text/xml

Sample: 
<NotificationActionVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <ActionLink>sample string 3</ActionLink>
  <Description>sample string 1</Description>
  <Modal>true</Modal>
  <Name>sample string 2</Name>
</NotificationActionVo>

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

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": "b559c221-6814-4542-8bc3-30b349b7947f",
  "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>b559c221-6814-4542-8bc3-30b349b7947f</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>