POST api/v2/Reminders/Send

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Register	string	None.
RecordId	integer	None.
StaffIds	Collection of integer	None.
Text	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Register": "sample string 1",
  "RecordId": 2,
  "StaffIds": [
    1,
    2
  ],
  "Text": "sample string 3"
}

application/xml, text/xml

Sample:

<RemindersV2Controller.TargetedReminderIn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Icculus.Portal.Controllers.V2">
  <RecordId>2</RecordId>
  <Register>sample string 1</Register>
  <StaffIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </StaffIds>
  <Text>sample string 3</Text>
</RemindersV2Controller.TargetedReminderIn>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MessageWrapper

Name	Description	Type	Additional information
data		MessageResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "data": {
    "Statuses": [
      {
        "StaffId": 1,
        "Status": "sample string 2",
        "Via": "sample string 3",
        "Code": 100
      },
      {
        "StaffId": 1,
        "Status": "sample string 2",
        "Via": "sample string 3",
        "Code": 100
      }
    ]
  }
}

application/xml, text/xml

Sample:

<MessageWrapper xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Icculus.Portal.Controllers">
  <data>
    <Statuses>
      <UserStatus>
        <Code>Continue</Code>
        <StaffId>1</StaffId>
        <Status>sample string 2</Status>
        <Via>sample string 3</Via>
      </UserStatus>
      <UserStatus>
        <Code>Continue</Code>
        <StaffId>1</StaffId>
        <Status>sample string 2</Status>
        <Via>sample string 3</Via>
      </UserStatus>
    </Statuses>
  </data>
</MessageWrapper>