symantec_package.lib.queryService package¶

Submodules¶

class symantec_package.lib.queryService.SymantecQueryServices.SymantecQueryServices(client)¶

Bases: object

This class acts as a layer of abstraction to handling all query Symantec VIP SOAP calls in Python.

You call this class to handle anything that is related to user info and transaction status

Example:

>>> client = Client("http://../vipuserservices-query-1.7.wsdl", transport = HTTPSClientCertTransport('vip_certificate.crt','vip_certificate.crt'))

>>> service = SymantecQueryServices(client)

>>> response = service.getUserInfo(<parameters here>)

>>> print (response)

Note

Reference HTTPHandler for further information on how to setup the client.

getCredentialInfo(requestId, credentialId, credentialType='STANDARD_OTP', includePushAttributes=None, onBehalfOfAccountId=None)¶

Description:	Get detail info of a registered credential
Note:
Parameters:	requestId (string) – A identifier ID of a call, may be useful for troubleshooting credentialType (string) – Type of this credential includePushAttributes (string) – Include push attributes in response message onBehalfOfAccountId (string) – The parent account that this request is done on behalf of a child account. The parent account uses its own certificate to authenticate the request to VIP User Services.
CredentialId:	A unique identifier for every credential
Returns:	the return SOAP response.

getFieldContent(fieldname)¶

Description:	Get content of items in response message
Note:	Works only for one line item
Parameters:	fieldname (string) – Item name
Returns:	The content of input fieldname

getPreviousResponseFirstPairs()¶

Description:	Gets the 1st level of important main response fields from previous VIP SOAP call and tells what fields are accessible
Note:	This will not work if there was no previous call in the client.
Returns:	list – Containing all the first pair values of each tuple

getPreviousResponseValue(firstPair)¶

Description:	Gets the 1st level of important main response fields from the VIP SOAP call and tells what fields are accessible
Note:	This will not work if there was no previous call in the client.
Parameters:	firstPair (string) – The first pair in the tuple field
Returns:	The field value at the pair key

getResponseFirstPairs(response)¶

Description:	Gets the 1st level of important main response fields from the VIP SOAP call and tells what fields are accessible
Note:	This requires the SOAP response as a parameter.
Parameters:	response (list of tuples) – The SOAP response
Returns:	list – Containing all the first pair values of each tuple

getResponseValue(response, firstPair)¶

Description:	Gets the 1st level of important main response fields from the VIP SOAP call and tells what fields are accessible
Note:	This requires the SOAP response as a parameter.
Parameters:	response (list of tuples) – The SOAP response firstPair (string) – The first pair in the tuple field
Returns:	The field value at the pair key

getServerTime(requestId, onBehalfOfAccountId=None)¶

Description:	Get server time
Note:
Parameters:	requestId (string) – A identifier ID of a call, may be useful for troubleshooting onBehalfOfAccountId (string) – The parent account that this request is done on behalf of a child account. The parent account uses its own certificate to authenticate the request to VIP User Services.
Returns:	the return SOAP response.

getTemporaryPasswordAttributes(requestId, userId, onBehalfOfAccountId=None)¶

Description:	Get associated attributes of a temporary password
Note:
Parameters:	requestId (string) – A identifier ID of a call, may be useful for troubleshooting onBehalfOfAccountId (string) – The parent account that this request is done on behalf of a child account. The parent account uses its own certificate to authenticate the request to VIP User Services.
UserId:	Unique userid registered in VIP
Returns:	the return SOAP response.

getUserInfo(requestId, userId, onBehalfOfAccountId=None, iaInfo=True, includePushAttributes=True)¶

Description:	Get the account info of a VIP user
Note:
Parameters:	requestId (string) – A identifier ID of a call, may be useful for troubleshooting onBehalfOfAccountId (string) – The parent account that this request is done on behalf of a child account. The parent account uses its own certificate to authenticate the request to VIP User Services. iaInfo (boolean) – Includes iaInfo in response message includesPushAttributes (bollean) – Includes push attributes in response message
UserId:	Unique user id regisered on VIP
Returns:	the return SOAP response.

pollPushStatus(requestId, transactionId, onBehalfOfAccountId=None)¶

Description:	Poll status of a sent push notification
Note:	It is associate with a unique transaction ID
Parameters:	requestId (string) – A identifier ID of a call, may be useful for troubleshooting onBehalfOfAccountId (string) – The parent account that this request is done on behalf of a child account. The parent account uses its own certificate to authenticate the request to VIP User Services.
TransactionId:	A unique identifier for a push transaction
Returns:	the return SOAP response.