Description
This web method returns is used to return a list of all projects associated with the company of the current user. This list includes the projects which are owned by the company, and the projects that the company has been added to. The project instances could be either BuildingProjects, PropertyProjects or Projects (Instances where a project is not connected to either a building or a property). This list includes the projects which are owned by the company,and the projects that the current company is added to.
Request
| Parameter | Type | Mandatory/OptionalComments | Maximum character length/limit | Description | |
|---|---|---|---|---|---|
applicationName | Stringstring | MandatoryThird party application identifier, identifying the client consuming the web service – (Length of the applicationName should | Should be less than or equal to 10 | )characters | The name of the integration partner |
Request - sample input
Response
| Type | Description |
|---|---|
| List<Project> | A list of projects which the current company is associated to. The actual instances of the list will be either BuildingProjects, PropertyProjects or Projects |
Request - sample output
Exceptions
| Error Code | Description |
|---|---|
123 | An exception occurred while processing your request |
| 138 | ApplicationName applicationName length is has exceeded the maximum allowed character limit allowed (10) |
| 146 | The application name is applicationName is not set |
| 167 | You are not authorized to use this web method |
Known issues
Please note that there can be byte limitations in your API testing client. If the size of the response exceeds that limit, an error can be thrown.