Get the document url of a device

Web service: GetDeviceDocumentUrl

This method is used to retrieve the device document Url based on the provided DeviceId.

Request

Parameter	Type	Mandatory/Optional	Maximum character length/limit	Description
deviceItem	DeviceItem	Mandatory	Not Relevant	Model containing the data needed to find the Efo document
applicationName	string	Mandatory	Should be less than or equal to 10 characters	The name of the integration partner

Request - sample input

<GetDeviceDocumentUrl>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <deviceItem>
      <DeviceId>1416000</DeviceId>
      <VendorId isNull="false" />
      <DocumentType>userManual</DocumentType>
      <LibraryType>efo</LibraryType>
    </deviceItem>
    <applicationName>test</applicationName>
  </MethodParameters>
</GetDeviceDocumentUrl>

Response

Type	Description
string	A Url of the requested document

Response - sample output

<GetDeviceDocumentUrl>
  <MethodParameters>
    <String>http://efobasen.efo.no/ProductResources/5/Manual/Hurtigmanual%20%20SE-SGK300%20v.1214.pdf</String>
  </MethodParameters>
</GetDeviceDocumentUrl>

Exceptions

Error Code	Description
123	An exception occurred while processing your request
138	applicationName length has exceeded the maximum character limit allowed (10)
142	One or more of the input EfoIds are invalid
146	The applicationName is not set
167	You are not authorized to use this method
266	The DeviceId is not properly set
267	One or more of the input NRFIds are invalid
268	One or more of the input NOBBIds are invalid
269	The LibraryType is not properly set

Articles in this section