Account Attributes and xml Response

     

    The operations that can be performed on accounts are described below  
     

     Note

    note

     

    1. The operations that can be performed on an account through API are adding, updating and deleting accounts.

    2. Technicians with SDAdmin privilige can add / update / delete accounts.

    3. Technicians with SDAccountAdmin privilige can update an account to which they have access.

    4. The attributes are case sensitive and should be used as defined.

    5. When renaming the button in the sample html form, specify 'operation' as hidden element.

     



     

    Add Account

    To create a new account, the targetURL attribute should be set to /servlets/AccountServlet and the 'operation' attribute should be 'AddAccount'. The 'accountName' and 'loginUrl' parameters are mandatory for creating an account.

     

    Attributes

    Comments

    targetURL=

    "/servlets/AccountServlet"

    target url for adding account

    operation='AddAccount'

    operation command for Adding account.

    accountName

    Name of the account

    description

    Description for the site

    loginUrl

    Login URL for the account.

    doorNo

    Address details for the account  

    street

    Address details for the account

    landmark

    Address details for the account

    city

    Address details for the account

    postalCode

    Address details for the account

    state

    Address details for the account

    country

    Address details for the account

    email

    Email address for the account.

    phone

    Account phone number.

    fax

    Fax number of the account.

    webUrl

    website of the account.

    supportEmail

    Support E-Mail address for the account.

    emailDomain

    Email domains for the account (comma separated list)

    username

    Login Name for ServiceDesk Plus - MSP Authentication

    password

    Password for ServiceDesk Plus - MSP Authentication

    DOMAIN_NAME

    Domain Name to which the user belongs. Domain Name should be specified on enabling AD authentication.

    logonDomainName

    Authentication Mode [AD or Local Authentication].

    "AD_AUTH" refers to Active Directory Authentication.

    'Local Authentication" or empty value refers to Local Authentication.

     

    Note:

     

    The sample form to add a new account can be viewed here.

    The html form is submitted to http://machine_name:Portnumber/servlets/AccountServlet and a response in xml format displays Success message along with the Account ID.

    A failure message appears if,

     

    Update Account

    To update an account, the targetURL attribute should be set to /servlets/AccountServlet and the 'operation' attribute should be 'UpdateAccount'. The 'accountName' and 'OldAccountName' parameters are mandatory.  

     

    Attributes

    Comments

    targetURL=

    "/servlets/AccountServlet"

    target url for editing/updating an account

    operation='UpdateAccount'

    operation command for updating account.

    oldAccountName

    Existing account name

    accountName

    Name of the account

    description

    Description for the site

    loginUrl

    Login URL for the account.

    doorNo

    Address details for the account  

    street

    Address details for the account

    landmark

    Address details for the account

    city

    Address details for the account

    postalCode

    Address details for the account

    state

    Address details for the account

    country

    Address details for the account

    email

    Email address for the account.

    phone

    Account phone number.

    fax

    Fax number of the account.

    webUrl

    website of the account.

    supportEmail

    Support E-Mail address for the account.

    emailDomain

    Email domains for the account (comma separated list)

    username

    Login Name for ServiceDesk Plus - MSP Authentication

    password

    Password for ServiceDesk Plus - MSP Authentication

    DOMAIN_NAME

    Domain Name to which the user belongs. Domain Name should be specified on enabling AD authentication.

    logonDomainName

    Authentication Mode [AD or Local Authentication].

    "AD_AUTH" refers to Active Directory Authentication.

    'Local Authentication" or empty value refers to Local Authentication.

     

    Note:

    The sample form to update an account can be viewed here.

    A Success message appears in the xml form when the site details are updated successfully.

     

    Delete Account

    To delete an account, the targetURL attribute should be set to /servlets/AccountServlet and the 'operation' attribute should be 'DeleteAccount'. 'accountName' is a mandatory parameter to delete an account.

     

    Attributes

    Comments

    targetURL="/servlets/AccountServlet"

    target url for deleting an account

    operation='DeleteAccount'

    operation command for deleting account

    accountName

    Name of the account

    username

    Login Name for ServiceDesk Plus - MSP Authentication

    password

    Password for ServiceDesk Plus - MSP Authentication

    DOMAIN_NAME

    Domain Name to which the user belongs.

    logonDomainName

    Authentication Mode [AD or Local Authentication].

    AD_AUTH refers to Active Directory Authentication.

    Local Authentication or empty value refers to Local Authentication.

     

    The sample form to delete an account can be accessed here.

    A Success message appears in xml format once the account is deleted successfully.  

     

    Copyright © 2017, ZOHO Corp. All Rights Reserved.