Service Management
- Creating an account
- Listing accounts
- Account's details
- Updating an account
- Listing services
- Managing services
- Listing credits
- Managing credits
- Setting Global CC
- Viewing Global CC
This webservice allows creating a new idibu Client account, list and review existing accounts' data, amend their passwords, as well as list and control the available services.
The webservice applies to full Client (admin) accounts only. If you wish to manage Users of any specific Client, please use the User Management Webservice.
Due to the nature of this webservice, it is only available to certain Partners and requires an additional partner-password parameter.
Creating an account
This method allows creating a new idibu Client account.
Endpoint
https://ws.idibu.com/ws/rest/v1/service
Available methods
POST /newaccount
Creates a new account.
Query parameters
| Parameter Name | Type restrictions | Required? | Notes |
|---|---|---|---|
data | String | Yes | The full query XML (see the Query format below), URL-encoded within the parameter. |
Query format
<idibu>
<partner-password>[string]</partner-password> <!-- partner password provided to you by idibu -->
<exempt-id>[integer]</exempt-id> <!-- partner id provided to you by idibu -->
<username>[string]</username> <!-- login username; max 32 characters -->
<password>[string]</password> <!-- login password; max 32 characters -->
<firstname>[string]</firstname> <!-- admin user's first name -->
<lastname>[string]</lastname> <!-- admin user's last name -->
<email>[string:email]</email> <!-- admin user's email address -->
<company-name>[string]</company-name> <!-- account's company name -->
<address>[string]</address> <!-- account's company address; optional -->
<address1>[string]</address1> <!-- address line 1 -->
<address2>[string]</address2> <!-- address line 2; optional -->
<address3>[string]</address3> <!-- address line 3 (County or State); optional -->
<country>[string]</country> <!-- the main country in which the company resides -->
<postcode>[string]</postcode> <!-- account's company postal code -->
<phone>[string:phone]</phone> <!-- account's primary phone number -->
<fax>[string:phone]</fax> <!-- account's primary fax; optional -->
<www>[string:url]</www> <!-- the address of the company's website -->
</idibu>
Response format
<idibu generator="idibu" version="1.0">
<response>
<message>[string]</message> <!-- 'New client successfully created' or an error message -->
<client-hash>[string]</client-hash> <!-- hash of the created account; please keep this! -->
<client-id>[integer]</client-id> <!-- id of the created account; please keep this! -->
<member-id>[integer]</member-id> <!-- deprecated, please ignore -->
</response>
<status>["success"|"failed"]</status> <!-- whether the request succeeded or not -->
</idibu>
Listing Accounts
This method allows viewing existing idibu Client accounts' details for the given Partner.
Endpoint
https://ws.idibu.com/ws/rest/v1/service
Available methods
POST /accounts
Returns the full list of accounts.
Query parameters
| Parameter Name | Type restrictions | Required? | Notes |
|---|---|---|---|
data | String | Yes | The full query XML (see the Query format below). |
count | Integer Min: 1 Max: 100 Default: 10 | No | Number of accounts to return. |
offset | Integer Min: 0 Default: 0 | No | Numeric offset from where to start fetching accounts (pagination). |
Query format
<idibu>
<partner-password>[string]</partner-password> <!-- partner password provided to you by idibu -->
<exempt-id>[integer]</exempt-id> <!-- partner id provided to you by idibu -->
</idibu>
Response format
<idibu generator="idibu" version="1.0">
<response>
<clients>
<client>
<client-hash>[string]</client-hash> <!-- hash of the account -->
<client-id>[integer]</client-id> <!-- id of the account -->
<username>[integer]</username> <!-- account's username -->
</client>
</clients>
</response>
<status>["success"|"failed"]</status> <!-- whether the request succeeded or not -->
</idibu>
Account's details
This method allows obtaining more information about a particular Client.
Endpoint
https://ws.idibu.com/ws/rest/v1/service
Available methods
POST /accountdetails
Returns the detailed info for the account with the provided <client-id/>.
Query parameters
| Parameter Name | Type restrictions | Required? | Notes |
|---|---|---|---|
data | String | Yes | The full query XML (see the Query format below). |
Query format
<idibu>
<partner-password>[string]</partner-password> <!-- partner password provided to you by idibu -->
<exempt-id>[integer]</exempt-id> <!-- partner id provided to you by idibu -->
<client-id>[integer]</client-id> <!-- id of the account -->
</idibu>
Response format
<idibu generator="idibu" version="1.0">
<response>
<client>
<client-hash>[string]</client-hash> <!-- hash of the account -->
<client-id>[integer]</client-id> <!-- id of the account -->
<username>[integer]</username> <!-- account's username -->
<firstname>[string]</firstname> <!-- admin user's first name -->
<lastname>[string]</lastname> <!-- admin user's last name -->
<email>[string:email]</email> <!-- admin user's email address -->
<phone>[string:phone]</phone> <!-- admin user's phone number -->
<company-name>[string]</company-name> <!-- account's company name -->
<address>[string]</address> <!-- account's company address -->
<address1>[string]</address1> <!-- address line 1 -->
<address2>[string]</address2> <!-- address line 2 -->
<address3>[string]</address3> <!-- address line 3 (County or State) -->
<country>[string]</country> <!-- the main country in which the company resides -->
<postcode>[string]</postcode> <!-- account's company postal code -->
<fax>[string:phone]</fax> <!-- account's primary fax -->
<www>[string:url]</www> <!-- the address of the company's website -->
</client>
</response>
<status>["success"|"failed"]</status> <!-- whether the request succeeded or not -->
</idibu>
Updating an account
This method allows amending some of the Client's details.
Endpoint
https://ws.idibu.com/ws/rest/v1/service
Available methods
POST /updateaccount
Updates the account's password.
Query parameters
| Parameter Name | Type restrictions | Required? | Notes |
|---|---|---|---|
data | String | Yes | The full query XML (see the Query format below), URL-encoded within the parameter. Only fields that need updating can be provided. |
Query format
<idibu>
<partner-password>[string]</partner-password> <!-- partner password provided to you by idibu -->
<exempt-id>[integer]</exempt-id> <!-- partner id provided to you by idibu -->
<client-hash>[string]</client-hash> <!-- hash of the idibu account to which the request pertains -->
<password>[string]</password> <!-- new login password; max 32 characters -->
<firstname>[string]</firstname> <!-- new admin user's first name -->
<lastname>[string]</lastname> <!-- new admin user's last name -->
<email>[string:email]</email> <!-- new admin user's email address -->
<company-name>[string]</company-name> <!-- new account's company name -->
<address>[string]</address> <!-- new account's company address -->
<address1>[string]</address1> <!-- new address line 1 -->
<address2>[string]</address2> <!-- new address line 2 -->
<address3>[string]</address3> <!-- new address line 3 (County or State) -->
<country>[string]</country> <!-- new the main country in which the company resides -->
<postcode>[string]</postcode> <!-- new account's company postal code -->
<phone>[string:phone]</phone> <!-- new account's primary phone number -->
<fax>[string:phone]</fax> <!-- new account's primary fax -->
<www>[string:url]</www> <!-- new the address of the company's website -->
</idibu>
Response format
<idibu generator="idibu" version="1.0">
<response>
<message>[string]</message> <!-- 'Client successfully updated' or an error message -->
<client-hash>[string]</client-hash> <!-- hash of the updated account -->
<client-id>[integer]</client-id> <!-- id of the updated account -->
<member-id>[integer]</member-id> <!-- deprecated, please ignore -->
</response>
<status>["success"|"failed"]</status> <!-- whether the request succeeded or not -->
</idibu>
Listing services
This method allows listing all services currently enabled on a Client account.
Available services are tied to your license agreement. Please discuss with your idibu representative to find out which you can enable for your Clients.
Endpoint
https://ws.idibu.com/ws/rest/v1/service
Available methods
POST /list
Lists all services currently enabled on an account.
Query parameters
| Parameter Name | Type restrictions | Required? | Notes |
|---|---|---|---|
data | String | Yes | The full query XML (see the Query format below), URL-encoded within the parameter. |
Query format
<idibu>
<partner-password>[string]</partner-password> <!-- partner password provided to you by idibu -->
<exempt-id>[integer]</exempt-id> <!-- partner id provided to you by idibu -->
<client-hash>[string]</client-hash> <!-- hash of the idibu account to which the request pertains -->
</idibu>
Response format
<idibu generator="idibu" version="1.0">
<response>
<services>[string]</services> <!-- service(s) the account has enabled; multiple <service> nodes can be returned -->
</response>
<status>["success"|"failed"]</status> <!-- whether the request succeeded or not -->
</idibu>
Managing services
This method allows adding or removing services from a Client account.
Available services are tied to your license agreement. Please discuss with your idibu representative to find out which you should enable for your Clients.
Endpoint
https://ws.idibu.com/ws/rest/v1/service
Available methods
POST /add
Adds specified services to an account.
POST /remove
Removes specified services from an account.
Query parameters
| Parameter Name | Type restrictions | Required? | Notes |
|---|---|---|---|
data | String | Yes | The full query XML (see the Query format below), URL-encoded within the parameter. |
Query format
<idibu>
<partner-password>[string]</partner-password> <!-- partner password provided to you by idibu -->
<exempt-id>[integer]</exempt-id> <!-- partner id provided to you by idibu -->
<client-hash>[string]</client-hash> <!-- hash of the idibu account to which the request pertains -->
<services>
<service>[string]</service> <!-- service to enable or disable; multiple <service> nodes can be provided -->
</services>
</idibu>
Response format
<idibu generator="idibu" version="1.0">
<response>
<message>[string]</message> <!-- 'Services added' or 'Services removed' or an error message -->
</response>
<status>["success"|"failed"]</status> <!-- whether the request succeeded or not -->
</idibu>
Listing credits
This method allows listing all Client accounts for the given Partner and their number of Pay Per Post credits. It also provides the total Pay Per Post credits belonging to the Partner account, as well as the number currently assigned to Client accounts and the number still available to assign.
Pay Per Post credits are only available for certain Partners and will be enabled if your license agreement includes them.
Endpoint
https://ws.idibu.com/ws/rest/v1/service
Available methods
GET /viewCredits
Lists the total number of credits, the number of assigned and available credits, as well as all client accounts and the number of credits assigned to them.
Query parameters
| Parameter Name | Type restrictions | Required? | Notes |
|---|---|---|---|
data | String | Yes | The full query XML (see the Query format below), URL-encoded within the parameter. |
count | Integer Min: 1 Max: 100 Default: 10 | No | Number of accounts to return. |
offset | Integer Min: 0 Default: 0 | No | Numeric offset from where to start fetching accounts (pagination). |
Query format
<idibu>
<partner-password>[string]</partner-password> <!-- partner password provided to you by idibu -->
<exempt-id>[integer]</exempt-id> <!-- partner id provided to you by idibu -->
</idibu>
Response format
<idibu generator="idibu" version="1.0">
<response>
<creditsInfo>
<available>[integer]</available> <!-- number of credits that can be distributed among clients -->
<allocated>[integer]</allocated> <!-- number of credits currently assigned to clients -->
<total>[integer]</total> <!-- total number of credits -->
</creditsInfo>
<clients>
<client>
<client-hash>[string]</client-hash> <!-- hash of the account -->
<client-id>[integer]</client-id> <!-- id of the account -->
<username>[integer]</username> <!-- account's username -->
<credits>[integer]</credits> <!-- number of credits assigned to the account -->
</client>
</clients>
</response>
<status>["success"|"failed"]</status> <!-- whether the request succeeded or not -->
</idibu>
Managing credits
This method allows adding or removing Pay Per Post credits on a Client account, either by assigning a specific value or by incrementing/decrementing by a certain number.
Pay Per Post credits are only available for certain Partners and will be enabled if your license agreement includes them.
Endpoint
https://ws.idibu.com/ws/rest/v1/service
Available methods
POST /setCredits
Assigns a specified number of credits to the account.
POST /incrementCredits
Increases (or decreases if negative) the account's credits by a specified number.
Query parameters
| Parameter Name | Type restrictions | Required? | Notes |
|---|---|---|---|
data | String | Yes | The full query XML (see the Query format below), URL-encoded within the parameter. |
Query format
<idibu>
<partner-password>[string]</partner-password> <!-- partner password provided to you by idibu -->
<exempt-id>[integer]</exempt-id> <!-- partner id provided to you by idibu -->
<client-hash>[string]</client-hash> <!-- hash of the idibu account to which the request pertains -->
<credits>[integer]</credits> <!-- number of credits to assign or to add/remove -->
</idibu>
Response format
<idibu generator="idibu" version="1.0">
<response>
<message>[string]</message> <!-- 'Credits updated successfully' or 'Credits incremented successfully' or an error message -->
<client-id>[string]</client-id> <!-- id of the account -->
<credits>[integer]</credits> <!-- current number of credits assigned to the account, following the change -->
</response>
<status>["success"|"failed"]</status> <!-- whether the request succeeded or not -->
</idibu>
Setting Global CC
This method allows adding or removing Global CC email addresses on a Client account.
Global CC is an email address (or set of addresses) that the system will always add as a CC whenever an Applicant is forwarded from idibu. Forwarding settings are controlled as part of Aptrack Settings, specifically the <forward> element.
Endpoint
https://ws.idibu.com/ws/rest/v1/service
Available methods
POST /setccemail
Assigns specified Global CC email addresses to the account, or disables the Global CC if an empty email address is provided.
Query parameters
| Parameter Name | Type restrictions | Required? | Notes |
|---|---|---|---|
data | String | Yes | The full query XML (see the Query format below), URL-encoded within the parameter. |
Query format
<idibu>
<partner-password>[string]</partner-password> <!-- partner password provided to you by idibu -->
<exempt-id>[integer]</exempt-id> <!-- partner id provided to you by idibu -->
<client-hash>[string]</client-hash> <!-- hash of the idibu account to which the request pertains -->
<cc-email>[string:email]</cc-email> <!-- email address to be used as Global CC; multiple addresses can be comma-separated; send empty to disable Global CC -->
</idibu>
Response format
<idibu generator="idibu" version="1.0">
<response>
<message>[string]</message> <!-- 'Client's central CC email set' or 'Client's central CC email removed' or an error message -->
<cc-email>[string:email]</cc-email> <!-- Global CC email addresses set by the request (only present if any emails have been provided) -->
</response>
<status>["success"|"failed"]</status> <!-- whether the request succeeded or not -->
</idibu>
Viewing Global CC
This method allows verifying the Global CC email addresses assigned to the given Client account.
Global CC is an email address (or set of addresses) that the system will always add as a CC whenever an Applicant is forwarded from idibu. Forwarding settings are controlled as part of Aptrack Settings, specifically the <forward> element.
Endpoint
https://ws.idibu.com/ws/rest/v1/service
Available methods
POST /getccemail
Returns the list of the Client's Global CC email addresses.
Query parameters
| Parameter Name | Type restrictions | Required? | Notes |
|---|---|---|---|
data | String | Yes | The full query XML (see the Query format below), URL-encoded within the parameter. |
Query format
<idibu>
<partner-password>[string]</partner-password> <!-- partner password provided to you by idibu -->
<exempt-id>[integer]</exempt-id> <!-- partner id provided to you by idibu -->
<client-hash>[string]</client-hash> <!-- hash of the idibu account to which the request pertains -->
</idibu>
Response format
<idibu generator="idibu" version="1.0">
<response>
<cc-email>[string:email]</cc-email> <!-- Global CC email addresses assigned to the account -->
</response>
<status>["success"|"failed"]</status> <!-- whether the request succeeded or not -->
</idibu>