Description
...
Description
This method is used to check whether the web service is up and running.
...
| Parameter | Type | Mandatory/OptionalComments | Maximum character length/limit | Description |
|---|---|---|---|---|
| applicationName | string | MandatoryThird 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
<IsAvailable>
<MethodParameters>
<UserAuthentication>
<UserName>username</UserName>
<Password>password</Password>
<AnyAttr attr0="XmlAttributeArray" isNull="false">
<XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
</AnyAttr>
</UserAuthentication>
<applicationName>test</applicationName>
</MethodParameters>
</IsAvailable>
Response
| Type | Description |
|---|---|
| boolean | Value can be true or false |
...
| TRUE or FALSE |
Response - sample output
<IsAvailable>
<MethodParameters>
<Boolean>True</Boolean>
</MethodParameters>
</IsAvailable>
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 |