{
  "opencollection": "1.0.0",
  "info": {
    "name": "Alianza Account API",
    "version": "2"
  },
  "items": [
    {
      "info": {
        "name": "Account",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Multi Line Account Activation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/activation/multiple",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use to activate account with multiple users/devices/telephone numbers"
        },
        {
          "info": {
            "name": "Account activation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/activation",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "(DEPRECATED) Use to activate an account"
        },
        {
          "info": {
            "name": "retrieve_6",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              }
            ]
          }
        },
        {
          "info": {
            "name": "Create account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use to create an account"
        },
        {
          "info": {
            "name": "Account search",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/search",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "Search term for account search"
              }
            ]
          },
          "docs": "Use to search for an account"
        },
        {
          "info": {
            "name": "Account history record search",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/accounthistorysearch",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountNumber",
                "value": "",
                "type": "query",
                "description": "Account Number, required"
              },
              {
                "name": "accountHistoryType",
                "value": "",
                "type": "query",
                "description": "Account history type"
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "Start date"
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "End date"
              },
              {
                "name": "firstResultIndex",
                "value": "",
                "type": "query",
                "description": "First result to display, defaults to 0"
              },
              {
                "name": "maxResult",
                "value": "",
                "type": "query",
                "description": "Maximum number to return, defaults to 20"
              }
            ]
          },
          "docs": "Use to search for account history records"
        },
        {
          "info": {
            "name": "Change account status in bulk",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/bulkstatuschange",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": []
            }
          },
          "docs": "Use to change multiple account statuses"
        },
        {
          "info": {
            "name": "Change account status in bulk",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/bulkstatuschange_2",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use to change multiple account statuses"
        },
        {
          "info": {
            "name": "Frequently accessed account search",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/frequentlyaccessed",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              }
            ]
          },
          "docs": "Use to list all frequently accessed accounts"
        },
        {
          "info": {
            "name": "Recently accessed account search",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/recentlyaccessed",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              }
            ]
          },
          "docs": "Use to list all recently accessed accounts"
        },
        {
          "info": {
            "name": "Pre-validate property on the Account object",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/validateproperties",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountnumber",
                "value": "",
                "type": "query",
                "description": "Account Number"
              },
              {
                "name": "username",
                "value": "",
                "type": "query",
                "description": "Username to validate"
              },
              {
                "name": "macaddress",
                "value": "",
                "type": "query",
                "description": "Mac address"
              },
              {
                "name": "sipusername",
                "value": "",
                "type": "query",
                "description": "Sip Username"
              }
            ]
          },
          "docs": "Pre-validate property on the Account object"
        },
        {
          "info": {
            "name": "Retrieve account by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              },
              {
                "name": "accountIdType",
                "value": "",
                "type": "query",
                "description": "Defines if the ID is the account id or the account number.  Default is Id.  Possible Values are Id, AccountNumber"
              }
            ]
          },
          "docs": "Use to retrieve a single account"
        },
        {
          "info": {
            "name": "Update account",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use to update an account"
        },
        {
          "info": {
            "name": "Update account",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use to update an account"
        },
        {
          "info": {
            "name": "Delete account",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              }
            ]
          },
          "docs": "Use to delete an account"
        },
        {
          "info": {
            "name": "Determine which lines are available on a device/mac",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/macaddress/:macAddress/inventory",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              },
              {
                "name": "macAddress",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Uses to determine which lines are available on a device/mac, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline?filterType=MAC_ADDRESS_INVENTORY&filter={mac} endpoint instead"
        },
        {
          "info": {
            "name": "Account history record search",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/accounthistorysearch",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              },
              {
                "name": "accountHistoryType",
                "value": "",
                "type": "query",
                "description": "Account history type"
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "Start date"
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "End date"
              },
              {
                "name": "firstResultIndex",
                "value": "",
                "type": "query",
                "description": "First result to display, defaults to 0"
              },
              {
                "name": "maxResult",
                "value": "",
                "type": "query",
                "description": "Maximum number to return, defaults to 20"
              }
            ]
          },
          "docs": "Use to search for account history records"
        },
        {
          "info": {
            "name": "Send welcome email to all users that was not sent it before",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/send-welcome-email",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              }
            ]
          },
          "docs": "Used to send an welcome email to all users in the account"
        },
        {
          "info": {
            "name": "Change Calling Plan",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/callingplanproduct/:callingPlanProductId",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              },
              {
                "name": "callingPlanProductId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will add a pending calling plan.  If a pending calling plan already exists it will remove it and set the new calling plan"
        },
        {
          "info": {
            "name": "Change Calling Plan Immediately",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/callingplanswap",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will swap the active calling plan immediately for the specified calling plan"
        },
        {
          "info": {
            "name": " Cancel Pending Callingplan",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/cancelpendingcallingplan",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              }
            ]
          },
          "docs": "DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will cancel any pending calling plan"
        },
        {
          "info": {
            "name": "getDeviceDataForAccount",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/macaddress/:macAddress",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              },
              {
                "name": "macAddress",
                "value": "",
                "type": "path"
              }
            ]
          }
        },
        {
          "info": {
            "name": "Account Available User Product Plans",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/user-product-plans",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              }
            ]
          },
          "docs": "Use to retrieve product plans available to an account"
        },
        {
          "info": {
            "name": "Account status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/status",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              }
            ]
          },
          "docs": "Use to retrieve the status of a account"
        },
        {
          "info": {
            "name": "Devices on an Account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/devices",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              }
            ]
          },
          "docs": "Used to list all devices on an account, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline endpoint instead"
        },
        {
          "info": {
            "name": "Retrieve the default bulkstatuschange definition file",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.d2.alianza.com/v2/ref/account/bulkstatuschange",
            "auth": {
              "type": "apikey",
              "key": "X-AUTH-TOKEN",
              "value": "{{X-AUTH-TOKEN}}",
              "placement": "header"
            }
          },
          "docs": "Use to retrieve the default bulkstatuschange definition file.  <span hidden>See <a href=\"bulkStatusChange.html\">here</a> for more information.</span>"
        }
      ]
    }
  ],
  "bundled": true
}