IsAvailable

Description

This method is used to check whether the service is up and running.

Request

ParameterTypeMandatory/OptionalMaximum character length/limitDescription
applicationNamestringMandatoryShould 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

TypeDescription
booleanValue can be TRUE or FALSE


Response - sample output

<IsAvailable>
  <MethodParameters>
    <Boolean>True</Boolean>
  </MethodParameters>
</IsAvailable>

Exceptions

Error CodeDescription
123An exception occurred while processing your request
138applicationName length has exceeded the maximum character limit allowed (10) 
146The applicationName is not set
167You are not authorized to use this method