GET api/v1/reports/messages/{messageId}/notifications

Retrieves all the notifications the secure/long message has sent out along with the status of the notification messages.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
messageId

Unique identifier for a message.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

A list of notifications

ResponseOfReportResponseData[]
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfReportResponseData[]

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": [
      {
        "Status": "sample string 1",
        "Statuscolor": "sample string 2",
        "DateSubmitted": "sample string 3",
        "DateSent": "sample string 4",
        "Header": "sample string 5",
        "Text": "sample string 6",
        "Part": 7,
        "Total": 8,
        "Ref": 9,
        "Encoding": "sample string 10",
        "UDH": "sample string 11",
        "NotificationType": "sample string 12",
        "Destination": "sample string 13"
      },
      {
        "Status": "sample string 1",
        "Statuscolor": "sample string 2",
        "DateSubmitted": "sample string 3",
        "DateSent": "sample string 4",
        "Header": "sample string 5",
        "Text": "sample string 6",
        "Part": 7,
        "Total": 8,
        "Ref": 9,
        "Encoding": "sample string 10",
        "UDH": "sample string 11",
        "NotificationType": "sample string 12",
        "Destination": "sample string 13"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<ResponseOfArrayOfReportResponseData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <ReportResponseData>
        <Status>sample string 1</Status>
        <Statuscolor>sample string 2</Statuscolor>
        <DateSubmitted>sample string 3</DateSubmitted>
        <DateSent>sample string 4</DateSent>
        <Header>sample string 5</Header>
        <Text>sample string 6</Text>
        <Part>7</Part>
        <Total>8</Total>
        <Ref>9</Ref>
        <Encoding>sample string 10</Encoding>
        <UDH>sample string 11</UDH>
        <NotificationType>sample string 12</NotificationType>
        <Destination>sample string 13</Destination>
      </ReportResponseData>
      <ReportResponseData>
        <Status>sample string 1</Status>
        <Statuscolor>sample string 2</Statuscolor>
        <DateSubmitted>sample string 3</DateSubmitted>
        <DateSent>sample string 4</DateSent>
        <Header>sample string 5</Header>
        <Text>sample string 6</Text>
        <Part>7</Part>
        <Total>8</Total>
        <Ref>9</Ref>
        <Encoding>sample string 10</Encoding>
        <UDH>sample string 11</UDH>
        <NotificationType>sample string 12</NotificationType>
        <Destination>sample string 13</Destination>
      </ReportResponseData>
    </Detail>
  </ResponseData>
</ResponseOfArrayOfReportResponseData>