Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

/autoimport/list

This action lists all auto imports configured for the organization.

Request

Example:

curl -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer ACCESS_TOKEN' \
     https://ppw.web/svc/autoimport/list

Response

A successful response returns a list of AutoImport objects. Each object has the following fields:

FieldDescriptionType
autoimport_idUnique identifier for an auto importnumber
import_nameCanonical import namestring
activeSet to 1 if active; 0 otherwisenumber
friendly_nameUser provided Friendly name for the auto importstring
api_capabilitiesList of api capabilities. Can have the following values – “upload”, “export”array

The api_capabilities field for an auto import in the response lists the names of the AutoImport API actions that can be used for the given auto import. If the api_capabilities is empty for a given auto import, that means API actions available under the AutoImport API service are not supported for that auto import.

Example successful response:

[{
    "autoimport_id": 70,
    "import_name": "PPWizardLink",
    "client_company_name": "Core Logic",
    "active": 1,
    "friendly_name": "PPW Link - DKR",
    "api_capabilities": []
  },
  {
    "autoimport_id": 72,
    "import_name": "EZinspections",
    "client_company_name": "Core Logic",
    "active": 1,
    "friendly_name": "EZInspections - UANV",
    "api_capabilities": []
  },
  {
    "autoimport_id": 74,
    "import_name": "LPSAuto",
    "client_company_name": "Core Logic",
    "active": 1,
    "friendly_name": "SL - Auto",
    "api_capabilities": []
  },
  {
    "autoimport_id": 77,
    "import_name": "AssetShield",
    "client_company_name": "Core Logic",
    "active": 1,
    "friendly_name": "AssetShield - CNAS",
    "api_capabilities": []
  },
  {
    "autoimport_id": 78,
    "import_name": "YardiHUDP260API",
    "client_company_name": "Service Link",
    "active": 1,
    "friendly_name": "Yardi HUD P260 - API - CC",
    "api_capabilities": []
  },
  {
    "autoimport_id": 80,
    "import_name": "PHHMSPINS",
    "client_company_name": "PHH",
    "active": 1,
    "friendly_name": "VRM PHH MSP - INS",
    "api_capabilities": [
      "upload",
      "export"
    ]
  }
]

Errors

Error TypeDescriptionStatus Code
access_deniedAccess token is invalid or expired401
scope_invalidClient app does not have the required OAuth scope403