Note:
This
methodis an upgraded version of the GetDocumentsByProject method with more
meta data. It is advisable to usemetadata. Use this method as the previous is now obsolete.
GetDocumentsByProjectInput is a single input parameter introduced in this method to enclose all the existing input parameters of the previous method in a single place with the exception of the applicationName.
The new output field will only be available after the next production releaseA new method GetDocumentsByProject3 has been introduced which is improved in performance but does not contain DocumentCopiedPropertyDetails field in the output. if this field is not required please integrate GetDocumentsByProject3 method.
Description
This method is used to return a list of documents added to a project. All users that belong to a company that is associated with the project can access all the project documents.
...
NOTE: It is mandatory to provide either the projectCode or projectId. First preference is always given to the projectId, if both the projectCode and projectId are provided.
Request - sample input
<GetDocumentsByProject2>
<MethodParameters>
<UserAuthentication>
<UserName>username</UserName>
<Password>password</Password>
<AnyAttr attr0="XmlAttributeArray" isNull="false">
<XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
</AnyAttr>
</UserAuthentication>
<input>
<ProjectId>1109</ProjectId>
<ProjectCode isNull="false" />
</input>
<applicationName>test</applicationName>
</MethodParameters>
</GetDocumentsByProject2>
Response
Type | Description |
---|---|
GetDocumentsByProjectOutput | GetDocumentsByProjectOutput Model |
GetDocumentsByProjectOutput
Parameter | Type | Description |
---|---|---|
ProjectDocuments | List<ProjectDocument> | Project Document Response model list |
...
Response - sample output
<GetDocumentsByProject2>
<MethodParameters>
<GetDocumentsByProjectOutput>
<ProjectDocuments attr0="ProjectDocumentArray" isNull="false">
<ProjectDocumentArray0>
<DocumentId>54618</DocumentId>
<FileName>infoland-org.png</FileName>
<FileTypeId>10</FileTypeId>
<DocumentTypeId>2</DocumentTypeId>
<Title>test</Title>
<Description>test test</Description>
<OrderNumber>23423424</OrderNumber>
<IsVisibleInBoligmappa>False</IsVisibleInBoligmappa>
<UpdatedDate>7/26/2017 12:15:35 PM</UpdatedDate>
<Url>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=5EF%2fpT8WL%2f6uSd9XlcGF2kE5L%2bZezIt3fi7ZP81WJRXOI9rczHDDxnpJhYyoK%2bGz</Url>
<PdfDocId>54619</PdfDocId>
<ApplicationTag>test</ApplicationTag>
<CompanyId>197</CompanyId>
<ProfessionId>-1</ProfessionId>
<ProfessionName>Ikke spesifisert</ProfessionName>
<BuildingId>0</BuildingId>
<RoomIds isNull="true" />
<DeviceIds isNull="true" />
<OrganizationNumber>914350840</OrganizationNumber>
<UpdatedBy>Sameerahellen</UpdatedBy>
<ChapterTags attr0="ChapterTagOutputArray" isNull="false">
<ChapterTagOutputArray0>
<Id>10</Id>
<TagName>Annet nyttig</TagName>
<TagDescription isNull="true" />
</ChapterTagOutputArray0>
</ChapterTags>
<Company>
<Id>197</Id>
<OrganizationNumber>914350840</OrganizationNumber>
<CompanyName>VEGA 1 AS Avdeling Admninistrasjon</CompanyName>
</Company>
<ApartmentTags attr0="ApartmentTagsOutputArray" isNull="false" />
<DocumentCopiedPropertyDetails attr0="PropertyDetailsOfCopiedDocumentsArray" isNull="false" />
</ProjectDocumentArray0>
<ProjectDocumentArray1>
<DocumentId>54620</DocumentId>
<FileName>2017-07-12_06-13-46.jpg</FileName>
<FileTypeId>9</FileTypeId>
<DocumentTypeId>0</DocumentTypeId>
<Title>2017-07-12_06-13-46.jpg</Title>
<Description isNull="true" />
<OrderNumber isNull="true" />
<IsVisibleInBoligmappa>True</IsVisibleInBoligmappa>
<UpdatedDate>7/27/2017 12:39:56 PM</UpdatedDate>
<Url>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=5EF%2fpT8WL%2f6uSd9XlcGF2mCYfIo55cQDAP4yBWROlLdcrGyhrwFDNmEWJYbuDeEL</Url>
<PdfDocId>54621</PdfDocId>
<ApplicationTag>test</ApplicationTag>
<CompanyId>197</CompanyId>
<ProfessionId>8</ProfessionId>
<ProfessionName>Tak/blikkenslager</ProfessionName>
<BuildingId>0</BuildingId>
<RoomIds isNull="true" />
<DeviceIds isNull="true" />
<OrganizationNumber>914350840</OrganizationNumber>
<UpdatedBy>Sameerahellen</UpdatedBy>
<ChapterTags attr0="ChapterTagOutputArray" isNull="false">
<ChapterTagOutputArray0>
<Id>3</Id>
<TagName>Informasjon om tekniske anlegg i boligen</TagName>
<TagDescription isNull="true" />
</ChapterTagOutputArray0>
<ChapterTagOutputArray1>
<Id>4</Id>
<TagName>Samsvarserklæringer og garantibevis</TagName>
<TagDescription isNull="true" />
</ChapterTagOutputArray1>
<ChapterTagOutputArray2>
<Id>5</Id>
<TagName>Sjekklister, målinger og kontrollskjema</TagName>
<TagDescription isNull="true" />
</ChapterTagOutputArray2>
</ChapterTags>
<Company>
<Id>197</Id>
<OrganizationNumber>914350840</OrganizationNumber>
<CompanyName>VEGA 1 AS Avdeling Admninistrasjon</CompanyName>
</Company>
<ApartmentTags attr0="ApartmentTagsOutputArray" isNull="false" />
<DocumentCopiedPropertyDetails attr0="PropertyDetailsOfCopiedDocumentsArray" isNull="false" />
</ProjectDocumentArray1>
</ProjectDocuments>
</GetDocumentsByProjectOutput>
</MethodParameters>
</GetDocumentsByProject2>
Exceptions
Error Code | Description |
---|---|
110 | Input parameters contain null or invalid data |
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 web method |
227 | The project does not exist or the company is not connected to the given project or your license does not authorize you to access this project |
252 | No input is provided for ProjectId or ProjectCode. Provide the input for at least one of these fields |
253 | Ambiguous inputs. Make sure the ProjectCode and projectId refer to the same project |
254 | Invalid ProjectCode |
...