IntegrationCodeCheck()

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will eventually be deactivated. At this time, there is no end-of-lifecycle date.

This API call is an informational Web Service that vendors can use to determine if a user account is associated with an API Only security level and an integration tracking ID. This call will accept a userName parameter and return a IntegrationCodeCheckResponse that will contain the IsApiUser, IsIntegrationCodeAssociated, ReturnCode, and Errors fields.

Data	Description
userName	This is the username that is being checked. The API will look up the resource associated with the username and return boolean fields indicating whether the user is an API Only user and if they are associated with an integration code.
IsApiUser	True means the username is associated with an API Only security level. False means it is not associated with an API Only security level.
IsIntegrationCodeAssociated	True means that the integration code being passed in the header is associated with the username field. False means that the integration code being passed in the header is not associated with the username field. The username being checked in the call must originate from the same database as the integration code passed in the header. If it does not, you'll receive an 'invalid username' error message.
ReturnCode	1 = success. The ReturnCode will be success if a matching user is found and we are able to successfully determine the IsApiUser and IsIntegrationCodeAssociated values. -1 = failure. Will be returned if there is an error. For example, if the username does not map to an existing resource, then we will return a failure ReturnCode.
Errors	The Errors field will return any applicable error messages, if any. Example: an "Invalid username" message.

Sample IntegrationCodeCheck() SOAP XML

            <?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <AutotaskIntegrations xmlns="http://autotask.net/ATWS/v1_6/">
      <PartnerID>
      </PartnerID>
      <IntegrationCode>GPJVVITJA2TFKYRURRZQ7GVWUOA</IntegrationCode>
    </AutotaskIntegrations>
  </soap:Header>
  <soap:Body>
    <IntegrationCodeCheck xmlns="http://autotask.net/ATWS/v1_6/">
      <userName>UMBAPI1@qastaging.com</userName>
    </IntegrationCodeCheck>
  </soap:Body>
</soap:Envelope>
        

Sample IntegrationCodeCheckResponse

            <?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <IntegrationCodeCheckResponse xmlns="http://autotask.net/ATWS/v1_6/">
      <IntegrationCodeCheckResult>
        <IsApiUser>true</IsApiUser>
        <IsIntegrationCodeAssociated>true</IsIntegrationCodeAssociated>
        <ReturnCode>1</ReturnCode>
        <Errors />
      </IntegrationCodeCheckResult>
    </IntegrationCodeCheckResponse>
  </soap:Body>
</soap:Envelope>