POST api/GlobalStar/ReceiveStuMessage
Request Information
URI Parameters
None.
Body Parameters
stuMessages| Name | Description | Type | Additional information |
|---|---|---|---|
| stuMessage | Collection of stuMessagesStuMessage |
None. |
|
| timeStamp | string |
None. |
|
| messageID | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"stuMessageField": [
{
"esnField": "sample string 1",
"unixTimeField": 2,
"gpsField": "sample string 3",
"umnField": 64,
"payloadField": {
"lengthField": 64,
"lengthFieldSpecified": true,
"sourceField": "sample string 3",
"encodingField": "sample string 4",
"valueField": "sample string 5"
},
"textField": [
"sample string 1",
"sample string 2"
]
},
{
"esnField": "sample string 1",
"unixTimeField": 2,
"gpsField": "sample string 3",
"umnField": 64,
"payloadField": {
"lengthField": 64,
"lengthFieldSpecified": true,
"sourceField": "sample string 3",
"encodingField": "sample string 4",
"valueField": "sample string 5"
},
"textField": [
"sample string 1",
"sample string 2"
]
}
],
"timeStampField": "sample string 1",
"messageIDField": "sample string 2"
}
application/xml, text/xml
Sample:
<stuMessages xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" timeStamp="sample string 1" messageID="sample string 2">
<stuMessage>
<esn>sample string 1</esn>
<unixTime>2</unixTime>
<gps>sample string 3</gps>
<umn>64</umn>
<payload length="64" source="sample string 3" encoding="sample string 4">sample string 5</payload>sample string 1sample string 2</stuMessage>
<stuMessage>
<esn>sample string 1</esn>
<unixTime>2</unixTime>
<gps>sample string 3</gps>
<umn>64</umn>
<payload length="64" source="sample string 3" encoding="sample string 4">sample string 5</payload>sample string 1sample string 2</stuMessage>
</stuMessages>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
stuResponseMsg| Name | Description | Type | Additional information |
|---|---|---|---|
| state | stuResponseMsgState |
None. |
|
| stateMessage | string |
None. |
|
| deliveryTimeStamp | string |
None. |
|
| messageID | 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",
"messageIDField": "sample string 3",
"correlationIDField": "sample string 4",
"Schema": "sample string 1"
}
application/xml, text/xml
Sample:
<stuResponseMsg 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" messageID="sample string 3" correlationID="sample string 4"> <state>pass</state> <stateMessage>sample string 1</stateMessage> </stuResponseMsg>