Status code type (0 on normal call processing or non zero number in case of problem), pattern: "0|\d+" Flag code type (1 on true or set, 0 on false or unset), pattern: "1|0" Caller or campaign (application) predefined ID string, pattern: "[a-zA-Z0-9]" User range type, pattern: "partners|consumers" User Group type (0: not activated/verified, 1000: consumers, > 2000+: partners, 5000+: internal users) Values according to ditionary availabe by authAvailableUserGroupsGet() method Login type, pattern: "a-zA-Z0-9 \-\._]{4,}" Email address type (eg. user@server.pl ), pattern: ".+@.+[.][a-zA-Z]{2,4}" Cellphone number type (eg. +48123456789 ), pattern: "\+\d{2}[ \-0-9]{9,10}" Sex code type, pattern: "F|M" Birth date type (eg. 2000-11-28), pattern: "\d{4}-\d{2}-\d{2}" Polish post code type (eg. 12-250), used in partners range only, pattern: "\d{2}-\d{3}" Country code type (PL, UK, etc.), pattern: "[A-Z]{2}" Values according to ditionary availabe by authAvailableCountriesGet() method Language code type (pl, en), pattern: "[a-z]{2}" Values according to ditionary availabe by authAvailableLanguagesGet() method Pesel number type, pattern: "\d{11}" NIP number type, pattern: "[\d\-]{10,13}" Partner shop range type, pattern: "independent|network" Partner restricted data field mode type, pattern: "verification|read-only|hidden" User short data structure type, see components type definition Rendered only in parners range Rendered only in parners range Rendered only in parners range, set if user has verified and accepted application for the current promotional campaign Rendered only in partners range, set if user may simply conform the participation in the current promotional campaign, based on the previous one Rendered only in partners/staff range, set if staff user allows automated Kerberos authentication User login response data structure type, see components type definition - statusMessage: Message to the user, rendered if login was not sucessfull - userData: User short data on success User activity response data structure type, see components type definition - statusMessage: Rendered in case of problem User password reset procedure response data structure type, see components type definition - statusMessage: Message to the user Partner full data structure type, see components type definition Rendered only in parners/staff range, staff user login in AMICA domain, if different from userLogin Technical, never shown to users Polish IRS ID, according to dictionary available by authAvailableIRSGet() method Name of the IRS, for presentation purposes only, ignored in update mode Technical, never shown to partners Technical, never shown to partners Values according to dictionary available by authAvailableInfoChannelsGet() method Name and address of users company (shop), used by Amica staff for the verification purposes Position ID, according to dictionary available by authPredefinedPositionsGet() method Name of the position, for presentation purposes only, ignored in update mode Type of company (shop) is used by Amica staff for the verification purposes Essential in case of network company (shop), used by Amica staff for the verification purposes Rendered only in partners/staff range, set if staff user allows automated Kerberos authentication Partner data response data structure type, see components type definition - statusMessage: Rendered if data retrieval was not sucessfull - userData: Partner full data on success Partner restricted data structure type, see components type definition Partner restricted data list, see structure type definition Partner restricted data response data structure type, see components type definition - statusMessage: Rendered if data retrieval was not sucessfull - restrictedDataList: Restricted field name list on success Sales Representative data structure type, see components type definition Technical Partners shop data structure type, see components type definition Set if retured data are verified by Amica staff, otherwise data were declared by user only Technical Technical Technical Rendered if shopVerified is set Partners shop data response structure type, see components type definition - statusMessage: Rendered if data retrieval was not sucessfull - shopData: Partner shop data on success Partner data update begin response structure type, see components type definition - statusMessage: Message to the user Partner data update complete response data structure type, see components type definition - statusMessage: Message to the user - userData: User short data on success Partner registration begin request data structure type, see components type definition - campaignID: Usually results from the token. If set, simultaneous account/campaign registartion procedure is initiated, account only otherwise. - campaignRulesConfirmationFlag: Required if campaignID is set either directly or through token - userData: full primary data set is required Partner registration begin response data structure type, see components type definition - statusMessage: Message to the user Partner registration complete response data structure type, see components type definition - statusMessage: Message to the user - userData: User short data on success Partner activation begin response data structure type, see components type definition - statusMessage: Message to the user Partner activation complete response data structure type, see components type definition - statusMessage: Message to the user - userData: User short data on success Staff Kerberos Authentication data structure type, see components type definition - statusMessage: Message in case of error - oneCode: One time auth cycle identifier Staff Kerberos Authentication Client initialize response data structure type, see components type definition - statusMessage: Message in case of error - oneCode: One time auth cycle identifier Staff Kerberos Authentication Client set response data structure type, see components type definition - statusMessage: Message in case of error Staff Kerberos Authentication Client check data structure type, see components type definition - userData: User short data on success - loginTarget: URL to redirect in case of success Staff Kerberos Authentication Client check response data structure type, see components type definition - statusMessage: Message in case of error - userData: User short data on success - loginTarget: URL to redirect in case of success User groups data structure type, see components type definition User groups data list, see structure type definition Language data structure type, see components type definition Lang data list, see structure type definition Info Channel data structure type, see components type definition Info Channel data list, see structure type definition Info Channel status structure type, see components type definition Values according to ditionary availabe by authAvailableInfoChannelsGet() method Info Channel status list, see structure type definition Country data structure type, see components type definition Country data list, see structure type definition Metro size data structure type, see components type definition Values according to ditionary availabe by authPredefinedMetroSizesGet() method metro size data list, see structure type definition Education level data structure type, see components type definition Values according to ditionary availabe by authPredefinedEducationLevelsGet() method Education level data list, see structure type definition Polish IRS data structure type, see components type definition Values according to ditionary availabe by authAvailableIRSGet() method IRS data list, see structure type definition Positions data structure type, see components type definition Values according to ditionary availabe by authPredefinedPositionsGet() method Positions data list, see structure type definition Campaign repository data structure type, see components type definition Text campaign identifier, must be given to gain access to campaigns data Access control list of user groups Campaign repository data list, see structure type definition Available repository campaigns response data structure type, see components type definition - statusMessage: Rendered if operation was not sucessfull - campaignData: Campaign data on success Activity types data structure type, see components type definition Activity types data list, see structure type definition Predefined activity types response data structure type, see components type definition - statusMessage: Rendered if operation was not sucessfull - actTypeData: Activity type data on success Activity data structure type, see components type definition If set, activity scores are counted in campaign ranking Method of scoring, values according to dictionary available by repoPredefinedActivityTypesGet() method Activities data list, see structure type definition Available activities response data structure type, see components type definition - statusMessage: Rendered if operation was not sucessfull - actTypeData: Activities data on success User score in activity data structure type, see components type definition User score in activities data list, see structure type definition User score in campaign data structure type, see components type definition User score in campaigns data list, see structure type definition User score data structure type, see components type definition Date and time score calculation Users position in ranking in current campaign Users total score in current campaign Detailed scores in campaings and activities User score data structure type, see components type definition - statusMessage: Rendered if operation was not sucessfull - userScoreData: Score data on success User score data structure type, see components type definition - statusMessage: Rendered if operation was not sucessfull - userScoreData: Score data on success User ranking score data structure type, see components type definition Position of user indicated by the userID Total score od user indicated by userID User ranking scores data list, see structure type definition User ranking data structure type, see components type definition Rendered only if this optional parameter is used Rendered only if this optional parameter is used User ranking response data structure type, see components type definition - statusMessage: Rendered if operation was not sucessfull - rankingDataList: Ranking data list on success Available promo campaigns response data structure type, see components type definition - statusMessage: Rendered if operation was not sucessfull - campaignData: Campaign data on success Promo campaign accession begin request data structure type, see components type definition - campaignID: Usually results from the token - campaignRulesConfirmationFlag: Required if campaignID is set either directly or through token - userData: only userID is required, others in case of change Promo campaign accession begin response data structure type, see components type definition - statusMessage: Message to the user Promo campaign accession complete response data structure type, see components type definition - statusMessage: Message to the user - userData: User short data on success Promo campaign access conformation begin request data structure type, see components type definition - campaignID: Usually results from the token - campaignRulesConfirmationFlag: Required if campaignID is set either directly or through token - userData: only userID is required, others in case of change Promo campaign access conformation begin response data structure type, see components type definition - statusMessage: Message to the user Promo campaign access conformation complete response data structure type, see components type definition - statusMessage: Message to the user - userData: User short data on success Sale in campaign primary activity data structure type, see components type definition Date of sales report uploaded Named sales period, eg. 'November 2012' Total score counted fo sales included in report uploaded Status of uploade sales report, eg. opened, to be completed, accounted (billed) Optional message from staff to user, eg. what has to be compelted Sales in campaign primary activity data list, see structure type definition Sales history in campaign primary activity response data structure type, see components type definition - statusMessage: Rendered if operation was not sucessfull - salesDataList: Sales history data list on success Optional demand for HTTP 200 SOAPFault response Test method response data structure, see type definition User range (consumers, partners), see type definition User login as string User password as string Caller or campaign (application) ID string, required if userRange is 'partners' Optional language code, used in messages returned by the system Optional demand for HTTP 200 SOAPFault response Login response data structure, including user short data, see type definition User range (consumers, partners), see type definition User login, optional but one of user field is required User e-mail adress; If set, will be used to send new password User cell phone number; If set, will be used to send new password; Ignored in consumers range Caller or campaign (application) ID string, required if userRange is 'partners' Optional language code, used in messages returned by the system Optional demand for HTTP 200 SOAPFault response User reset password procedure response data structure, see type definition Caller or campaign (application) ID string User ID Optional language code, used in messages returned by the system Optional demand for HTTP 200 SOAPFault response Login response data structure, including user short data, see type definition Caller or campaign (application) ID string User ID Optional demand for HTTP 200 SOAPFault response Login response data structure, see type definition Caller or campaign (application) ID string User ID Optional language code, used in messages returned by the system Optional demand for HTTP 200 SOAPFault response Partner data response data structure, see type definition Caller or campaign (application) ID string If set to 1, data according to registration mode will be returned, update mode otherwise Optional language code, used in messages returned by the system Optional demand for HTTP 200 SOAPFault response Partner restricted data response data structure, see type definition Caller or campaign (application) ID string User ID Optional language code, used in messages returned by the system Optional demand for HTTP 200 SOAPFault response Partner shop data response data structure, see type definition Caller or campaign (application) ID string User data structure Optional language code, used in messages returned by the system Optional demand for HTTP 200 SOAPFault response Update partner data begin response structure, see type definition Caller or campaign (application) ID string User login Confirmation code Optional language code, used in messages returned by the system Optional demand for HTTP 200 SOAPFault response Update partner data complete response structure, including user short data, see type definition Caller ID string User data structure Optional language code, used in messages returned by the system Optional demand for HTTP 200 SOAPFault response Update staff user data response structure, see type definition Caller or campaign (application) ID string Registration data structure, see type definition Optional language code, used in messages returned by the system Optional demand for HTTP 200 SOAPFault response Partner registration begin response structure, see type definition Caller or campaign (application) ID string Confirmation code Optional language code, used in messages returned by the system Optional demand for HTTP 200 SOAPFault response Partner registration complete response structure, including user short data, see type definition Caller ID string User data structure Optional language code, used in messages returned by the system Optional demand for HTTP 200 SOAPFault response Staff user registration response structure, see type definition Caller or campaign (application) ID string User pesel User login to set User password to set Optional language code, used in messages returned by the system Optional demand for HTTP 200 SOAPFault response Partner activation begin response structure, see type definition Caller or campaign (application) ID string Confirmation code Optional language code, used in messages returned by the system Optional demand for HTTP 200 SOAPFault response Partner activation complete response structure, including user short data, see type definition Caller ID string Optional URL to redirect after succesful login Optional language code, used in messages returned by the system Optional demand for HTTP 200 SOAPFault response Staff Kerberos Authentication Client check response data structure, see type definition Caller ID string One time auth cycle identifier Authenticated Amica login of staff user Optional language code, used in messages returned by the system Optional demand for HTTP 200 SOAPFault response Staff Kerberos Authentication Client set response data structure, see type definition Caller ID string One time auth cycle identifier Optional language code, used in messages returned by the system Optional demand for HTTP 200 SOAPFault response Staff Kerberos Authentication Client check response data structure, see type definition Caller or campaign (application) ID string Optional demand for HTTP 200 SOAPFault response Array of user groups data, see type definition User range (consumers, partners), see type definition Optional demand for HTTP 200 SOAPFault response Array of lang data, see type definition Optional language code, used in messages returned by the system Optional demand for HTTP 200 SOAPFault response Array of info channel data, see type definition Optional demand for HTTP 200 SOAPFault response Array of country data, see type definition Optional demand for HTTP 200 SOAPFault response Array of metro size data, see type definition Optional demand for HTTP 200 SOAPFault response Array of education level data, see type definition Caller or campaign (application) ID string Optional demand for HTTP 200 SOAPFault response Array of polish IRS data, see type definition Caller or campaign (application) ID string Optional demand for HTTP 200 SOAPFault response Array of positions data, see type definition Optional user range (defaults to partners), see type definition Caller ID string, campaign ID is accepted as well, but only one, indicated campaign will be returned Optional demand for HTTP 200 SOAPFault response Array of repository campaign data, see type definition Optional user range (defaults to partners), see type definition Caller ID string, campaign ID is accepsted as well Optional demand for HTTP 200 SOAPFault response Array of activity types data, see type definition Optional user range (defaults to partners), see type definition Caller ID string, campaign ID is accepsted as well, but only the activities assigned to indicated campaign will be returned Optional campaign ID, if set activitities will be filtered by campaign Optional activity ID, if set only inidated activity will be returned Optional demand for HTTP 200 SOAPFault response Array of activities data, see type definition Optional user range (defaults to partners), see type definition Campaign (application) ID string User ID Optional campaign ID, if set scores will be filtered by campaign Optional activity ID, if set only score of inidated activity will be returned Optional demand for HTTP 200 SOAPFault response Array of user score data, see type definition Optional user range (defaults to partners), see type definition Campaign (application) ID string Activity ID, can be obtained from repoAvailableActivitiesGet method Optionas activity group ID, can be set to group several score records in the activity, for better readability in ranking User ID, returned by user login procedure (authUserLoginDo, authPartnerCBULoginDo) Value in points to be stored Optional date and time of triggering action Optional ID assigned to triggering action Optional demand for HTTP 200 SOAPFault response User score store response, see type definition Optional user range (defaults to partners), see type definition Caller or campaign (application) ID string Campaign ID, required only if caller token was given Optional start of the period for which the ranking is to be calculated, default is the begining of given campain Optional end of the period for which the ranking is to be calculated, default is present day Optional demand for HTTP 200 SOAPFault response Array of user ranking data, see type definition Optional user range (defaults to partners), see type definition Caller ID string, campaign ID is accepsted as well, but only one, indicated campaign will be returned Optional demand for HTTP 200 SOAPFault response Array of promo campaign data, see type definition User range (consumers, partners), see type definition Caller or campaign (application) ID string Accesssion data structure, see type definition Optional demand for HTTP 200 SOAPFault response Promo campaign accession begin response structure, see type definition User range (consumers, partners), see type definition Caller or campaign (application) ID string User login Confirmation code Optional demand for HTTP 200 SOAPFault response Promo campaign accession complete response structure, including user short data, see type definition User range (consumers, partners), see type definition Caller or campaign (application) ID string Conformation data structure, see type definition Optional demand for HTTP 200 SOAPFault response Promo campaign access conformation begin response structure, see type definition User range (consumers, partners), see type definition Caller or campaign (application) ID string User login Confirmation code Optional demand for HTTP 200 SOAPFault response Promo campaign access conformation complete response structure, including user short data, see type definition Optional user range (defaults to partners), see type definition Caller or campaign (application) ID string User ID Campaign ID, required only id caller token was given Optional demand for HTTP 200 SOAPFault response Array of sales history data, see type definition Test method, return always OK @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->testGet(); echo $response->testValue; Logins a user and returns status and short user data on success or status message otherwise <ul> <li>For partners, returns additional information: <ul> <li>Status code is set to -1 if user account is waiting for verification, status message is sent as well</li> <li>Field userPhone is rendered if user has sms channels checked in his/her profile</li> <li>Field userVerified is set to 1 if user has valid application to the campaign, which is indicated by the token (current)</li> <li>Field userVerified is set to -1 if user has applicated to the current capaign, but the application is waiting for verification</li> <li>Field userVerified is set to 0 if user has to applicate to the current campaign</li> <li>Field userConformation is set to 1 if user is privileged to conform only the participation in current campaign</li> </ul> </li> </ul> @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->authUserLoginDo('consumers', 'user', 'amica44'); $response = $client->authUserLoginDo('partners', 'reseller', 'amica44', '[token]'); $response = $client->authUserLoginDo('partners', 'reseller', 'amica44', '[token]', 'en'); echo $response->loginStatus; echo $response->userData->userLastName; Resets user's password, sends it via email and returns status of the operation and appropriate status message <ul> <li>Password is really reset only if message was succesfully sent.</li> <li>Message is send to contact assigned with one of theree user fields is required: login, e-mail address, cell phone numer</li> <li>Cell phone number is ignored in consumer range</li> </ul> @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->authUserPasswordResetDo('consumers', 'user'); $response = $client->authUserPasswordResetDo('partners', null, null, [+48..cellNumber], [token]); $response = $client->authUserPasswordResetDo('partners', null, null, [+48..cellNumber], [token], 'en'); echo $response->resetStatus; echo $response->statusMessage; Logins partner with userID only (if central activity record was found) and returns status and short user data on success or status message otherwise <ul> <li>If status code is set to -1, central actovity record was not found and user should perform standard login</li> </ul> @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->authPartnerCBULoginDo('[token]', 40); $response = $client->authPartnerCBULoginDo('[token]', 40, 'en'); echo $response->loginStatus; echo $response->userData->userLastName; Refresh central activity record of user indicated by userID, shoud be called periodically by application, the user is active with @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->authPartnerCBUActvityDo('token', 40); echo $response->cbuActivityStatus Returns status of data retrieval and partner full data structure on success or status message otherwise <ul> <li>Element userPasswd is hidden and never returned by the service</li> </ul> @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->authPartnerDataGet('[token]', 40); $response = $client->authPartnerDataGet('[token]', 40, 'en'); echo $response->dataStatus; echo $response->userData->userLastName; echo $response->userData->userInfoChannelsList->infoChannelStatus[0]->infoChannelCode; echo $response->userData->userInfoChannelsList->infoChannelStatus[0]->infoChannelStatus; Returns status of data retrieval and partner restricted data structure on success or status message otherwise <ul> <li>Restricted data are returned as field-name list, and should be used when rendering HTML form to visualize restricted data</li> <li>Restriction may be one of three modes: <ul> <li>verification: if user change the data, the account will go into verification procedure</li> <li>read-only: field should be rendered as read-only, any data changes will be ignored by the API</li> <li>hiden: field should not be rendered at all, the data is technical an may be essential to the application only</li> </ul> </li> <li>The registrationMode flag, causes profiling the list according to registration or update mode</li> </ul> @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->authPartnerDataRestrictedGet('[token]', [registrationMode]); $response = $client->authPartnerDataRestrictedGet('[token]', [registrationMode], 'en'); echo $response->dataStatus; echo $response->restrictedDataList->restrictedData[0]->fieldName; echo $response->restrictedDataList->restrictedData[0]->fieldMode; Returns status of data retrieval and partner shop data structure on success or status message otherwise <ul> <li>Returns shop assigned to user by system operator of shop declared by the user if none is assigned</li> <li>Element shopVerified idicates if shop is assigned by operator (1) or declared by user (0)</li> </ul> @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->authPartnerShopGet('[token]', 46); $response = $client->authPartnerShopGet('[token]', 46, 'en'); echo $response->dataStatus; echo $response->shopData->shopName; echo $response->shopData->shopVerified; Begins partner data update pocedure, sends confirmation code to the user and returns status on success or status message otherwise <ul> <li>Confirmation code is send by the e-mail or sms, based on users settings in user profile. E-mail is preffered.</li> </ul> @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $userData = array('userID' => 40, 'userLastName' => 'Nowe'); // Only fields intended to change should be set, but userID is required $response = $client->authPartnerDataUpdateBegin('[token]', $userData); $response = $client->authPartnerDataUpdateBegin('[token]', $userData, 'en'); echo $response->updateStatus echo $response->statusMessage Completes partner data update procedure and returns status and short user data on success or status message otherwise @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->authPartnerDataUpdateComplete('[token]', 'reseller', '[code]'); $response = $client->authPartnerDataUpdateComplete('[token]', 'reseller', '[code]', 'en'); echo $response->updateStatus; echo $response->ustatusMessage; echo $response->userData->userLastName; Staff user data update pocedure, returns status on success or status message otherwise @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $userData = array('userID' => 36, 'userLastName' => 'Nowy'); // Only fields intended to change should be set, but userID is required $response = $client->authStaffDataUpdate('[token]', $userData); $response = $client->authStaffDataUpdate('[token]', $userData, 'en'); echo $response->updateStatus echo $response->statusMessage Begins partner registration procedure, sends confirmation code to the user and returns status on success or status message otherwise <ul> <li>Confirmation code is send by the e-mail or sms, based on users settings in user profile. E-mail is preffered.</li> </ul> @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); // Array $userData has to contain all the data required in registaration mode $userData = array('userLogin'=>'somelogin', 'userLastName'=>'somename', 'userEmail'=>'acount@server.pl', 'userInfoChannelList'=>$channelList); $registrationData = array('campaignRulesConformationFlag'=>1, $userData); $response = $client->authPartnerRegistrationBegin('[token]', $registrationData); $response = $client->authPartnerRegistrationBegin('[token]', $registrationData, 'en'); echo $response->registrationStatus; echo $response->statusMessage; Completes partner registration procedure and returns status and short user data on success or status message otherwise @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->authPartnerRegistrationComplete('[token]', '[code]'); $response = $client->authPartnerRegistrationComplete('[token]', '[code]', 'en'); echo $response->registrationStatus; echo $response->ustatusMessage; echo $response->userData->userLastName; Staff user registration procedure, returns status on success or status message otherwise @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); // Array $userData has to contain all the data required in registaration mode $userData = array('userLogin'=>'somelogin', 'userLastName'=>'somename', 'userEmail'=>'acount@amica.com.pl', 'userInfoChannelList'=>$channelList); $response = $client->authStaffRegistration('[token]', $userData); $response = $client->authStaffRegistration('[token]', $userData, 'en'); echo $response->registrationStatus; echo $response->statusMessage; Begins partner account activation procedure, sends confirmation code to the user and returns status on success or status message otherwise <ul> <li>Confirmation code is send by the e-mail or sms, based on users settings in user profile. E-mail is preffered.</li> </ul> @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); // Array $userData has to contain all the data required in registaration mode $activationData = array('userPesel'=>'somepesel', 'userLogin'=>'somelogin', 'userPasswd'=>'somepassword'); $response = $client->authPartnerActivationBegin('[token]', $activationData); $response = $client->authPartnerActivationBegin('[token]', $activationData, 'en'); echo $response->activationStatus; echo $response->statusMessage; Completes partner account activation procedure and returns status and short user data on success or status message otherwise @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->authPartnerActivationComplete('[token]', '[code]'); $response = $client->authPartnerActivationComplete('[token]', '[code]', 'en'); echo $response->activationStatus; echo $response->ustatusMessage; echo $response->userData->userLastName; Initializes staff Kerberos authentication procedure, returns one time auth cycle identifier on success or status message otherwise @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->authKrbClientInit('[token]', '[loginTarget]'); $response = $client->authKrbClientInit('[token]', '[loginTarget]', 'en'); echo $response->initStatus; echo $response->oneCode; Set staff Kerberos authentication info, returns status on success or status message otherwise @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->authKrbClientSet('[token]', '[oneCode]', '[loginValue]'); $response = $client->authKrbClientSet('[token]', '[oneCode]', '[loginValue]', 'en'); echo $response->setStatus; echo $response->statusMessage; Completes staff Kerberos authentication procedure, returns status and short user data (as authUserLoginDo) plus loginTarget on success or status message otherwise @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->authKrbClientCheck('[token]', '[oneCode]'); $response = $client->authKrbClientCheck('[token]', '[oneCode]', 'en'); echo $response->checkStatus; echo $response->userData->userLastName; echo $response->loginTarget; Returns array of user groups as code - name pairs available for application indicated by token. @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->authAvailableUserGroupsGet('[token]'); echo $response->dataStatus; echo $response->uGroupDataList->uGroupData[0]->uGroupCode; echo $response->uGroupDataList->uGroupData[0]->uGroupName; Returns array of languages data as code - name pairs available for users. @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->authAvailableLanguagesGet(); echo $response->dataStatus; echo $response->langDataList->langData[0]->langCode; echo $response->langDataList->langData[0]->langName; Returns array of info channels data as code - name pairs available for users. @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->authAvailableInfoChannelsGet(); $response = $client->authAvailableInfoChannelsGet('en'); echo $response->dataStatus;; echo $response->infoChannelDataList->infoChannelData[0]->infoChannelCode;; echo $response->infoChannelDataList->infoChannelData[0]->infoChannelName; Info channel is a way, the user wants to communicate Returns array of country data as code - name pairs. @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->authAvailableCountriesGet(); echo $response->dataStatus; echo $response->countryDataList->countryData[0]->countryCode; echo $response->countryDataList->countryData[0]->countryName; Returns array of predefined metro size data as code - name pairs. @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $listOfMetroSizeData = $client->authPredefinedMetroSizesGet(); $listOfMetroSizeData = $client->authPredefinedMetroSizesGet('en'); echo $response->dataStatus; echo $response->metroSizeDataList->metroSizeData[0]->metroSizeCode; echo $response->metroSizeDataList->metroSizeData[0]->metroSizeName; Metro size is list o predefined urban ares sizes, to be used during users registration or profile update Returns array of predefined education level data as code - name pairs. @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->authPredefinedEducationLevelsGet(); $response = $client->authPredefinedEducationLevelsGet('en'); echo $response->dataStatus; echo $response->eduLevelDataList->eduLevelData[0]->eduLevelCode; echo $response->eduLevelDataList->eduLevelData[0]->eduLevelName; Returns array of available polish IRS data as ID - name pairs (Urzędy Skarbowe). @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->authAvailableIRSGet(); echo $response->dataStatus; echo $response->irsDataList->irsData[0]->irsID; echo $response->irsDataList->irsData[0]->irsName; Returns array of predefined positions data as ID - name pairs. @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->authPredefinedPositionsGet(); echo $response->dataStatus; echo $response->posDataList->posData[0]->posID; echo $response->posDataList->posData[0]->posName; Returns array of campaigns data, available to given token. @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->repoAvailableCampaignsGet('[token]'); echo $response->dataStatus; echo $response->campaignDataList->campaignData->campaignID; // campaignData[n] in case of multiple result echo $response->campaignDataList->campaignData->campaignName; Returns array of activity types data, available to given token. @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->repoPredefinedActivityTypesGet('[token]'); echo $response->dataStatus; echo $response->actTypeDataList->actTypeData[0]->actTypeID; echo $response->actTypeDataList->actTypeData[0]->actTypeName; Returns array of activities data, available to given token. @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->repoAvailableActivitiesGet('token'); echo $response->dataStatus; echo $response->activityDataList->activityData->activityID; // ...Data[n] in case of multiple result echo $response->activityDataList->activityData->activityName; Returns user score data in campaigns, available to given token. @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->repoUserScoreGet('[token]'); echo $response->dataStatus; echo $response->userScoreData->userID; echo $response->userScoreData->userScoreTotal; echo $response->userScoreData->userScoreCampaignDataList->userScoreCampaignData->campaignName; // ...Data[n] in case of multiple result echo $response->userScoreData->userScoreCampaignDataList->userScoreCampaignData->campaignScore; echo $response->userScoreData->userScoreCampaignDataList->userScoreCampaignData->userScoreActivityDataList->userScoreActivityData[0]->activityName; echo $response->userScoreData->userScoreCampaignDataList->userScoreCampaignData->userScoreActivityDataList->userScoreActivityData[0]->activityScoreValue; Stores user score in repository, if activity is available to given token. @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->repoUserScoreStore('[token]', [activityID], [groupID], [userID], [scoreValue], '[localDate]', [localID]); echo $response->StoreStatus; Returns ranking data in campaign indicated by given token or ID. @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->repoUserRankingGet('token'); echo $response->dataStatus; echo $response->rankingDate; echo $response->rankingCampaignName; echo $response->rankingDateFrom; echo $response->rankingDateTo; echo $response->rankingDataList->rankingData[0]->rankingNo; echo $response->rankingDataList->rankingData[0]->rankingUserID; echo $response->rankingDataList->rankingData[0]->rankingUserScore; Returns array of promo campaigns data, available to given token. @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->promoAvailableCampaignsGet('token'); echo $response->dataStatus; echo $response->campaignDataList->campaignData->campaignID; // ...Data[n] in case of multiple result echo $response->campaignDataList->campaignData->campaignName; Begins promo campaign accession procedure, sends confirmation code to the user and returns status on success or status message otherwise <ul> <li>Confirmation code is send by the e-mail or sms, based on users settings in user profile. E-mail is preffered.</li> </ul> @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); // Array $accessionData has to contain all the data required in registration mode $userData = array('userLogin'=>'somelogin', 'userLastName'=>'somename', 'userEmail'=>'acount@server.pl', 'userInfoChannelList'=>$channelList); $accessionData = array('campaignRulesConfirmationFlag'=>1, $userData); $response = $client->promoAccessionBegin('[token]', $accessionData); echo $response->accessionStatus echo $response->statusMessage Completes promo campaign accession procedure and returns status and short user data on success or status message otherwise @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->promoAccessionComplete('[token]', 'somelogin', '[code]'); echo $response->accessionStatus; echo $response->userData->userLastName; Begins promo campaign access conformation procedure, sends confirmation code to the user and returns status on success or status message otherwise <ul> <li>Confirmation code is send by the e-mail or sms, based on users settings in user profile. E-mail is preffered.</li> </ul> @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); // Array $conformationData has to contain at leat userID field, and optionally another fields intended to change $userData = array('userID'=>40, 'userLastName'=>'NewName'); $conformationData = array('campaignRulesConfirmationFlag'=>1, $conformationData); $response = $client->promoConformationBegin('token', $conformationData); echo $response->conformationStatus echo $response->statusMessage Completes promo campaign access conformation procedure and returns status and short user data on success or status message otherwise @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->promoConformationComplete('[token]', '[login]', '[code]'); echo $response->conformationStatus; echo $response->userData->userLastName; Returns array of sales history data in campaign indicated by given token or ID. @example PHP: $client = new SoapClient("http://soap.amica.com.pl/?q=ws/wsdl", $options); $response = $client->promoSalesHistoryGet('[token]'); echo $response->dataStatus; echo $response->salesDataList->salesData->salePeriod; // ...Data[n] in case of multiple result echo $response->salesDataList->salesData->saleScore; echo $response->salesDataList->salesData->saleStatus; Amica SOAP test service prowides one method to test communication This serwis is developed and managed by ArtCom24, Poland If You have any questions, please contact us at amicadataapi[at]artcom24.eu Amica SOAP Authentication and users data service provides set of methods for serve users login and profile operations as well as data retrival This serwis is developed and managed by ArtCom24, Poland If You have any questions, please contact us at amicadataapi[at]artcom24.eu Amica SOAP Repository Data service provides set of methods, which return all the marketing campaigns data stored in central repository This serwis is developed and managed by ArtCom24, Poland If You have any questions, please contact us at amicadataapi[at]artcom24.eu Amica SOAP Promotions Data service provides set of methods, which return trade marketing campaigns data stored in dedicated data managment system This serwis is developed and managed by ArtCom24, Poland If You have any questions, please contact us at amicadataapi[at]artcom24.eu