RemoveCompaniesFromProject

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 cannot perform the following actions:

AddCompaniesToProject
GetDocumentsByProject
SendDocumentsToProject
EditProject
GetAllProjects - The project removed is not displayed in the list

Request

Parameter	Type	Mandatory/Optional	Maximum character length/limit	Description
companiesToBeRemoved	List<RemoveCompany>	Mandatory	Not relevant	List of the companies to be removed from the project. Either CompanyIds or OrganizationNumbers should be provided
projectId	long	Mandatory	Not relevant	The Id of the project
applicationName	string	Mandatory	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 method updates the edited project related information and 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 length has exceeded the maximum character limit allowed (10)
146	The applicationName is not set
167	You are not authorized to use this method
223	The given project is not owned by the company or does not exist, therefore this action cannot be performed
227	The project does not exist or the company is not connected to the given project
228	projectId is not provided
249	You are not authorized to perform this action
258	Unable to find a company registered to the given OrganizationNumber
261	Neither CompanyId or OrganizationNumber is provided
262	Company which owns the project cannot be removed
316	You cannot perform this action on a closed project
321	Company removed successfully but email is not sent