Description
This web service returns details of all devices in the given project.
Request
Parameter | Type | Mandatory/Optional | Comments |
---|---|---|---|
input | GetDevicesForProjectInput | Mandatory | The project identification |
applicationName | String | Mandatory | Third party application identifier, identifying the client consuming the web service – (Length of the applicationName should be less than or equal to 10) |
GetDevicesForProjectInput
Parameter | Type | Mandatory/optional | Comments |
---|---|---|---|
ProjectId | long | mandatory*/optional | Project ID |
ProjectCode | string | optional/mandatory* | Project Code e.g. ABC0001-A1 |
Note: * Only the ID will be considered if it's given (first priority). i.e. Code will be considered only if ID is absent.
Response: GetDevicesForProjectOutput
Property | Type | Description |
---|---|---|
ProjectID | long | ID of the project requested (for verification) |
Devices | List<Device> | List of the devices in the project * |
Note: * The Devices list will be empty in case there are no devices in the project; no exception or error will be returned: just an empty list
Exceptions
Error Code | Description |
---|---|
123 | An exception occured while processing your request |
138 | ApplicationName length is exceeded: maximum allowed character limit (10) |
146 | The application name is not set |
167 | You are not authorized to use this web method |
227 | The project does not exist or the company is not connected to the given project |
252 | No input is provided to project Id or project code. Need at least one of them |
254 | Invalid project code |
273 | Project does not exist |