POST api/OnTheGo/Messages/SendMessage

Request Information

URI Parameters

None.

Body Parameters

Collection of MesssageInfo
NameDescriptionTypeAdditional information
MessageGUID

globally unique identifier

None.

ParentMsgGUID

globally unique identifier

None.

UTCStatusTimeStamp

date

None.

SentByEmpID

integer

None.

SentByEmpName

string

None.

SentToEmpID

integer

None.

PriorityLevel

integer

None.

IsResponseRequired

boolean

None.

IsCannedResponseMsg

boolean

None.

CannedResponses

string

None.

MessageBody

string

None.

CurrentStatusID

integer

None.

MessageStatuses

Collection of MessageStatusInfo

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "MessageGUID": "00ba76e7-c794-40f1-9c7c-b640b2d7d76b",
    "ParentMsgGUID": "57c159d5-41b6-47b5-86e6-87ce24e634dc",
    "UTCStatusTimeStamp": "2025-05-02T12:06:42.122Z",
    "SentByEmpID": 3,
    "SentByEmpName": "sample string 4",
    "SentToEmpID": 5,
    "PriorityLevel": 6,
    "IsResponseRequired": true,
    "IsCannedResponseMsg": true,
    "CannedResponses": "sample string 9",
    "MessageBody": "sample string 10",
    "CurrentStatusID": 11,
    "MessageStatuses": [
      {
        "MessageGUID": "5f3ff647-428e-4b71-b533-7a18e35aacf1",
        "StatusID": 2,
        "UTCStatusTimeStamp": "2025-05-02T12:06:42.122Z",
        "GPSLat": 4.0,
        "GPSLong": 5.0,
        "Velocity": 6.1,
        "IsDelivered": true
      },
      {
        "MessageGUID": "5f3ff647-428e-4b71-b533-7a18e35aacf1",
        "StatusID": 2,
        "UTCStatusTimeStamp": "2025-05-02T12:06:42.122Z",
        "GPSLat": 4.0,
        "GPSLong": 5.0,
        "Velocity": 6.1,
        "IsDelivered": true
      }
    ]
  },
  {
    "MessageGUID": "00ba76e7-c794-40f1-9c7c-b640b2d7d76b",
    "ParentMsgGUID": "57c159d5-41b6-47b5-86e6-87ce24e634dc",
    "UTCStatusTimeStamp": "2025-05-02T12:06:42.122Z",
    "SentByEmpID": 3,
    "SentByEmpName": "sample string 4",
    "SentToEmpID": 5,
    "PriorityLevel": 6,
    "IsResponseRequired": true,
    "IsCannedResponseMsg": true,
    "CannedResponses": "sample string 9",
    "MessageBody": "sample string 10",
    "CurrentStatusID": 11,
    "MessageStatuses": [
      {
        "MessageGUID": "5f3ff647-428e-4b71-b533-7a18e35aacf1",
        "StatusID": 2,
        "UTCStatusTimeStamp": "2025-05-02T12:06:42.122Z",
        "GPSLat": 4.0,
        "GPSLong": 5.0,
        "Velocity": 6.1,
        "IsDelivered": true
      },
      {
        "MessageGUID": "5f3ff647-428e-4b71-b533-7a18e35aacf1",
        "StatusID": 2,
        "UTCStatusTimeStamp": "2025-05-02T12:06:42.122Z",
        "GPSLat": 4.0,
        "GPSLong": 5.0,
        "Velocity": 6.1,
        "IsDelivered": true
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfMessageModel.MesssageInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/appsvc.rapidappsinc.com.Areas.OnTheGo.Models">
  <MessageModel.MesssageInfo>
    <CannedResponses>sample string 9</CannedResponses>
    <CurrentStatusID>11</CurrentStatusID>
    <IsCannedResponseMsg>true</IsCannedResponseMsg>
    <IsResponseRequired>true</IsResponseRequired>
    <MessageBody>sample string 10</MessageBody>
    <MessageGUID>00ba76e7-c794-40f1-9c7c-b640b2d7d76b</MessageGUID>
    <MessageStatuses>
      <MessageModel.MessageStatusInfo>
        <GPSLat>4</GPSLat>
        <GPSLong>5</GPSLong>
        <IsDelivered>true</IsDelivered>
        <MessageGUID>5f3ff647-428e-4b71-b533-7a18e35aacf1</MessageGUID>
        <StatusID>2</StatusID>
        <UTCStatusTimeStamp>2025-05-02T12:06:42.1228268+00:00</UTCStatusTimeStamp>
        <Velocity>6.1</Velocity>
      </MessageModel.MessageStatusInfo>
      <MessageModel.MessageStatusInfo>
        <GPSLat>4</GPSLat>
        <GPSLong>5</GPSLong>
        <IsDelivered>true</IsDelivered>
        <MessageGUID>5f3ff647-428e-4b71-b533-7a18e35aacf1</MessageGUID>
        <StatusID>2</StatusID>
        <UTCStatusTimeStamp>2025-05-02T12:06:42.1228268+00:00</UTCStatusTimeStamp>
        <Velocity>6.1</Velocity>
      </MessageModel.MessageStatusInfo>
    </MessageStatuses>
    <ParentMsgGUID>57c159d5-41b6-47b5-86e6-87ce24e634dc</ParentMsgGUID>
    <PriorityLevel>6</PriorityLevel>
    <SentByEmpID>3</SentByEmpID>
    <SentByEmpName>sample string 4</SentByEmpName>
    <SentToEmpID>5</SentToEmpID>
    <UTCStatusTimeStamp>2025-05-02T12:06:42.1228268+00:00</UTCStatusTimeStamp>
  </MessageModel.MesssageInfo>
  <MessageModel.MesssageInfo>
    <CannedResponses>sample string 9</CannedResponses>
    <CurrentStatusID>11</CurrentStatusID>
    <IsCannedResponseMsg>true</IsCannedResponseMsg>
    <IsResponseRequired>true</IsResponseRequired>
    <MessageBody>sample string 10</MessageBody>
    <MessageGUID>00ba76e7-c794-40f1-9c7c-b640b2d7d76b</MessageGUID>
    <MessageStatuses>
      <MessageModel.MessageStatusInfo>
        <GPSLat>4</GPSLat>
        <GPSLong>5</GPSLong>
        <IsDelivered>true</IsDelivered>
        <MessageGUID>5f3ff647-428e-4b71-b533-7a18e35aacf1</MessageGUID>
        <StatusID>2</StatusID>
        <UTCStatusTimeStamp>2025-05-02T12:06:42.1228268+00:00</UTCStatusTimeStamp>
        <Velocity>6.1</Velocity>
      </MessageModel.MessageStatusInfo>
      <MessageModel.MessageStatusInfo>
        <GPSLat>4</GPSLat>
        <GPSLong>5</GPSLong>
        <IsDelivered>true</IsDelivered>
        <MessageGUID>5f3ff647-428e-4b71-b533-7a18e35aacf1</MessageGUID>
        <StatusID>2</StatusID>
        <UTCStatusTimeStamp>2025-05-02T12:06:42.1228268+00:00</UTCStatusTimeStamp>
        <Velocity>6.1</Velocity>
      </MessageModel.MessageStatusInfo>
    </MessageStatuses>
    <ParentMsgGUID>57c159d5-41b6-47b5-86e6-87ce24e634dc</ParentMsgGUID>
    <PriorityLevel>6</PriorityLevel>
    <SentByEmpID>3</SentByEmpID>
    <SentByEmpName>sample string 4</SentByEmpName>
    <SentToEmpID>5</SentToEmpID>
    <UTCStatusTimeStamp>2025-05-02T12:06:42.1228268+00:00</UTCStatusTimeStamp>
  </MessageModel.MesssageInfo>
</ArrayOfMessageModel.MesssageInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.