POST api/GlobalStar/ReceivePrvMessage

Request Information

URI Parameters

None.

Body Parameters

prvmsgs
NameDescriptionTypeAdditional information
prvmsg

Collection of prvmsgsPrvmsg

None.

timeStamp

string

None.

prvMessageID

string

None.

Request Formats

application/json, text/json

Sample:
{
  "prvmsgField": [
    {
      "esnField": "sample string 1",
      "provIDField": "sample string 2",
      "tStartField": "sample string 3",
      "tEndField": "sample string 4",
      "txRetryMinSecField": "sample string 5",
      "txRetryMaxSecField": "sample string 6",
      "txRetriesField": "sample string 7",
      "rfChannelField": "sample string 8"
    },
    {
      "esnField": "sample string 1",
      "provIDField": "sample string 2",
      "tStartField": "sample string 3",
      "tEndField": "sample string 4",
      "txRetryMinSecField": "sample string 5",
      "txRetryMaxSecField": "sample string 6",
      "txRetriesField": "sample string 7",
      "rfChannelField": "sample string 8"
    }
  ],
  "timeStampField": "sample string 1",
  "prvMessageIDField": "sample string 2"
}

application/xml, text/xml

Sample:
<prvmsgs xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" timeStamp="sample string 1" prvMessageID="sample string 2">
  <prvmsg>
    <esn>sample string 1</esn>
    <provID>sample string 2</provID>
    <tStart>sample string 3</tStart>
    <tEnd>sample string 4</tEnd>
    <txRetryMinSec>sample string 5</txRetryMinSec>
    <txRetryMaxSec>sample string 6</txRetryMaxSec>
    <txRetries>sample string 7</txRetries>
    <rfChannel>sample string 8</rfChannel>
  </prvmsg>
  <prvmsg>
    <esn>sample string 1</esn>
    <provID>sample string 2</provID>
    <tStart>sample string 3</tStart>
    <tEnd>sample string 4</tEnd>
    <txRetryMinSec>sample string 5</txRetryMinSec>
    <txRetryMaxSec>sample string 6</txRetryMaxSec>
    <txRetries>sample string 7</txRetries>
    <rfChannel>sample string 8</rfChannel>
  </prvmsg>
</prvmsgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

prvResponseMsg
NameDescriptionTypeAdditional information
state

prvResponseMsgState

None.

stateMessage

string

None.

deliveryTimeStamp

string

None.

prvMessageID

string

None.

correlationID

string

None.

Schema

string

None.

Response Formats

application/json, text/json

Sample:
{
  "stateField": 0,
  "stateMessageField": "sample string 1",
  "deliveryTimeStampField": "sample string 2",
  "prvMessageIDField": "sample string 3",
  "correlationIDField": "sample string 4",
  "Schema": "sample string 1"
}

application/xml, text/xml

Sample:
<prvResponseMsg xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="sample string 1" deliveryTimeStamp="sample string 2" prvMessageID="sample string 3" correlationID="sample string 4">
  <state>pass</state>
  <stateMessage>sample string 1</stateMessage>
</prvResponseMsg>