POST api/Staff/Comms/Remind

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Ids	Collection of integer	None.
IsNow	boolean	None.
SendAt	date	None.
Status	string	None.
Type	string	None.
Text	string	None.
Html	string	None.
TalkId	integer	None.
Filter	FilterData	None.
Flag	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Ids": [
    1,
    2
  ],
  "IsNow": true,
  "SendAt": "2025-12-31T07:23:29.4724847-05:00",
  "Status": "sample string 2",
  "Type": "sample string 3",
  "Text": "sample string 4",
  "Html": "sample string 5",
  "TalkId": 1,
  "Filter": {
    "view": "sample string 1",
    "employee": [
      1,
      2
    ],
    "region": [
      "sample string 1",
      "sample string 2"
    ],
    "branch": [
      "sample string 1",
      "sample string 2"
    ],
    "department": [
      "sample string 1",
      "sample string 2"
    ],
    "region_id": 2,
    "branch_id": 3,
    "department_id": 4,
    "role": [
      "sample string 1",
      "sample string 2"
    ],
    "role_type": [
      "sample string 1",
      "sample string 2"
    ],
    "status": [
      "sample string 1",
      "sample string 2"
    ],
    "checkin_option": "sample string 5",
    "ppe_open_item_option": "sample string 6",
    "certificate_status_option": "sample string 7",
    "ppe_group": [
      1,
      2
    ],
    "ppe_type": [
      1,
      2
    ],
    "ppe_make": [
      1,
      2
    ],
    "hazard_type": [
      1,
      2
    ],
    "hazard": 1,
    "ppe": 1,
    "inactive": "sample string 8",
    "sales_lead": 9,
    "exclude_sales_lead": 10,
    "date": {
      "from": "2025-12-31T07:23:29.4724847-05:00",
      "to": "2025-12-31T07:23:29.4724847-05:00",
      "isEmpty": true
    },
    "day": "2025-12-31T07:23:29.4724847-05:00",
    "from": "2025-12-31T07:23:29.4724847-05:00",
    "to": "2025-12-31T07:23:29.4724847-05:00",
    "active_on_process": true,
    "year": 1,
    "jumper": 1,
    "dob_elevator_company": "sample string 13",
    "dob_consultant": "sample string 14",
    "dob_location": "sample string 15",
    "inspection_phase": "sample string 16",
    "DobElCo": "sample string 13",
    "DobConsultant": "sample string 14",
    "DobLocation": "sample string 15",
    "job": 17,
    "task": 18,
    "job_type": "sample string 19",
    "open_item_link_id": 20,
    "exclude_open_item_id": 21,
    "osha_injury_report": 22,
    "osha_injury_option": "sample string 23",
    "osha_injury_type": "sample string 24",
    "DobStartDate": "0001-01-01T00:00:00",
    "support_ticket_option": "sample string 25",
    "message_type": "sample string 26",
    "DobEndDate": "0002-01-01T00:00:00",
    "content": 1,
    "certification": 27,
    "training_program": 28,
    "training_course": 29,
    "training_class": 30,
    "scheduled": true,
    "device": [
      1,
      2
    ],
    "building": 31,
    "company": 32,
    "building_owner": 33,
    "elevator_part": 34,
    "elevator_part_condition": 35,
    "elevator_part_category": 36,
    "remedy": 37,
    "super": 38,
    "work": 39,
    "elevator_open_item_option": "sample string 40",
    "sales_open_item": 41,
    "sales_open_item_option": "sample string 42",
    "sales_open_item_part_option": "sample string 43",
    "elevator_open_item_bucket": [
      "sample string 1",
      "sample string 2"
    ],
    "sales_open_item_bucket": [
      "sample string 1",
      "sample string 2"
    ],
    "route": 44,
    "jumper_option": "sample string 45",
    "work_type": [
      "sample string 1",
      "sample string 2"
    ],
    "inspection_test_type": [
      1,
      2
    ],
    "id": [
      1,
      2
    ],
    "type": "sample string 46",
    "is_custom_jha": "sample string 47",
    "jha_in": true,
    "jha_without": true,
    "process": 48,
    "process_audit_status": "sample string 49"
  },
  "Flag": true
}

application/xml, text/xml

Sample:

<MessagePackage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Icculus.Portal.Controllers">
  <Filter xmlns:d2p1="http://schemas.datacontract.org/2004/07/Icculus.Portal.Common.Models.Filter">
    <d2p1:active_on_process>true</d2p1:active_on_process>
    <d2p1:branch xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:branch>
    <d2p1:branch_id>3</d2p1:branch_id>
    <d2p1:building>31</d2p1:building>
    <d2p1:building_owner>33</d2p1:building_owner>
    <d2p1:certificate_status_option>sample string 7</d2p1:certificate_status_option>
    <d2p1:certification>27</d2p1:certification>
    <d2p1:checkin_option>sample string 5</d2p1:checkin_option>
    <d2p1:company>32</d2p1:company>
    <d2p1:content>1</d2p1:content>
    <d2p1:date>
      <d2p1:from>2025-12-31T07:23:29.4724847-05:00</d2p1:from>
      <d2p1:isEmpty>true</d2p1:isEmpty>
      <d2p1:to>2025-12-31T07:23:29.4724847-05:00</d2p1:to>
    </d2p1:date>
    <d2p1:day>2025-12-31T07:23:29.4724847-05:00</d2p1:day>
    <d2p1:department xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:department>
    <d2p1:department_id>4</d2p1:department_id>
    <d2p1:device xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:device>
    <d2p1:dob_consultant>sample string 14</d2p1:dob_consultant>
    <d2p1:dob_elevator_company>sample string 13</d2p1:dob_elevator_company>
    <d2p1:dob_location>sample string 15</d2p1:dob_location>
    <d2p1:elevator_open_item_bucket xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:elevator_open_item_bucket>
    <d2p1:elevator_open_item_option>sample string 40</d2p1:elevator_open_item_option>
    <d2p1:elevator_part>34</d2p1:elevator_part>
    <d2p1:elevator_part_category>36</d2p1:elevator_part_category>
    <d2p1:elevator_part_condition>35</d2p1:elevator_part_condition>
    <d2p1:employee xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:employee>
    <d2p1:exclude_open_item_id>21</d2p1:exclude_open_item_id>
    <d2p1:exclude_sales_lead>10</d2p1:exclude_sales_lead>
    <d2p1:from>2025-12-31T07:23:29.4724847-05:00</d2p1:from>
    <d2p1:hazard>1</d2p1:hazard>
    <d2p1:hazard_type xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:hazard_type>
    <d2p1:id xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:id>
    <d2p1:inactive>sample string 8</d2p1:inactive>
    <d2p1:inspection_phase>sample string 16</d2p1:inspection_phase>
    <d2p1:inspection_test_type xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:inspection_test_type>
    <d2p1:is_custom_jha>sample string 47</d2p1:is_custom_jha>
    <d2p1:jha_in>true</d2p1:jha_in>
    <d2p1:jha_without>true</d2p1:jha_without>
    <d2p1:job>17</d2p1:job>
    <d2p1:job_type>sample string 19</d2p1:job_type>
    <d2p1:jumper>1</d2p1:jumper>
    <d2p1:jumper_option>sample string 45</d2p1:jumper_option>
    <d2p1:message_type>sample string 26</d2p1:message_type>
    <d2p1:open_item_link_id>20</d2p1:open_item_link_id>
    <d2p1:osha_injury_option>sample string 23</d2p1:osha_injury_option>
    <d2p1:osha_injury_report>22</d2p1:osha_injury_report>
    <d2p1:osha_injury_type>sample string 24</d2p1:osha_injury_type>
    <d2p1:ppe>1</d2p1:ppe>
    <d2p1:ppe_group xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:ppe_group>
    <d2p1:ppe_make xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:ppe_make>
    <d2p1:ppe_open_item_option>sample string 6</d2p1:ppe_open_item_option>
    <d2p1:ppe_type xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:ppe_type>
    <d2p1:process>48</d2p1:process>
    <d2p1:process_audit_status>sample string 49</d2p1:process_audit_status>
    <d2p1:region xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:region>
    <d2p1:region_id>2</d2p1:region_id>
    <d2p1:remedy>37</d2p1:remedy>
    <d2p1:role xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:role>
    <d2p1:role_type xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:role_type>
    <d2p1:route>44</d2p1:route>
    <d2p1:sales_lead>9</d2p1:sales_lead>
    <d2p1:sales_open_item>41</d2p1:sales_open_item>
    <d2p1:sales_open_item_bucket xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:sales_open_item_bucket>
    <d2p1:sales_open_item_option>sample string 42</d2p1:sales_open_item_option>
    <d2p1:sales_open_item_part_option>sample string 43</d2p1:sales_open_item_part_option>
    <d2p1:scheduled>true</d2p1:scheduled>
    <d2p1:status xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:status>
    <d2p1:super>38</d2p1:super>
    <d2p1:support_ticket_option>sample string 25</d2p1:support_ticket_option>
    <d2p1:task>18</d2p1:task>
    <d2p1:to>2025-12-31T07:23:29.4724847-05:00</d2p1:to>
    <d2p1:training_class>30</d2p1:training_class>
    <d2p1:training_course>29</d2p1:training_course>
    <d2p1:training_program>28</d2p1:training_program>
    <d2p1:type>sample string 46</d2p1:type>
    <d2p1:view>sample string 1</d2p1:view>
    <d2p1:work>39</d2p1:work>
    <d2p1:work_type xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:work_type>
    <d2p1:year>1</d2p1:year>
  </Filter>
  <Flag>true</Flag>
  <Html>sample string 5</Html>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Ids>
  <IsNow>true</IsNow>
  <SendAt>2025-12-31T07:23:29.4724847-05:00</SendAt>
  <Status>sample string 2</Status>
  <TalkId>1</TalkId>
  <Text>sample string 4</Text>
  <Type>sample string 3</Type>
</MessagePackage>

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>