SOAP API: Creating Accounts

Our SOAP API can be utilised to create accounts in your World Manager platform via an integration with a third-party app. The purpose of this article, is to provide information & instructions on this process.

Creating an Integration Client

Firstly, an Integration Client must be created within your World Manager platform specifically for use with our SOAP API. See steps below:

Note: This can only be done using a ‘World Manager’ (top) level admin account.

1. Go to System → System Configuration

2. Click on Integration Clients

3. Click on New Integration Client

Important: Keep a copy of the Client ID and Client Secret values for use later.

4. In the Name field, enter a descriptive name

5. In the Scope field, tick the following checkbox options:

  • SOAP API

6. Click on Save

Making Requests

Generating an Access Token

To make requests using the SOAP API, you will need to generate an access token, using the Client ID & Client Secret values copied from the Integration Client you created in the earlier steps.

Please refer to our SOAP API documentation for further information on how to generate an access token.

Note: The SOAP API token endpoint for your platform is: <Your Platform URL>/oauth/token.

Role: World Manager

The following properties are required in order to create accounts in the 'World Manager' role:

  • groupID -- this is a deprecated property; however a value of 0 is still required
  • groupUuids
  • username
  • password
  • firstName
  • lastName
  • active -- this is not required; however, it will default to 'inactive' if not set (to true)
  • language
  • email -- only required if the 'Email Required' option is enabled under System → System Configuration → Account Settings

Below is an example of a SOAP request/payload:

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v7="http://v7.soap.platform.worldmanager.com/">
   <soap:Header/>
   <soap:Body>
      <v7:addAccount>
         <account>
            <groupID>0</groupID>
            <groupUuids>
               <item>
                  <uuid>groupUuidHere</uuid>
               </item>
            </groupUuids>
            <username>usernameHere</username>
            <password>passwordHere</password>
            <person>
               <firstName>firstNameHere</firstName>
               <lastName>lastNameHere</lastName>
            </person>
            <active>1</active>
            <language>languageHere</language>
            <email>emailHere</email>
         </account>
      </v7:addAccount>
   </soap:Body>
</soap:Envelope>

Role: National Manager

The following properties are required in order to create accounts in the 'National Manager' role:

  • groupID -- this is a deprecated property; however a value of 0 is still required
  • groupUuids
  • countryUuids
  • username
  • password
  • firstName
  • lastName
  • active -- this is not required; however, it will default to 'inactive' if not set (to true)
  • language
  • email -- only required if the 'Email Required' option is enabled under System → System Configuration → Account Settings

Below is an example of a SOAP request/payload:

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v7="http://v7.soap.platform.worldmanager.com/">
   <soap:Header/>
   <soap:Body>
      <v7:addAccount>
         <account>
            <groupID>0</groupID>
            <groupUuids>
               <item>
                  <uuid>groupUuidHere</uuid>
               </item>
            </groupUuids>
            <countryUuids>
               <item>
                  <uuid>countryUuidsHere</uuid>
               </item>
            </countryUuids>
            <username>usernameHere</username>
            <password>passwordHere</password>
            <person>
               <firstName>firstNameHere</firstName>
               <lastName>lastNameHere</lastName>
            </person>
            <active>1</active>
            <language>languageHere</language>
            <email>emailHere</email>
         </account>
      </v7:addAccount>
   </soap:Body>
</soap:Envelope>

Role: Area Manager

The following properties are required in order to create accounts in the 'Area Manager' role:

  • groupID -- this is a deprecated property; however a value of 0 is still required
  • groupUuids
  • areaUuids
  • username
  • password
  • firstName
  • lastName
  • active -- this is not required; however, it will default to 'inactive' if not set (to true)
  • language
  • email -- only required if the 'Email Required' option is enabled under System → System Configuration → Account Settings
  • workStartDate

Below is an example of a SOAP request/payload:

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v7="http://v7.soap.platform.worldmanager.com/">
   <soap:Header/>
   <soap:Body>
      <v7:addAccount>
         <account>
            <groupID>0</groupID>
            <groupUuids>
               <item>
                  <uuid>groupUuidHere</uuid>
               </item>
            </groupUuids>
            <areaUuids>
               <item>
                  <uuid>areaUuidsHere</uuid>
               </item>
            </areaUuids>
            <username>usernameHere</username>
            <password>passwordHere</password>
            <person>
               <firstName>firstNameHere</firstName>
               <lastName>lastNameHere</lastName>
            </person>
            <active>1</active>
            <language>languageHere</language>
            <email>emailHere</email>
            <workStartDate>workStartDateHere</workStartDate>
         </account>
      </v7:addAccount>
   </soap:Body>
</soap:Envelope>

Roles: General Manager, Store Manager and Employee

The following properties are required in order to create accounts in the 'General Manager', 'Store Manager' and 'Employee' roles:

  • groupID -- this is a deprecated property; however a value of 0 is still required
  • groupUuids
  • storeUuids
  • username
  • password
  • firstName
  • lastName
  • active -- this is not required; however, it will default to 'inactive' if not set (to true)
  • language
  • positionType
  • email -- only required if the 'Email Required' option is enabled under System → System Configuration → Account Settings
  • workStartDate

Below is an example of a SOAP request/payload:

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v7="http://v7.soap.platform.worldmanager.com/">
   <soap:Header/>
   <soap:Body>
      <v7:addAccount>
         <account>
            <groupID>0</groupID>
            <groupUuids>
               <item>
                  <uuid>groupUuidHere</uuid>
               </item>
            </groupUuids>
            <storeUuids>
               <item>
                  <uuid>storeUuidsHere</uuid>
               </item>
            </storeUuids>
            <username>usernameHere</username>
            <password>passwordHere</password>
            <person>
               <firstName>firstNameHere</firstName>
               <lastName>lastNameHere</lastName>
            </person>
            <active>statusHere</active>
            <language>languageHere</language>
          <positionType>positionTypeHere</positionType>
            <email>emailHere</email>
            <workStartDate>workStartDateHere</workStartDate>
         </account>
      </v7:addAccount>
   </soap:Body>
</soap:Envelope>

If you have any questions, or require further assistance, please contact our Support Team at wmsupport@franconnect.com.

Was this article helpful?
0 out of 0 found this helpful