GetBusinessPackages()

The GetBusinessPackages() command returns a list of business packages in Field View.

  • Quota: 1
Table 1. Parameters
ParameterTypeMax LengthRequiredDescription
apiToken string20Y Your API security token configured in Field View.
businessPackageDescription string100 Filters the returned results where the business package description contains the supplied string.
businessUnitIDs String[]100 Filters the returned results where the business package is business unit, is in the supplied business unit ids. Otherwise, the function will return all business packages in and above the business unit ID the API token was configured against. The business units ids should be contained in GetBusinessUnits().
activeOnlybooleanY If true, only active business packages will be returned. If false, all business packages will be returned.
startRow integerY The start row range of records you wish to retrieve.
pageSizeintegerY The number of records you wish to retrieve.
Table 2. Returns
FieldTypeDescription
BusinessPackageInformationBusinessPackageInformation Business package information structure.
Note: <PackageTradeInformation> will not contain any rows. To get the package trades information call GetPackageTrades().
<BusinessPackageResponse>
       <Status>
           SUCCESS
           <Message>Success.</Message>
       </Status>
       <BusinessPackageInformation>
           <ID></ID>
           <Description></Description>
           <PackageTradeInformation></PackageTradeInformation>
           <OurRef></OurRef>
           <YourRef></YourRef>
           <VisibilityOrganisationID></VisibilityOrganisationID>
           <OrganisationUnitAndBelow></OrganisationUnitAndBelow>
           <VisibilityOrganisation></VisibilityOrganisation>
           <OwnerOrganisationID></OwnerOrganisationID>
           <OwnerOrganisation></OwnerOrganisation>
           <ResolutionDays></ResolutionDays>
           <Active></Active>
       </BusinessPackageInformation>
   </BusinessPackageResponse>