BlackBerryLoginService
Click here for a complete list of operations.
Login
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/Mobile/Services/BlackBerryLoginService.asmx HTTP/1.1 Host: api.capitaliq.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://www.capitaliq.com/CIQDotNet/Mobile/Services/BlackBerryLoginService/Login" <?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> <Login xmlns="https://www.capitaliq.com/CIQDotNet/Mobile/Services/BlackBerryLoginService"> <username>string</username> <password>string</password> <devicePin>string</devicePin> </Login> </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> <LoginResponse xmlns="https://www.capitaliq.com/CIQDotNet/Mobile/Services/BlackBerryLoginService"> <LoginResult> <LoginErrorCode>OK or Unknown or BadUsername or BadPassword or NotAuthorized or SingleMachineLogin or AccountLocked or Logout or NoCapability or AccountExpired or BlackBerryReleaseDisabled or AccountSuspended</LoginErrorCode> <LoginErrorMessage>string</LoginErrorMessage> <EncryptedPassword>base64Binary</EncryptedPassword> <RealTimeInfo> <RealTimeHost>string</RealTimeHost> <RealTimePort>int</RealTimePort> <RealTimeAuthHost>string</RealTimeAuthHost> <RealTimeAuthPort>int</RealTimeAuthPort> <RealTimeProtocol>string</RealTimeProtocol> <RealTimeAuthProtocol>string</RealTimeAuthProtocol> <AuthInfo> <Zid>string</Zid> <Azid>string</Azid> </AuthInfo> <RealTimeLaunchReason>Ok or AntiCap or NoAddress or IncompleteAddress or NeedAgreement or NoCapability or NoMobileRealTimeCapability</RealTimeLaunchReason> <LaunchReasonText>string</LaunchReasonText> </RealTimeInfo> <EntryPointUrl>string</EntryPointUrl> <BaseUrl>string</BaseUrl> <QuotesDataVendorId>int</QuotesDataVendorId> <UserId>long</UserId> <ClientSupportPhone>string</ClientSupportPhone> <MobileSupportEmail>string</MobileSupportEmail> <AdditionalInfo> <MaxNewsHeadlinesCap>int</MaxNewsHeadlinesCap> <MinNewsAutoRefreshTime>int</MinNewsAutoRefreshTime> <EnableIdmsMobileQuotes>boolean</EnableIdmsMobileQuotes> <EnableSecurityProfileForIdms>boolean</EnableSecurityProfileForIdms> <NewsSearchSourceTypes> <SearchSourceType xsi:nil="true" /> <SearchSourceType xsi:nil="true" /> </NewsSearchSourceTypes> <Capabilities> <int>int</int> <int>int</int> </Capabilities> </AdditionalInfo> </LoginResult> </LoginResponse> </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/Mobile/Services/BlackBerryLoginService.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> <Login xmlns="https://www.capitaliq.com/CIQDotNet/Mobile/Services/BlackBerryLoginService"> <username>string</username> <password>string</password> <devicePin>string</devicePin> </Login> </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> <LoginResponse xmlns="https://www.capitaliq.com/CIQDotNet/Mobile/Services/BlackBerryLoginService"> <LoginResult> <LoginErrorCode>OK or Unknown or BadUsername or BadPassword or NotAuthorized or SingleMachineLogin or AccountLocked or Logout or NoCapability or AccountExpired or BlackBerryReleaseDisabled or AccountSuspended</LoginErrorCode> <LoginErrorMessage>string</LoginErrorMessage> <EncryptedPassword>base64Binary</EncryptedPassword> <RealTimeInfo> <RealTimeHost>string</RealTimeHost> <RealTimePort>int</RealTimePort> <RealTimeAuthHost>string</RealTimeAuthHost> <RealTimeAuthPort>int</RealTimeAuthPort> <RealTimeProtocol>string</RealTimeProtocol> <RealTimeAuthProtocol>string</RealTimeAuthProtocol> <AuthInfo> <Zid>string</Zid> <Azid>string</Azid> </AuthInfo> <RealTimeLaunchReason>Ok or AntiCap or NoAddress or IncompleteAddress or NeedAgreement or NoCapability or NoMobileRealTimeCapability</RealTimeLaunchReason> <LaunchReasonText>string</LaunchReasonText> </RealTimeInfo> <EntryPointUrl>string</EntryPointUrl> <BaseUrl>string</BaseUrl> <QuotesDataVendorId>int</QuotesDataVendorId> <UserId>long</UserId> <ClientSupportPhone>string</ClientSupportPhone> <MobileSupportEmail>string</MobileSupportEmail> <AdditionalInfo> <MaxNewsHeadlinesCap>int</MaxNewsHeadlinesCap> <MinNewsAutoRefreshTime>int</MinNewsAutoRefreshTime> <EnableIdmsMobileQuotes>boolean</EnableIdmsMobileQuotes> <EnableSecurityProfileForIdms>boolean</EnableSecurityProfileForIdms> <NewsSearchSourceTypes> <SearchSourceType xsi:nil="true" /> <SearchSourceType xsi:nil="true" /> </NewsSearchSourceTypes> <Capabilities> <int>int</int> <int>int</int> </Capabilities> </AdditionalInfo> </LoginResult> </LoginResponse> </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/Mobile/Services/BlackBerryLoginService.asmx/Login?username=string&password=string&devicePin=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"?> <BlackBerryLoginResponse xmlns="https://www.capitaliq.com/CIQDotNet/Mobile/Services/BlackBerryLoginService"> <LoginErrorCode>OK or Unknown or BadUsername or BadPassword or NotAuthorized or SingleMachineLogin or AccountLocked or Logout or NoCapability or AccountExpired or BlackBerryReleaseDisabled or AccountSuspended</LoginErrorCode> <LoginErrorMessage>string</LoginErrorMessage> <EncryptedPassword>base64Binary</EncryptedPassword> <RealTimeInfo> <RealTimeHost>string</RealTimeHost> <RealTimePort>int</RealTimePort> <RealTimeAuthHost>string</RealTimeAuthHost> <RealTimeAuthPort>int</RealTimeAuthPort> <RealTimeProtocol>string</RealTimeProtocol> <RealTimeAuthProtocol>string</RealTimeAuthProtocol> <AuthInfo> <Zid>string</Zid> <Azid>string</Azid> </AuthInfo> <RealTimeLaunchReason>Ok or AntiCap or NoAddress or IncompleteAddress or NeedAgreement or NoCapability or NoMobileRealTimeCapability</RealTimeLaunchReason> <LaunchReasonText>string</LaunchReasonText> </RealTimeInfo> <EntryPointUrl>string</EntryPointUrl> <BaseUrl>string</BaseUrl> <QuotesDataVendorId>int</QuotesDataVendorId> <UserId>long</UserId> <ClientSupportPhone>string</ClientSupportPhone> <MobileSupportEmail>string</MobileSupportEmail> <AdditionalInfo> <MaxNewsHeadlinesCap>int</MaxNewsHeadlinesCap> <MinNewsAutoRefreshTime>int</MinNewsAutoRefreshTime> <EnableIdmsMobileQuotes>boolean</EnableIdmsMobileQuotes> <EnableSecurityProfileForIdms>boolean</EnableSecurityProfileForIdms> <NewsSearchSourceTypes> <SearchSourceType> <Id>int</Id> <Name>string</Name> <CheckedByDefault>boolean</CheckedByDefault> </SearchSourceType> <SearchSourceType> <Id>int</Id> <Name>string</Name> <CheckedByDefault>boolean</CheckedByDefault> </SearchSourceType> </NewsSearchSourceTypes> <Capabilities> <int>int</int> <int>int</int> </Capabilities> </AdditionalInfo> </BlackBerryLoginResponse>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /CIQDotNet/Mobile/Services/BlackBerryLoginService.asmx/Login HTTP/1.1 Host: api.capitaliq.com Content-Type: application/x-www-form-urlencoded Content-Length: length username=string&password=string&devicePin=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <BlackBerryLoginResponse xmlns="https://www.capitaliq.com/CIQDotNet/Mobile/Services/BlackBerryLoginService"> <LoginErrorCode>OK or Unknown or BadUsername or BadPassword or NotAuthorized or SingleMachineLogin or AccountLocked or Logout or NoCapability or AccountExpired or BlackBerryReleaseDisabled or AccountSuspended</LoginErrorCode> <LoginErrorMessage>string</LoginErrorMessage> <EncryptedPassword>base64Binary</EncryptedPassword> <RealTimeInfo> <RealTimeHost>string</RealTimeHost> <RealTimePort>int</RealTimePort> <RealTimeAuthHost>string</RealTimeAuthHost> <RealTimeAuthPort>int</RealTimeAuthPort> <RealTimeProtocol>string</RealTimeProtocol> <RealTimeAuthProtocol>string</RealTimeAuthProtocol> <AuthInfo> <Zid>string</Zid> <Azid>string</Azid> </AuthInfo> <RealTimeLaunchReason>Ok or AntiCap or NoAddress or IncompleteAddress or NeedAgreement or NoCapability or NoMobileRealTimeCapability</RealTimeLaunchReason> <LaunchReasonText>string</LaunchReasonText> </RealTimeInfo> <EntryPointUrl>string</EntryPointUrl> <BaseUrl>string</BaseUrl> <QuotesDataVendorId>int</QuotesDataVendorId> <UserId>long</UserId> <ClientSupportPhone>string</ClientSupportPhone> <MobileSupportEmail>string</MobileSupportEmail> <AdditionalInfo> <MaxNewsHeadlinesCap>int</MaxNewsHeadlinesCap> <MinNewsAutoRefreshTime>int</MinNewsAutoRefreshTime> <EnableIdmsMobileQuotes>boolean</EnableIdmsMobileQuotes> <EnableSecurityProfileForIdms>boolean</EnableSecurityProfileForIdms> <NewsSearchSourceTypes> <SearchSourceType> <Id>int</Id> <Name>string</Name> <CheckedByDefault>boolean</CheckedByDefault> </SearchSourceType> <SearchSourceType> <Id>int</Id> <Name>string</Name> <CheckedByDefault>boolean</CheckedByDefault> </SearchSourceType> </NewsSearchSourceTypes> <Capabilities> <int>int</int> <int>int</int> </Capabilities> </AdditionalInfo> </BlackBerryLoginResponse>