...
| Parameter | Type | Mandatory/OptionalComments | Maximum character length/limit | Description |
|---|---|---|---|---|
input | GetMyDocumentsByPlantIdInput | Mandatory | Not relevant | GetMyDocumentsByPlantIdInput model |
| applicationName | string | Mandatory | Third 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 |
GetMyDocumentsByPlantIdInput
| Parameter | Type | Mandatory/Optional | CommentsDescription |
|---|---|---|---|
| PlantIdplantId | long | Mandatory | The provided plant ID plantId should belong to the same company as the user. |
Request - sample input
Response
| Type | Description |
|---|---|
GetMyDocumentsByPlantIdOutput | GetMyDocumentsByPlantIdOutput model |
GetMyDocumentsByPlantIdOutput
| Parameter | Type | CommentsDescription |
|---|---|---|
| Document | List<Document> | List of documents uploaded by the user for the given plant id |
...
| plantId |
Response - sample output
Exceptions
| Error Code | Description |
|---|---|
111 | PlantId plantId does not exist for your company. |
130 | Input plant ID plantId is either zero or negative. Please enter a positive value for the id |
132 | PlantId plantId does not exist |
| 138 | ApplicationName applicationName length is has exceeded the maximum allowed character limit allowed (10) |
| 146 | The application name applicationName is not set |
| 167 | You are not authorized to use this web method |