GetBusinessTrade()

The GetBusinessTrade() command returns the business trade information for the give business trade ID.

  • Quota: 1
Table 1. Parameters
ParameterTypeMax LengthRequiredDescription
apiTokenstring20YYour API security token configured in Field View.
businessTradeIDintegerYThe business trade ID you wish to retrieve information for.
Table 2. Returns
FieldTypeDescription
BusinessTradeInformationBusinessTradeInformationBusiness 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>