POST api/v1/bots/twitterbots
Create a Twitter Bot.
Request Information
URI Parameters
None.
Body Parameters
RegisterTwitterBotRequestName | Description | Type | Additional information |
---|---|---|---|
DisplayName | string |
None. |
Request Formats
application/json, text/json, application/senml+json
Sample:
{ "DisplayName": "sample string 1" }
application/xml, text/xml
Sample:
<RegisterTwitterBotRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots.TwitterBot"> <DisplayName>sample string 1</DisplayName> </RegisterTwitterBotRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
TwitterBotDtoName | Description | Type | Additional information |
---|---|---|---|
DateAdded | date |
None. |
|
TwitterScreenName | string |
None. |
|
StatusPostSettings |
Settings governing the tweeting of status posts. |
StatusPostSettingsDto |
None. |
TweetSettings | TweetSettingsDto |
None. |
|
ScheduledTweets | Collection of ScheduledTweetSettingsDto |
None. |
|
Id |
User Id |
globally unique identifier |
None. |
Name |
The users name |
string |
None. |
UserName |
UserName (used to login with) |
string |
None. |
FullUserName |
User Id and Account name |
string |
None. |
BotType |
The type of bot. |
string |
None. |
DisplayName |
Users first and last name |
string |
None. |
DevicesCheckIntervalMinutes |
How often the spark account should be checked for new devices. |
integer |
None. |
MeasurementCollectionIntervalMinutes |
How often measurements should be collected from the devices (applies to new devices only). |
integer |
None. |
Links |
Collection of links appropriate for the user |
Collection of LinkDto |
None. |
Actions | Collection of LinkDto |
None. |
|
Description | string |
None. |
|
Enabled | boolean |
None. |
|
Authenticated |
If the bot is authenticated. |
boolean |
None. |
Response Formats
application/json, text/json, application/senml+json
Sample:
{ "DateAdded": "2024-12-14T13:01:30.2474061+00:00", "TwitterScreenName": "sample string 2", "StatusPostSettings": { "UserIds": [ "01aa00e0-c9fa-4c0c-b7a9-ce9237cb3ab7", "f540db21-071b-434f-840a-02134e5ac7d9" ], "TweetStatusPostsTagged": "sample string 1" }, "TweetSettings": { "PostMentions": true, "Tag": "sample string 2", "TweetPrefix": "sample string 3", "TweetSuffix": "sample string 4" }, "ScheduledTweets": [ { "Name": "sample string 1", "Interval": 2, "DeviceId": "a1c340c8-8f3d-4fda-b2a5-5b436f9c9c98", "Message": "sample string 4", "Conditions": [ { "DeviceId": "8bd2e2cf-946a-45c6-ba5e-6dc55b6b4fbc", "FieldName": "sample string 1", "Operation": "sample string 2", "Value": 3.0 }, { "DeviceId": "8bd2e2cf-946a-45c6-ba5e-6dc55b6b4fbc", "FieldName": "sample string 1", "Operation": "sample string 2", "Value": 3.0 } ] }, { "Name": "sample string 1", "Interval": 2, "DeviceId": "a1c340c8-8f3d-4fda-b2a5-5b436f9c9c98", "Message": "sample string 4", "Conditions": [ { "DeviceId": "8bd2e2cf-946a-45c6-ba5e-6dc55b6b4fbc", "FieldName": "sample string 1", "Operation": "sample string 2", "Value": 3.0 }, { "DeviceId": "8bd2e2cf-946a-45c6-ba5e-6dc55b6b4fbc", "FieldName": "sample string 1", "Operation": "sample string 2", "Value": 3.0 } ] } ], "Id": "52f1313e-86a5-40b5-8407-39a133cbd2a3", "Name": "sample string 4", "UserName": "sample string 5", "FullUserName": "sample string 6", "BotType": "sample string 7", "DisplayName": "sample string 8", "DevicesCheckIntervalMinutes": 9, "MeasurementCollectionIntervalMinutes": 10, "Links": [ { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" }, { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" } ], "Actions": [ { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" }, { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" } ], "Description": "sample string 11", "Enabled": true, "Authenticated": true }
application/xml, text/xml
Sample:
<TwitterBotDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots.TwitterBot"> <Actions xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots"> <d2p1:LinkViewModel> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:LinkViewModel> <d2p1:LinkViewModel> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:LinkViewModel> </Actions> <Authenticated xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">true</Authenticated> <BotType xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 7</BotType> <Description xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 11</Description> <DevicesCheckIntervalMinutes xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">9</DevicesCheckIntervalMinutes> <DisplayName xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 8</DisplayName> <Enabled xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">true</Enabled> <FullUserName xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 6</FullUserName> <Id xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">52f1313e-86a5-40b5-8407-39a133cbd2a3</Id> <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots"> <d2p1:LinkViewModel> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:LinkViewModel> <d2p1:LinkViewModel> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:LinkViewModel> </Links> <MeasurementCollectionIntervalMinutes xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">10</MeasurementCollectionIntervalMinutes> <Name xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 4</Name> <UserName xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 5</UserName> <DateAdded>2024-12-14T13:01:30.2474061+00:00</DateAdded> <ScheduledTweets> <ScheduledTweetSettingsDto> <Conditions> <ConditionDto> <DeviceId>8bd2e2cf-946a-45c6-ba5e-6dc55b6b4fbc</DeviceId> <FieldName>sample string 1</FieldName> <Operation>sample string 2</Operation> <Value>3</Value> </ConditionDto> <ConditionDto> <DeviceId>8bd2e2cf-946a-45c6-ba5e-6dc55b6b4fbc</DeviceId> <FieldName>sample string 1</FieldName> <Operation>sample string 2</Operation> <Value>3</Value> </ConditionDto> </Conditions> <DeviceId>a1c340c8-8f3d-4fda-b2a5-5b436f9c9c98</DeviceId> <Interval>2</Interval> <Message>sample string 4</Message> <Name>sample string 1</Name> </ScheduledTweetSettingsDto> <ScheduledTweetSettingsDto> <Conditions> <ConditionDto> <DeviceId>8bd2e2cf-946a-45c6-ba5e-6dc55b6b4fbc</DeviceId> <FieldName>sample string 1</FieldName> <Operation>sample string 2</Operation> <Value>3</Value> </ConditionDto> <ConditionDto> <DeviceId>8bd2e2cf-946a-45c6-ba5e-6dc55b6b4fbc</DeviceId> <FieldName>sample string 1</FieldName> <Operation>sample string 2</Operation> <Value>3</Value> </ConditionDto> </Conditions> <DeviceId>a1c340c8-8f3d-4fda-b2a5-5b436f9c9c98</DeviceId> <Interval>2</Interval> <Message>sample string 4</Message> <Name>sample string 1</Name> </ScheduledTweetSettingsDto> </ScheduledTweets> <StatusPostSettings> <TweetStatusPostsTagged>sample string 1</TweetStatusPostsTagged> <UserIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>01aa00e0-c9fa-4c0c-b7a9-ce9237cb3ab7</d3p1:guid> <d3p1:guid>f540db21-071b-434f-840a-02134e5ac7d9</d3p1:guid> </UserIds> </StatusPostSettings> <TweetSettings> <PostMentions>true</PostMentions> <Tag>sample string 2</Tag> <TweetPrefix>sample string 3</TweetPrefix> <TweetSuffix>sample string 4</TweetSuffix> </TweetSettings> <TwitterScreenName>sample string 2</TwitterScreenName> </TwitterBotDto>