GET api/v1/reports/messages/fof

Fetches all the messages that the user has sent a FOF message with a list of all the people who have replied to the message.

Request Information

URI Parameters

None.

Body Parameters

The filter to be applied to the report.

FOFFilter
NameDescriptionTypeAdditional information
Groups

The list of groups to compare with inbound messages.

Collection of globally unique identifier

None.

RelativeName

The time frame to search for.

FOFDateRange

None.

StartDate

The start date of the search.

date

None.

EndDate

The end date of the search.

date

None.

SoftwareVersion

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Groups": [
    "c49baed2-6f6a-4f8a-8625-497c41bf8444",
    "0634f99d-046c-452f-b551-7d2de3dc9ccc"
  ],
  "RelativeName": 0,
  "StartDate": "2017-09-24T12:19:24.880795Z",
  "EndDate": "2017-09-24T12:19:24.880795Z",
  "SoftwareVersion": "sample string 1"
}

application/xml, text/xml

Sample:
<FOFFilter xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Groups>
    <guid>c49baed2-6f6a-4f8a-8625-497c41bf8444</guid>
    <guid>0634f99d-046c-452f-b551-7d2de3dc9ccc</guid>
  </Groups>
  <RelativeName>TODAY</RelativeName>
  <StartDate>2017-09-24T12:19:24.880795Z</StartDate>
  <EndDate>2017-09-24T12:19:24.880795Z</EndDate>
  <SoftwareVersion>sample string 1</SoftwareVersion>
</FOFFilter>

Response Information

Resource Description

ResponseOfFOFReport
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfFOFReport

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": {
      "Header": "sample string 1",
      "Messages": [
        {
          "DateSent": "2017-09-24T12:19:24.900629Z",
          "Groups": [
            {
              "Name": "sample string 1",
              "Responses": [
                {},
                {}
              ]
            },
            {
              "Name": "sample string 1",
              "Responses": [
                {},
                {}
              ]
            }
          ],
          "Message": "sample string 2"
        },
        {
          "DateSent": "2017-09-24T12:19:24.900629Z",
          "Groups": [
            {
              "Name": "sample string 1",
              "Responses": [
                {},
                {}
              ]
            },
            {
              "Name": "sample string 1",
              "Responses": [
                {},
                {}
              ]
            }
          ],
          "Message": "sample string 2"
        }
      ]
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfFOFReport 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>
      <Header>sample string 1</Header>
      <Messages>
        <FOFReportDetail>
          <DateSent>2017-09-24T12:19:24.900629Z</DateSent>
          <Groups>
            <FOFGroupDetail>
              <Name>sample string 1</Name>
              <Responses>
                <FOFReportResponse>
                  <DateReceived>2017-09-24T12:19:24.900629Z</DateReceived>
                  <Name>sample string 1</Name>
                  <Number>sample string 2</Number>
                  <Response>sample string 3</Response>
                </FOFReportResponse>
                <FOFReportResponse>
                  <DateReceived>2017-09-24T12:19:24.900629Z</DateReceived>
                  <Name>sample string 1</Name>
                  <Number>sample string 2</Number>
                  <Response>sample string 3</Response>
                </FOFReportResponse>
              </Responses>
            </FOFGroupDetail>
            <FOFGroupDetail>
              <Name>sample string 1</Name>
              <Responses>
                <FOFReportResponse>
                  <DateReceived>2017-09-24T12:19:24.900629Z</DateReceived>
                  <Name>sample string 1</Name>
                  <Number>sample string 2</Number>
                  <Response>sample string 3</Response>
                </FOFReportResponse>
                <FOFReportResponse>
                  <DateReceived>2017-09-24T12:19:24.900629Z</DateReceived>
                  <Name>sample string 1</Name>
                  <Number>sample string 2</Number>
                  <Response>sample string 3</Response>
                </FOFReportResponse>
              </Responses>
            </FOFGroupDetail>
          </Groups>
          <Message>sample string 2</Message>
        </FOFReportDetail>
        <FOFReportDetail>
          <DateSent>2017-09-24T12:19:24.900629Z</DateSent>
          <Groups>
            <FOFGroupDetail>
              <Name>sample string 1</Name>
              <Responses>
                <FOFReportResponse>
                  <DateReceived>2017-09-24T12:19:24.900629Z</DateReceived>
                  <Name>sample string 1</Name>
                  <Number>sample string 2</Number>
                  <Response>sample string 3</Response>
                </FOFReportResponse>
                <FOFReportResponse>
                  <DateReceived>2017-09-24T12:19:24.900629Z</DateReceived>
                  <Name>sample string 1</Name>
                  <Number>sample string 2</Number>
                  <Response>sample string 3</Response>
                </FOFReportResponse>
              </Responses>
            </FOFGroupDetail>
            <FOFGroupDetail>
              <Name>sample string 1</Name>
              <Responses>
                <FOFReportResponse>
                  <DateReceived>2017-09-24T12:19:24.900629Z</DateReceived>
                  <Name>sample string 1</Name>
                  <Number>sample string 2</Number>
                  <Response>sample string 3</Response>
                </FOFReportResponse>
                <FOFReportResponse>
                  <DateReceived>2017-09-24T12:19:24.900629Z</DateReceived>
                  <Name>sample string 1</Name>
                  <Number>sample string 2</Number>
                  <Response>sample string 3</Response>
                </FOFReportResponse>
              </Responses>
            </FOFGroupDetail>
          </Groups>
          <Message>sample string 2</Message>
        </FOFReportDetail>
      </Messages>
    </Detail>
  </ResponseData>
</ResponseOfFOFReport>