Web service: GetErrorCodes
This method is used to get all the error codes or a particular error code provided by Boligmappa API.
Request
| Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
|---|---|---|---|---|
|
errorCode |
String |
Optional* |
Not relevant |
The error code for which the details are required |
|
applicationName |
String |
Mandatory |
Should be less than or equal to 10 characters |
The name of the integration partner |
Note:
- If errorCode is provided, error details for that particular code is returned. If it is left blank, all the error codes are returned.
Request - sample input
<GetErrorCodes>
<MethodParameters>
<UserAuthentication>
<UserName>username</UserName>
<Password>password</Password>
<AnyAttr attr0="XmlAttributeArray" isNull="false">
<XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
</AnyAttr>
</UserAuthentication>
<errorCode>167</errorCode>
<applicationName>test</applicationName>
</MethodParameters>
</GetErrorCodes>
Response
| Type | Description |
|---|---|
|
The error code object containing the descriptions |
Response - sample output
<GetErrorCodes>
<MethodParameters>
<BoligmappaErrorCodeArray>
<BoligmappaErrorCodeArray0>
<ErrorCode>167</ErrorCode>
<ErrorCodeEnglishDescription>You are not authorized to use this web method</ErrorCodeEnglishDescription>
<ErrorCodeNorwegianDescription>Du har ikke lov til å bruke denne webmetoden</ErrorCodeNorwegianDescription>
</BoligmappaErrorCodeArray0>
</BoligmappaErrorCodeArray>
</MethodParameters>
</GetErrorCodes>
Exceptions
| Error Code | Description |
|---|---|
|
123 |
An exception occured while processing your request |
|
138 |
applicationName length is exceeded maximum allowed character limit (10) |
|
146 |
The applicationName is not set |
| 167 | You are not authorized to use this method |
|
297 |
Invalid error code provided. Either the string is negative, or not conformed to the integer limits |
|
298 |
This error code does not exist |
Comments
0 comments
Please sign in to leave a comment.