GetUserSettings

  • Method

    Slimcd.Login.GetUserSettings

    Purpose

    Get settings for a specific username/password.

    Description

    Retrieves a list of settings for the username/password, including transaction type permissions and any messages to be displayed to the user. Message blocks contain 5 rows. Multiple message blocks can be returned as multiple settings.

    Business Rules

    Link to something

    Request Fields

    FieldName
    Type
    Length
    Required
    Description
    UserName
    string
    20
    required
    Username or API Access Credential that accesses web service.
    Password
    string
    20
    required
    Plaintext password for the client account.

    1 Passwords are required except when the username is set to an API Access Credential, in which case it should be passed in as an empty string.

    2 If an API Access Credential is only authorized for a single sites, passing in the default siteid value of zero will close the currently open batch for that single site.

    3 If the API Access Credential is authorized for multiple sites, the SiteID must be specified to indicate which batch to close.

    3 If the username is set to a clientid or username other than an API Access Credential, you must specify a non-zero siteidto indicate which batch to close.

    5 The batchnumber should always be passed as an empty string to close the open batch. Specifying a batch number will re-close an existing batch and may result in duplicate charges.

    Reply Fields

    reply
    outer tag for the reply data block
    response
    Success, FAIL, Error
    response code
    0, 1, 2 (respective) matching the above
    description
    If successful, this will contain the single word, OK. Otherwise it will contain a description of failure or error which occurred
    reponseurl
    The Slimcd.com url which was called for this operation
    datablock
    The confirmation text returned from the server.

     

    Reply Hierarchy

    • reply
      • response
      • responsecode
      • description
      • responseurl
      • datablock
        • Settings
          • Setting
            • UserType
            • UserTypeID
            • AllowSALE
            • AllowAUTH
            • AllowFORCE
            • AllowVOID
            • AllowCREDIT
            • MessageLine1
            • MessageLine2
            • MessageLine3
            • MessageLine4
            • MessageLine5

    Remarks

     

    • General
      1. Names in name/value pairs are NOT case-sensitive
      2. Names inside XML tags ARE case-sensitive
    • Function-Specific
          None
  • Include

    Method

    request

    Reply

    Sample Code

    Downloads

    Download full sample source.

  • Include

    Method

    request

    JSON Reply

    Sample Code

    Downloads

    Download full sample source.

  • Include

    Method

    request

    Reply

    Sample Code

    Downloads

    Download full sample source.

  • Include

    Method

    request

    Reply

    Sample Code

    Downloads

    Download full sample source.

  • Method

    request

    Reply

    Sample Code

    Downloads

    Download full sample source.

  • URL

    Protocols

    • SOAP/XML
    • HTTP POST
    • HTTP GET

    Request


    The sample above shows the name/value pairs that would be send with HTTP POST

    Protocol details for SOAP 1.1 and SOAP 1.2 can be found here:
    https://stats.slimcd.com/wswebservices/login.asmx?op=GetUserSettings

    Status Codes

    Status Code
    Status Description
    Explanation
    200
    200 OK
    Approved or declined attempts will return a response with an XML reply block
    500
    500 Internal Server Error
    The response will not contain XML, as a server error has occurred.

     

    Reply

    Output is in XML format if a status code of 200 is returned.

    If the <reply> block’s <response> tag does not indicate “Success”, the <description> tag will contain an error description which can be displayed to the end-user

    Sample Code


    The sample above shows the use of an API Access Credential with a blank password, and specifies a long timeout for CloseBatch


    The sample above shows the clientid, siteid and password. BatchNumber is always blank.

    Downloads

    Exerciser Tool

    Remarks

     

    • Remarks Go here
  • URL

    Protocols

    • HTTP POST
    • HTTP GET

    This function accepts either name/value pairs or JSON

    Request

    Reply

    Sample Code


    The sample above shows the use of an API Access Credential with a blank password, and specifies a long timeout for CloseBatch


    The sample above shows the clientid, siteid and password. BatchNumber is always blank.


    The sample above shows the use jQuery cross-domain POST with jsonp, sends an API Access Credential with a blank password, and specifies a long timeout for CloseBatch. Note that the service can be specified on the URL or inside the request object as another json data item


    The sample above shows the use jQuery cross-domain POST with name/value pairs, sends an API Access Credential with a blank password, and specifies a long timeout for CloseBatch. Note that the service can be specified on the URL or inside the request object as another name/value pair

    Remarks

    1. None