The GetProjectPackages() command returns a list of project packages in Field View.
|
| Parameter | Type | Max Length | Required | Description |
|---|---|---|---|---|
| apiToken | string | 20 | Y | Your API security token configured in Field View. |
| projectPackageDescription | string | 100 | Filters the returned results where the business package description contains the supplied string. | |
| projectID | integer | Y | The project ID for which to retrieve information. | |
| issuedToOrganisationId | integer | The specific issued to organisation ID you wish to retrieve information for. The issued to organisation ids should be contained in GetOrganisations(). | ||
| viewTopLevelPackages | boolean | Y | Set this to true so you retrieve packages created by the project owner. If set to false, it could return packages that sub-contractors are creating for themselves. | |
| activeOnly | boolean | Y | If true, only acive business packages will be returned. If false, all business packages will be returned. |
| Field | Type | Description |
|---|---|---|
| ProjectPackageInformation | ProjectPackageInformation | Project package information structure. |
Note:
<PackageTradeInformation> will not contain any rows. To get the package trades information call
GetPackageTrades().
<RoleInformation> will not contain any rows. To get the organisation roles information call
GetOrganisationRoles().
<ProjectPackageResponse>
<Status>
SUCCESS
<Message>Success.</Message>
</Status>
<ProjectPackageInformation>
<ID></ID>
<Description></Description>
<PackageTradeInformation></PackageTradeInformation>
<OurRef></OurRef>
<YourRef></YourRef>
<IssuedToOrganisationID></IssuedToOrganisationID>
<IssuedToOrganisation></IssuedToOrganisation>
<PackageEmail></PackageEmail>
<OrganisationEmail></OrganisationEmail>
<AutomaticallySendEmail></AutomaticallySendEmail>
<OrganisationTypeID></OrganisationTypeID>
<OrganisationType></OrganisationType>
<RoleInformation></RoleInformation>
<OwnerOrganisationID></OwnerOrganisationID>
<OwnerOrganisation></OwnerOrganisation>
<ResolutionDays></ResolutionDays>
<Default></Default>
<Active></Active>
</ProjectPackageInformation>
</ProjectPackageResponse>