POST api/v1/infrastructure/timer

Sets timer

Request Information

URI Parameters

None.

Body Parameters

Command setTimer

Com.Healthbridge.Core.CommonDomain.Interface.Commands.SetTimer
NameDescriptionTypeAdditional information
TimerId

globally unique identifier

None.

FollowUpDateTime

date

None.

CallbackCommand

Com.Healthbridge.Core.CommonDomain.Interface.Command

None.

CorrelationIds

Collection of string

None.

OriginatedSystem

string

None.

Request Formats

application/json, text/json

Sample:
{
  "TimerId": "195588b5-7904-4fdf-a1bf-edcbe76bcb2b",
  "FollowUpDateTime": "2025-04-10T16:43:06Z",
  "CallbackCommand": null,
  "CorrelationIds": [
    "sample string 1",
    "sample string 2"
  ],
  "OriginatedSystem": "sample string 3"
}

application/xml, text/xml

Sample:
<SetTimer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.Commands">
  <CorrelationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CorrelationIds>
  <OriginatedSystem xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">sample string 3</OriginatedSystem>
  <CallbackCommand xmlns:d2p1="http://mpsapi.healthbridge.com/platform/core/v1/command/" i:nil="true" />
  <FollowUpDateTime>2025-04-10T16:43:06.0190036+02:00</FollowUpDateTime>
  <TimerId>195588b5-7904-4fdf-a1bf-edcbe76bcb2b</TimerId>
</SetTimer>

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

Response Information

Resource Description

Timer NodeId

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": "3e25773a-8f60-4e73-9891-dfb40a074232",
  "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>3e25773a-8f60-4e73-9891-dfb40a074232</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>