GET

/Common/Lookup

Usage Notes

  • No authentication required - publicly accessible endpoint
  • Query Name=info to discover all available lookup categories
  • Category names are case-sensitive and must match exactly

Description

Returns ID-Value pairs for system lookup categories including address types, entity statuses, investment types, tax components, and more. Query to retrieve all available categories dynamically, then fetch specific category values for ID type values and validation lists.

Discovering Categories: Use Name=info to retrieve the complete list of available lookup categories. The API returns 57 categories across entity types, locations, transactions, investments, distributions, accounts, communications, and compliance fields.

Required Headers

No Authorization Header Required - This endpoint is publicly accessible without authentication.

HeaderValueDescription
Version2.0API version identifier

Query Parameters

Parameter Type Required Description
Name
string
Optional
Lookup category name (e.g., 'addressTypeID', 'titleID', 'investmentTypeID'). Use 'info' to retrieve all available categories. Case-sensitive.
Name
string
Optional
Lookup category name (e.g., 'addressTypeID', 'titleID', 'investmentTypeID'). Use 'info' to retrieve all available categories. Case-sensitive.

Example Requests

bash
# Get all categories
curl "https://api.7g.com.au/Common/Lookup?Name=info" \
  -H "Version: 2.0"

# Get specific category
curl "https://api.7g.com.au/Common/Lookup?Name=addressTypeID" \
  -H "Version: 2.0"

Response Examples

json
{
  "result": true,
  "message": "",
  "recordCount": 57,
  "data": [
    { "id": "accountStatusID", "value": "Account.accountStatusID" },
    { "id": "addressTypeID", "value": "InvestorAddress.addressTypeID" },
    { "id": "bizEntityTypeID", "value": "BizEntity.BizEntityTypeID" },
    { "id": "bizTransactionTypeID", "value": "BizTransactionType.BizTransactionTypeID" },
    { "id": "communicationTypeID", "value": "InvestorCommunication.communicationTypeID" },
    { "id": "distributionTermID", "value": "UnitClass.distributionTermID, DistributionImports.distributionTermID" },
    { "id": "investmentTypeID", "value": "Investment.investmentTypeID" },
    { "id": "paymentTypeID", "value": "PaymentDetail.paymentTypeID" },
    { "id": "TaxComponent", "value": "Distribution.TaxComponents.TaxComponent" },
    { "id": "titleID", "value": "person.TitleID" }
    ...
    // Note: Total 57 categories available. Call with Name='info' to retrieve complete list.
  ]
}