AuthenticateService
Click here for a complete list of operations.
ClientAuthWithResult
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /ciqdotnet/authenticator.asmx HTTP/1.1
Host: api.capitaliq.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.capitaliq.com/CIQDotNet/Authenticator/ClientAuthWithResult"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ClientAuthWithResult xmlns="https://www.capitaliq.com/CIQDotNet/Authenticator">
<username>string</username>
<password>string</password>
<macAddress>string</macAddress>
<processName>string</processName>
</ClientAuthWithResult>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ClientAuthWithResultResponse xmlns="https://www.capitaliq.com/CIQDotNet/Authenticator">
<ClientAuthWithResultResult>
<ErrorCode>InvalidUsername or InvalidPassword or IncorrectIP or MultipleIP or LockedAccount or LogOut or TimedOut or UnknownError or LoginTokenTimedOut or PortalOnlyAccess or DealtrackOnlyAccess or AccountExpired or None or AccountSuspended or MissingCapability or BumpedForSML or MissingGoogleReCaptchaConfirmation or PerformanceTestingBlockage or ValidIDMButInvalidCIQUser or PortalLogOut or UsernameFieldEmpty or PasswordFieldEmpty or UsernameAndPasswordFieldEmpty or LoginRequestIsNull or LoginTypeNotDefined or LoginTypeNotHandled or NoMatchForDefinedProduct or NoMatchForDefinedUserAgentId or LoginInfoIsNull or RestrictedUserSession or RedirectToMI or IPLoginFail or OktaInvalidInteractionCode or OktaInvalidToken or OktaMissingCIQAttributes or OktaCIQAuthenticationFailed or SAMLGenericError</ErrorCode>
<Message>string</Message>
</ClientAuthWithResultResult>
</ClientAuthWithResultResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /ciqdotnet/authenticator.asmx HTTP/1.1
Host: api.capitaliq.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<ClientAuthWithResult xmlns="https://www.capitaliq.com/CIQDotNet/Authenticator">
<username>string</username>
<password>string</password>
<macAddress>string</macAddress>
<processName>string</processName>
</ClientAuthWithResult>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<ClientAuthWithResultResponse xmlns="https://www.capitaliq.com/CIQDotNet/Authenticator">
<ClientAuthWithResultResult>
<ErrorCode>InvalidUsername or InvalidPassword or IncorrectIP or MultipleIP or LockedAccount or LogOut or TimedOut or UnknownError or LoginTokenTimedOut or PortalOnlyAccess or DealtrackOnlyAccess or AccountExpired or None or AccountSuspended or MissingCapability or BumpedForSML or MissingGoogleReCaptchaConfirmation or PerformanceTestingBlockage or ValidIDMButInvalidCIQUser or PortalLogOut or UsernameFieldEmpty or PasswordFieldEmpty or UsernameAndPasswordFieldEmpty or LoginRequestIsNull or LoginTypeNotDefined or LoginTypeNotHandled or NoMatchForDefinedProduct or NoMatchForDefinedUserAgentId or LoginInfoIsNull or RestrictedUserSession or RedirectToMI or IPLoginFail or OktaInvalidInteractionCode or OktaInvalidToken or OktaMissingCIQAttributes or OktaCIQAuthenticationFailed or SAMLGenericError</ErrorCode>
<Message>string</Message>
</ClientAuthWithResultResult>
</ClientAuthWithResultResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /ciqdotnet/authenticator.asmx/ClientAuthWithResult?username=string&password=string&macAddress=string&processName=string HTTP/1.1 Host: api.capitaliq.com
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <LoginResult xmlns="https://www.capitaliq.com/CIQDotNet/Authenticator"> <ErrorCode>InvalidUsername or InvalidPassword or IncorrectIP or MultipleIP or LockedAccount or LogOut or TimedOut or UnknownError or LoginTokenTimedOut or PortalOnlyAccess or DealtrackOnlyAccess or AccountExpired or None or AccountSuspended or MissingCapability or BumpedForSML or MissingGoogleReCaptchaConfirmation or PerformanceTestingBlockage or ValidIDMButInvalidCIQUser or PortalLogOut or UsernameFieldEmpty or PasswordFieldEmpty or UsernameAndPasswordFieldEmpty or LoginRequestIsNull or LoginTypeNotDefined or LoginTypeNotHandled or NoMatchForDefinedProduct or NoMatchForDefinedUserAgentId or LoginInfoIsNull or RestrictedUserSession or RedirectToMI or IPLoginFail or OktaInvalidInteractionCode or OktaInvalidToken or OktaMissingCIQAttributes or OktaCIQAuthenticationFailed or SAMLGenericError</ErrorCode> <Message>string</Message> </LoginResult>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /ciqdotnet/authenticator.asmx/ClientAuthWithResult HTTP/1.1 Host: api.capitaliq.com Content-Type: application/x-www-form-urlencoded Content-Length: length username=string&password=string&macAddress=string&processName=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <LoginResult xmlns="https://www.capitaliq.com/CIQDotNet/Authenticator"> <ErrorCode>InvalidUsername or InvalidPassword or IncorrectIP or MultipleIP or LockedAccount or LogOut or TimedOut or UnknownError or LoginTokenTimedOut or PortalOnlyAccess or DealtrackOnlyAccess or AccountExpired or None or AccountSuspended or MissingCapability or BumpedForSML or MissingGoogleReCaptchaConfirmation or PerformanceTestingBlockage or ValidIDMButInvalidCIQUser or PortalLogOut or UsernameFieldEmpty or PasswordFieldEmpty or UsernameAndPasswordFieldEmpty or LoginRequestIsNull or LoginTypeNotDefined or LoginTypeNotHandled or NoMatchForDefinedProduct or NoMatchForDefinedUserAgentId or LoginInfoIsNull or RestrictedUserSession or RedirectToMI or IPLoginFail or OktaInvalidInteractionCode or OktaInvalidToken or OktaMissingCIQAttributes or OktaCIQAuthenticationFailed or SAMLGenericError</ErrorCode> <Message>string</Message> </LoginResult>