GET 1.0/customermanagement/portals/troubleshoot/{siteprefix}/{siteid}/{propertyid}

Description

Gets a list of portals, their event logs and their file transfers for a passed property id and agent

URI Parameters

Name Description Type Additional information
sitePrefix

The SitePrefix of the Agent

string

Required

siteID

The SiteID/Branchid of the agent

integer

Required

propertyID

The Acquaint Id of the property

integer

Required

None.

None.

A list of Portals conating the Eventlog and File transfer records for the passed propertyid

Collection of TroubleshootPortal
Name Description Type Additional information
EventLogItems

Collection of PortalEventLogItem

None.

FileTransferItems

Collection of PortalFileTransferItem

None.

Prefix

string

None.

Name

string

None.

Url

string

None.

PaymentType

byte

None.

LogoUrl

string

None.

CountryCode

integer

None.

Hidden

boolean

None.

application/json, text/json

Sample:
[
  {
    "eventLogItems": [
      {
        "id": 1,
        "addedDate": "2026-01-12T08:54:59.3192218+00:00",
        "sitePrefix": "sample string 3",
        "siteID": 4,
        "portalPrefix": "sample string 5",
        "propertyID": 6,
        "description": "sample string 7",
        "isError": true
      },
      {
        "id": 1,
        "addedDate": "2026-01-12T08:54:59.3192218+00:00",
        "sitePrefix": "sample string 3",
        "siteID": 4,
        "portalPrefix": "sample string 5",
        "propertyID": 6,
        "description": "sample string 7",
        "isError": true
      }
    ],
    "fileTransferItems": [
      {
        "portalPrefix": "sample string 1",
        "sitePrefix": "sample string 2",
        "fileName": "sample string 3",
        "fileSize": 4,
        "transferDate": "2026-01-12T08:54:59.3192218+00:00",
        "propertyID": 6,
        "portalBranchID": "sample string 7"
      },
      {
        "portalPrefix": "sample string 1",
        "sitePrefix": "sample string 2",
        "fileName": "sample string 3",
        "fileSize": 4,
        "transferDate": "2026-01-12T08:54:59.3192218+00:00",
        "propertyID": 6,
        "portalBranchID": "sample string 7"
      }
    ],
    "prefix": "sample string 1",
    "name": "sample string 2",
    "url": "sample string 3",
    "paymentType": 64,
    "logoUrl": "sample string 5",
    "countryCode": 6,
    "hidden": true
  },
  {
    "eventLogItems": [
      {
        "id": 1,
        "addedDate": "2026-01-12T08:54:59.3192218+00:00",
        "sitePrefix": "sample string 3",
        "siteID": 4,
        "portalPrefix": "sample string 5",
        "propertyID": 6,
        "description": "sample string 7",
        "isError": true
      },
      {
        "id": 1,
        "addedDate": "2026-01-12T08:54:59.3192218+00:00",
        "sitePrefix": "sample string 3",
        "siteID": 4,
        "portalPrefix": "sample string 5",
        "propertyID": 6,
        "description": "sample string 7",
        "isError": true
      }
    ],
    "fileTransferItems": [
      {
        "portalPrefix": "sample string 1",
        "sitePrefix": "sample string 2",
        "fileName": "sample string 3",
        "fileSize": 4,
        "transferDate": "2026-01-12T08:54:59.3192218+00:00",
        "propertyID": 6,
        "portalBranchID": "sample string 7"
      },
      {
        "portalPrefix": "sample string 1",
        "sitePrefix": "sample string 2",
        "fileName": "sample string 3",
        "fileSize": 4,
        "transferDate": "2026-01-12T08:54:59.3192218+00:00",
        "propertyID": 6,
        "portalBranchID": "sample string 7"
      }
    ],
    "prefix": "sample string 1",
    "name": "sample string 2",
    "url": "sample string 3",
    "paymentType": 64,
    "logoUrl": "sample string 5",
    "countryCode": 6,
    "hidden": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfTroubleshootPortal xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <TroubleshootPortal>
    <Prefix>sample string 1</Prefix>
    <Name>sample string 2</Name>
    <Url>sample string 3</Url>
    <PaymentType>64</PaymentType>
    <LogoUrl>sample string 5</LogoUrl>
    <CountryCode>6</CountryCode>
    <Hidden>true</Hidden>
    <EventLogItems>
      <PortalEventLogItem>
        <ID>1</ID>
        <AddedDate>2026-01-12T08:54:59.3192218+00:00</AddedDate>
        <SitePrefix>sample string 3</SitePrefix>
        <SiteID>4</SiteID>
        <PortalPrefix>sample string 5</PortalPrefix>
        <PropertyID>6</PropertyID>
        <Description>sample string 7</Description>
        <IsError>true</IsError>
      </PortalEventLogItem>
      <PortalEventLogItem>
        <ID>1</ID>
        <AddedDate>2026-01-12T08:54:59.3192218+00:00</AddedDate>
        <SitePrefix>sample string 3</SitePrefix>
        <SiteID>4</SiteID>
        <PortalPrefix>sample string 5</PortalPrefix>
        <PropertyID>6</PropertyID>
        <Description>sample string 7</Description>
        <IsError>true</IsError>
      </PortalEventLogItem>
    </EventLogItems>
    <FileTransferItems>
      <PortalFileTransferItem>
        <PortalPrefix>sample string 1</PortalPrefix>
        <SitePrefix>sample string 2</SitePrefix>
        <FileName>sample string 3</FileName>
        <FileSize>4</FileSize>
        <TransferDate>2026-01-12T08:54:59.3192218+00:00</TransferDate>
        <PropertyID>6</PropertyID>
        <PortalBranchID>sample string 7</PortalBranchID>
      </PortalFileTransferItem>
      <PortalFileTransferItem>
        <PortalPrefix>sample string 1</PortalPrefix>
        <SitePrefix>sample string 2</SitePrefix>
        <FileName>sample string 3</FileName>
        <FileSize>4</FileSize>
        <TransferDate>2026-01-12T08:54:59.3192218+00:00</TransferDate>
        <PropertyID>6</PropertyID>
        <PortalBranchID>sample string 7</PortalBranchID>
      </PortalFileTransferItem>
    </FileTransferItems>
  </TroubleshootPortal>
  <TroubleshootPortal>
    <Prefix>sample string 1</Prefix>
    <Name>sample string 2</Name>
    <Url>sample string 3</Url>
    <PaymentType>64</PaymentType>
    <LogoUrl>sample string 5</LogoUrl>
    <CountryCode>6</CountryCode>
    <Hidden>true</Hidden>
    <EventLogItems>
      <PortalEventLogItem>
        <ID>1</ID>
        <AddedDate>2026-01-12T08:54:59.3192218+00:00</AddedDate>
        <SitePrefix>sample string 3</SitePrefix>
        <SiteID>4</SiteID>
        <PortalPrefix>sample string 5</PortalPrefix>
        <PropertyID>6</PropertyID>
        <Description>sample string 7</Description>
        <IsError>true</IsError>
      </PortalEventLogItem>
      <PortalEventLogItem>
        <ID>1</ID>
        <AddedDate>2026-01-12T08:54:59.3192218+00:00</AddedDate>
        <SitePrefix>sample string 3</SitePrefix>
        <SiteID>4</SiteID>
        <PortalPrefix>sample string 5</PortalPrefix>
        <PropertyID>6</PropertyID>
        <Description>sample string 7</Description>
        <IsError>true</IsError>
      </PortalEventLogItem>
    </EventLogItems>
    <FileTransferItems>
      <PortalFileTransferItem>
        <PortalPrefix>sample string 1</PortalPrefix>
        <SitePrefix>sample string 2</SitePrefix>
        <FileName>sample string 3</FileName>
        <FileSize>4</FileSize>
        <TransferDate>2026-01-12T08:54:59.3192218+00:00</TransferDate>
        <PropertyID>6</PropertyID>
        <PortalBranchID>sample string 7</PortalBranchID>
      </PortalFileTransferItem>
      <PortalFileTransferItem>
        <PortalPrefix>sample string 1</PortalPrefix>
        <SitePrefix>sample string 2</SitePrefix>
        <FileName>sample string 3</FileName>
        <FileSize>4</FileSize>
        <TransferDate>2026-01-12T08:54:59.3192218+00:00</TransferDate>
        <PropertyID>6</PropertyID>
        <PortalBranchID>sample string 7</PortalBranchID>
      </PortalFileTransferItem>
    </FileTransferItems>
  </TroubleshootPortal>
</ArrayOfTroubleshootPortal>