GetBusinessTrades()

The GetBusinessTrades() command returns a list of business trades in Field View.

  • Quota: 1
Table 1. Parameters
ParameterTypeMax LengthRequiredDescription
apiTokenstring20Y Your API security token configured in Field View.
businessTradeDescriptionstring100 Filters the returned results where the business trade description contains the supplied string.
businessUnitIDs String[]100 Filters the returned results where the business trade is business unit, is in the supplied business unit ids. Otherwise, the function will return all business trades 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 trades will be returned. If false, all business trades will be returned.
startRowintegerY The start row range of records you wish to retrieve.
Note: The first record starts at row 0.
pageSizeintegerYThe number of records you wish to receive.
Table 2. Returns
FieldTypeDescription
BusinessTradeInformationBusinessTradeInformation Business trade information structure.
<BusinessTradeResponse>
       <Status>
           SUCCESS
           <Message>Success.</Message>
       </Status>
       <BusinessTradeInformation>
           <ID></ID>
           <Description></Description>
           <CategoryID></CategoryID>
           <Category></Category>
           <VisibilityOrganisationID></VisibilityOrganisationID>
           <OrganisationUnitAndBelow></OrganisationUnitAndBelow>
           <VisibilityOrganisation></VisibilityOrganisation>
           <OwnerOrganisationID></OwnerOrganisationID>
           <OwnerOrganisation></OwnerOrganisation>
           <HasLibraryTasks></HasLibraryTasks>
           <Active></Active>
       </BusinessTradeInformation>
   </BusinessTradeResponse>