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

Name	Description	Type	Additional 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. The format is the following:[YYYY-MM-DDTHH:MM:SSZ]	date	None.
EndDate	The end date of the search. The format is the following:[YYYY-MM-DDTHH:MM:SSZ]	date	None.
SoftwareVersion		string	None.

Request Formats

application/json, text/json

Sample:

{
  "Groups": [
    "1b184e21-1516-430c-a1ca-6fcad5a2e111",
    "d71d3127-14ee-472b-8142-fdf4f50b7257"
  ],
  "RelativeName": 0,
  "StartDate": "2024-04-23T21:30:08.8382789+00:00",
  "EndDate": "2024-04-23T21:30:08.8382789+00:00",
  "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>1b184e21-1516-430c-a1ca-6fcad5a2e111</guid>
    <guid>d71d3127-14ee-472b-8142-fdf4f50b7257</guid>
  </Groups>
  <RelativeName>TODAY</RelativeName>
  <StartDate>2024-04-23T21:30:08.8382789+00:00</StartDate>
  <EndDate>2024-04-23T21:30:08.8382789+00:00</EndDate>
  <SoftwareVersion>sample string 1</SoftwareVersion>
</FOFFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfFOFReport

Name	Description	Type	Additional 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": "2024-04-23T21:30:08.8443868+00:00",
          "Groups": [
            {
              "Name": "sample string 1",
              "Responses": [
                {},
                {}
              ]
            },
            {
              "Name": "sample string 1",
              "Responses": [
                {},
                {}
              ]
            }
          ],
          "Message": "sample string 2"
        },
        {
          "DateSent": "2024-04-23T21:30:08.8443868+00:00",
          "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>2024-04-23T21:30:08.8443868+00:00</DateSent>
          <Groups>
            <FOFGroupDetail>
              <Name>sample string 1</Name>
              <Responses>
                <FOFReportResponse>
                  <DateReceived>2024-04-23T21:30:08.8448962+00:00</DateReceived>
                  <Name>sample string 1</Name>
                  <Number>sample string 2</Number>
                  <Response>sample string 3</Response>
                </FOFReportResponse>
                <FOFReportResponse>
                  <DateReceived>2024-04-23T21:30:08.8448962+00:00</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>2024-04-23T21:30:08.8448962+00:00</DateReceived>
                  <Name>sample string 1</Name>
                  <Number>sample string 2</Number>
                  <Response>sample string 3</Response>
                </FOFReportResponse>
                <FOFReportResponse>
                  <DateReceived>2024-04-23T21:30:08.8448962+00:00</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>2024-04-23T21:30:08.8443868+00:00</DateSent>
          <Groups>
            <FOFGroupDetail>
              <Name>sample string 1</Name>
              <Responses>
                <FOFReportResponse>
                  <DateReceived>2024-04-23T21:30:08.8448962+00:00</DateReceived>
                  <Name>sample string 1</Name>
                  <Number>sample string 2</Number>
                  <Response>sample string 3</Response>
                </FOFReportResponse>
                <FOFReportResponse>
                  <DateReceived>2024-04-23T21:30:08.8448962+00:00</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>2024-04-23T21:30:08.8448962+00:00</DateReceived>
                  <Name>sample string 1</Name>
                  <Number>sample string 2</Number>
                  <Response>sample string 3</Response>
                </FOFReportResponse>
                <FOFReportResponse>
                  <DateReceived>2024-04-23T21:30:08.8448962+00:00</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>