IsAvailable
- Yasith Perera (Unlicensed)
- Sandrina Abeywardene (Unlicensed)
- Shamal Perera (Unlicensed)
Owned by Yasith Perera (Unlicensed)
Description
This method is used to check whether the service is up and running.
Request
| Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
|---|---|---|---|---|
| applicationName | string | Mandatory | 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 |
Response - sample output
<IsAvailable>
<MethodParameters>
<Boolean>True</Boolean>
</MethodParameters>
</IsAvailable>
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 |