POST api/v2/admin/tasks/account
Creates a new task for the account. Before a new task can be created a client must have been created before hand.
Request Information
URI Parameters
None.
Body Parameters
The details of the task to be created.
TwoSms.CustomerPortalRole.API.Admin.Tasks.AccountTaskRequestName | Description | Type | Additional information |
---|---|---|---|
TaskID |
The ID of the task to be registered. |
globally unique identifier |
Required |
Frequency |
How often the task should run. |
TwoSms.Platform.Database.CustomerPortal.Tables.Task.Frequency |
Required |
StartDate |
Determines when the task should start running. |
date |
None. |
FinishDate |
Determines when the task should stop running. |
date |
None. |
Parameters |
The parameters for the task. |
string |
Required |
ContentType |
The format the parameters are in. Must either be application/xml or application/json. |
string |
Required |
Notification |
Determines the notifications the task could send back to the user. |
TwoSms.Platform.Database.CustomerPortal.Tables.Task.TaskNotification |
None. |
Request Formats
application/json, text/json
Sample:
{ "TaskID": "5f2ab0f5-95be-40d5-834f-d6353ea0a8be", "Frequency": 0, "StartDate": "2025-01-18T05:09:04.0954022+00:00", "FinishDate": "2025-01-18T05:09:04.096411+00:00", "Parameters": "sample string 3", "ContentType": "sample string 4", "Notification": 0 }
application/xml, text/xml
Sample:
<AccountTaskRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <TaskID>5f2ab0f5-95be-40d5-834f-d6353ea0a8be</TaskID> <Frequency>NONE</Frequency> <StartDate>2025-01-18T05:09:04.0954022+00:00</StartDate> <FinishDate>2025-01-18T05:09:04.096411+00:00</FinishDate> <Parameters>sample string 3</Parameters> <ContentType>sample string 4</ContentType> <Notification>NONE</Notification> </AccountTaskRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
The task details with its ID field populated.
TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.Admin.Tasks.AccountTaskResponseName | Description | Type | Additional information |
---|---|---|---|
Error | TwoSms.CustomerPortalRole.API.Misc.Error |
None. |
|
ResponseData | TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.Admin.Tasks.AccountTaskResponse |
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": "f438a19e-daa3-4f81-81d0-779b249a7e6f", "TaskID": "a6b177f7-04be-4f70-a2a2-7945598a082f", "Name": "sample string 3", "Enabled": true, "Frequency": "sample string 5", "StartDate": "2025-01-18T05:09:04.1057154+00:00", "FinishDate": "2025-01-18T05:09:04.1057154+00:00", "Parameters": "sample string 7", "ContentType": "sample string 8", "Notification": "sample string 9", "DateCreated": "2025-01-18T05:09:04.1057154+00:00", "DateModified": "2025-01-18T05:09:04.1057154+00:00", "LastRunOn": "2025-01-18T05:09:04.1057154+00:00", "LastRunBy": "sample string 11", "LastModifiedBy": "sample string 12", "Status": "sample string 13", "ClientID": "e0192a97-64db-4bc1-a270-9ebcbde873cb" } } }