GET api/v1/admin/tasks

List of all available tasks that can be scheduled for the account.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

List containing the tasks and their details. Each task will contain the following information: 1) The ID of the task. 2) The name of the task. 3) What frequencies the task can be run. 4) The type of the task. 5) The URL of the help page to determine the parameters that can be set for the task.

TwoSms.CustomerPortalRole.API.Misc.ResponseOfSystem.Collections.Generic.IListOfTwoSms.CustomerPortalRole.API.Admin.Tasks.Task
NameDescriptionTypeAdditional information
Error

TwoSms.CustomerPortalRole.API.Misc.Error

None.

ResponseData

TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfSystem.Collections.Generic.IListOfTwoSms.CustomerPortalRole.API.Admin.Tasks.Task

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": [
      {
        "ID": "c7196a03-f9b0-4146-8afb-bbfc676f815f",
        "Name": "sample string 2",
        "Type": "sample string 3",
        "Frequency": "sample string 4",
        "HelpPage": "sample string 5"
      },
      {
        "ID": "c7196a03-f9b0-4146-8afb-bbfc676f815f",
        "Name": "sample string 2",
        "Type": "sample string 3",
        "Frequency": "sample string 4",
        "HelpPage": "sample string 5"
      }
    ]
  }
}