iPhoneAuthenticate
Click here for a complete list of operations.
verifyIPhoneLogon
Verify logon and count hits
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 /iphoneauthenticate/iphoneauthenticate.asmx HTTP/1.1 Host: qa.blackbookws.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://www.blackbookws.com/iPhoneAuthenticate.asmx/verifyIPhoneLogon" <?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> <verifyIPhoneLogon xmlns="https://www.blackbookws.com/iPhoneAuthenticate.asmx"> <AppleId>string</AppleId> <ProductCode>string</ProductCode> <LogonId>string</LogonId> <Password>string</Password> </verifyIPhoneLogon> </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> <verifyIPhoneLogonResponse xmlns="https://www.blackbookws.com/iPhoneAuthenticate.asmx"> <verifyIPhoneLogonResult> <Return_Code>int</Return_Code> <Company_Name>string</Company_Name> <Full_User_Name>string</Full_User_Name> <Active_Flag>string</Active_Flag> <Days_Remain_Account>int</Days_Remain_Account> <Data_Frequency>string</Data_Frequency> <Last_Update_Date>string</Last_Update_Date> <Current_Pub_Date>string</Current_Pub_Date> <Allow_Update>string</Allow_Update> <Ad_Placement>string</Ad_Placement> <Runlists> <Runlist> <Runlist_Id>int</Runlist_Id> <Runlist_Name>string</Runlist_Name> </Runlist> <Runlist> <Runlist_Id>int</Runlist_Id> <Runlist_Name>string</Runlist_Name> </Runlist> </Runlists> <Product_Name>string</Product_Name> <Show_Photo>string</Show_Photo> <Show_Colors>string</Show_Colors> <Show_Std_Equip>string</Show_Std_Equip> <Product_Version>string</Product_Version> <Download_Filename>string</Download_Filename> <Renewals> <Renewal> <Renewal_code>string</Renewal_code> <Description>string</Description> <Product_price>decimal</Product_price> </Renewal> <Renewal> <Renewal_code>string</Renewal_code> <Description>string</Description> <Product_price>decimal</Product_price> </Renewal> </Renewals> <First_name>string</First_name> <Last_name>string</Last_name> <Email_address>string</Email_address> <Telephone>string</Telephone> <Zip_code>string</Zip_code> <Show_EULA>string</Show_EULA> <Market_exp_date>string</Market_exp_date> <CAC_Flag>string</CAC_Flag> <Template_Code>string</Template_Code> <CAC_Purchase>string</CAC_Purchase> </verifyIPhoneLogonResult> </verifyIPhoneLogonResponse> </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 /iphoneauthenticate/iphoneauthenticate.asmx HTTP/1.1 Host: qa.blackbookws.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> <verifyIPhoneLogon xmlns="https://www.blackbookws.com/iPhoneAuthenticate.asmx"> <AppleId>string</AppleId> <ProductCode>string</ProductCode> <LogonId>string</LogonId> <Password>string</Password> </verifyIPhoneLogon> </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> <verifyIPhoneLogonResponse xmlns="https://www.blackbookws.com/iPhoneAuthenticate.asmx"> <verifyIPhoneLogonResult> <Return_Code>int</Return_Code> <Company_Name>string</Company_Name> <Full_User_Name>string</Full_User_Name> <Active_Flag>string</Active_Flag> <Days_Remain_Account>int</Days_Remain_Account> <Data_Frequency>string</Data_Frequency> <Last_Update_Date>string</Last_Update_Date> <Current_Pub_Date>string</Current_Pub_Date> <Allow_Update>string</Allow_Update> <Ad_Placement>string</Ad_Placement> <Runlists> <Runlist> <Runlist_Id>int</Runlist_Id> <Runlist_Name>string</Runlist_Name> </Runlist> <Runlist> <Runlist_Id>int</Runlist_Id> <Runlist_Name>string</Runlist_Name> </Runlist> </Runlists> <Product_Name>string</Product_Name> <Show_Photo>string</Show_Photo> <Show_Colors>string</Show_Colors> <Show_Std_Equip>string</Show_Std_Equip> <Product_Version>string</Product_Version> <Download_Filename>string</Download_Filename> <Renewals> <Renewal> <Renewal_code>string</Renewal_code> <Description>string</Description> <Product_price>decimal</Product_price> </Renewal> <Renewal> <Renewal_code>string</Renewal_code> <Description>string</Description> <Product_price>decimal</Product_price> </Renewal> </Renewals> <First_name>string</First_name> <Last_name>string</Last_name> <Email_address>string</Email_address> <Telephone>string</Telephone> <Zip_code>string</Zip_code> <Show_EULA>string</Show_EULA> <Market_exp_date>string</Market_exp_date> <CAC_Flag>string</CAC_Flag> <Template_Code>string</Template_Code> <CAC_Purchase>string</CAC_Purchase> </verifyIPhoneLogonResult> </verifyIPhoneLogonResponse> </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 /iphoneauthenticate/iphoneauthenticate.asmx/verifyIPhoneLogon?AppleId=string&ProductCode=string&LogonId=string&Password=string HTTP/1.1 Host: qa.blackbookws.com
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <iPhoneAuthResult xmlns="https://www.blackbookws.com/iPhoneAuthenticate.asmx"> <Return_Code>int</Return_Code> <Company_Name>string</Company_Name> <Full_User_Name>string</Full_User_Name> <Active_Flag>string</Active_Flag> <Days_Remain_Account>int</Days_Remain_Account> <Data_Frequency>string</Data_Frequency> <Last_Update_Date>string</Last_Update_Date> <Current_Pub_Date>string</Current_Pub_Date> <Allow_Update>string</Allow_Update> <Ad_Placement>string</Ad_Placement> <Runlists> <Runlist> <Runlist_Id>int</Runlist_Id> <Runlist_Name>string</Runlist_Name> </Runlist> <Runlist> <Runlist_Id>int</Runlist_Id> <Runlist_Name>string</Runlist_Name> </Runlist> </Runlists> <Product_Name>string</Product_Name> <Show_Photo>string</Show_Photo> <Show_Colors>string</Show_Colors> <Show_Std_Equip>string</Show_Std_Equip> <Product_Version>string</Product_Version> <Download_Filename>string</Download_Filename> <Renewals> <Renewal> <Renewal_code>string</Renewal_code> <Description>string</Description> <Product_price>decimal</Product_price> </Renewal> <Renewal> <Renewal_code>string</Renewal_code> <Description>string</Description> <Product_price>decimal</Product_price> </Renewal> </Renewals> <First_name>string</First_name> <Last_name>string</Last_name> <Email_address>string</Email_address> <Telephone>string</Telephone> <Zip_code>string</Zip_code> <Show_EULA>string</Show_EULA> <Market_exp_date>string</Market_exp_date> <CAC_Flag>string</CAC_Flag> <Template_Code>string</Template_Code> <CAC_Purchase>string</CAC_Purchase> </iPhoneAuthResult>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /iphoneauthenticate/iphoneauthenticate.asmx/verifyIPhoneLogon HTTP/1.1 Host: qa.blackbookws.com Content-Type: application/x-www-form-urlencoded Content-Length: length AppleId=string&ProductCode=string&LogonId=string&Password=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <iPhoneAuthResult xmlns="https://www.blackbookws.com/iPhoneAuthenticate.asmx"> <Return_Code>int</Return_Code> <Company_Name>string</Company_Name> <Full_User_Name>string</Full_User_Name> <Active_Flag>string</Active_Flag> <Days_Remain_Account>int</Days_Remain_Account> <Data_Frequency>string</Data_Frequency> <Last_Update_Date>string</Last_Update_Date> <Current_Pub_Date>string</Current_Pub_Date> <Allow_Update>string</Allow_Update> <Ad_Placement>string</Ad_Placement> <Runlists> <Runlist> <Runlist_Id>int</Runlist_Id> <Runlist_Name>string</Runlist_Name> </Runlist> <Runlist> <Runlist_Id>int</Runlist_Id> <Runlist_Name>string</Runlist_Name> </Runlist> </Runlists> <Product_Name>string</Product_Name> <Show_Photo>string</Show_Photo> <Show_Colors>string</Show_Colors> <Show_Std_Equip>string</Show_Std_Equip> <Product_Version>string</Product_Version> <Download_Filename>string</Download_Filename> <Renewals> <Renewal> <Renewal_code>string</Renewal_code> <Description>string</Description> <Product_price>decimal</Product_price> </Renewal> <Renewal> <Renewal_code>string</Renewal_code> <Description>string</Description> <Product_price>decimal</Product_price> </Renewal> </Renewals> <First_name>string</First_name> <Last_name>string</Last_name> <Email_address>string</Email_address> <Telephone>string</Telephone> <Zip_code>string</Zip_code> <Show_EULA>string</Show_EULA> <Market_exp_date>string</Market_exp_date> <CAC_Flag>string</CAC_Flag> <Template_Code>string</Template_Code> <CAC_Purchase>string</CAC_Purchase> </iPhoneAuthResult>