Home → API Documentation → Miscellaneous API Calls → api/PortalList

11.3. api/PortalList

This API call is used to return various options available for dropdown selections.

Available List Options

•    County – Returns all County options that are within the client’s CRM.

•    Country – Returns all Country options that are within the client’s CRM.

•    WhereHear – Returns all sources of lead options that are within the client’s CRM.

•    BusinessCategory – Returns all the different business category types that are within the client’s CRM.

•    Classification – Returns all classification options that are within the client’s CRM (if applicable).

•    Subscriptions – Returns all available membership/customer subscription packages available if users wish to "Join".

•    Postcode|yourpostcodevalue - (e.g. Postcode|LS12) used as part of the registration process to return records matching the supplied postcode. Results will include a "My Organisation Is Not Listed" option (See Registration method).

•    OfferCategory – Returns all Offer categories that are within the client’s CRM.

•    EventCategory – Returns all Event categories that are within the client’s CRM.

•    NewsCategory – Returns all News categories that are within the client’s CRM.

•    VacancyCategory – Returns all Vacancy categories that are within the client’s CRM.

Parameters To Submit

All parameters are required and cannot be empty.

Parameter	Parameter Help
List	A list of available options is shown above under “Available List Options”.

 

Return Response

This API call will return an array of all items relating to the list option submitted.