Description
This method is used to remove one or more companies from a project. After a company is removed from a project, users of that company will not be able to cannot perform the following actions,:
- AddCompaniesToProject
- GetDocumentsByProject
- SendDocumentsToProject
- EditProject
- GetAllProjects - Will not see the specific project The project removed is not displayed in the list
Request
| Parameter | Type | Mandatory/OptionalComments | Maximum character length/limit | Description |
|---|---|---|---|---|
| companiesToBeRemoved | List<RemoveCompany> | Mandatory | Not relevant | List of the companies to be removed from the project. Either Company Ids CompanyIds or Organization Ids OrganizationNumbers should be provided |
| projectId | long | Mandatory | Not relevant | The Id of the project Id |
| 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 |
Request - sample input
<RemoveCompaniesFromProject>
<MethodParameters>
<UserAuthentication>
<UserName>username</UserName>
<Password>password</Password>
<AnyAttr attr0="XmlAttributeArray" isNull="false">
<XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
</AnyAttr>
</UserAuthentication>
<companiesToBeRemoved attr0="CompanyToBeRemovedArray" isNull="false">
<CompanyToBeRemovedArray0>
<CompanyId>197</CompanyId>
<OrganizationNumber>914350840</OrganizationNumber>
</CompanyToBeRemovedArray0>
</companiesToBeRemoved>
<projectId>60</projectId>
<applicationName>test</applicationName>
</MethodParameters>
</RemoveCompaniesFromProject>
Response
| Type | Description |
|---|---|
List<CompanyRemovalStatus> | EditProject web method will update updates the edited project related information and return returns the Project Model |
Response - sample output
RemoveCompaniesFromProject>
<MethodParameters>
<CompanyRemovalStatusArray>
<CompanyRemovalStatusArray0>
<CompanyId>197</CompanyId>
<OrganizationNumber>914350840</OrganizationNumber>
<Status>False</Status>
<ErrorCode>262</ErrorCode>
</CompanyRemovalStatusArray0>
</CompanyRemovalStatusArray>
</MethodParameters>
</RemoveCompaniesFromProject>
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 applicationName is not set |
| 167 | You are not authorized to use this web method |
| 223 | The given project is not owned by the company or does not exist, therefore this action cannot be performed |
| 227 | The The project does not exist or the company is not connected to the given project |
| 228 | Project Id projectId is not provided |
| 249 Please provide a valid company list to be removed | You are not authorized to perform this action |
| 258 | Unable Unable to find a company registered for to the given organization numberOrganizationNumber |
| 261 | Neither Company Id nor Organization Number Neither CompanyId or OrganizationNumber is provided |
| 262 | Company Company which owns the project can not cannot be removed |
| 316 | You cannot do perform this operation for action on a closed project |
| 321 | Company removed successfully but email is not sent |
...