GET

/Common/Lookup

Usage Notes

When

Retrieve valid values for type ID fields
Look up ID-value pairs for any type classification

Requirements

Name parameter specifying lookup category

Notes

57 lookup categories available
Always use for type IDs (never hardcode values)
Categories include: bizEntityTypeID, addressTypeID, communicationTypeID, etc.

Description

Returns ID-value pairs for the specified lookup category. Use to retrieve valid values for all type ID fields across the API.

Required Headers

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

Header	Value	Description
Version	2.0	API 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.
  ]
}