This action may lead to changes in the database
Do you want to continue?
Data Explorer
Request Information
Add User To ActOn File
This endpoint is used for create ActOn lists with the structure required for the ActOn API, after creating the list with this endpoint you should send it to ActOn API using the UploadUsersFilesToActOn endpoint.
Parameters:
- Any parameter is required
Body Parameters
ActOnUserDetail| Name | Description | Type | Additional information |
|---|---|---|---|
| UserID |
User identification |
string |
None. |
| EmailAddress |
User Email Address |
string |
None. |
| MarketName |
NHS Market Name |
string |
None. |
| PartnerId |
NHS Market Id |
string |
None. |
| PartnerName |
NHS Partner Name |
string |
None. |
| PartnerUrl |
NHS Partner URL |
string |
None. |
| BrandPartnerId |
NHS Brand Partner Id |
string |
None. |
| FirstName |
User First Name |
string |
None. |
| LastName |
User Last Name |
string |
None. |
| MailList |
Mail List |
string |
None. |
| MarketOptIn |
Market Options in |
string |
None. |
| AccountStatus |
Account Status |
string |
None. |
| MoveInDate |
Move In Date |
string |
None. |
| PrefDescription |
Prefer Description |
string |
None. |
| ReasonDescription |
Reason Description |
string |
None. |
| StreetAddress |
Street Address |
string |
None. |
| City |
City |
string |
None. |
| State |
State |
string |
None. |
| MarketId |
NHS Market Id |
string |
None. |
| PostalCode |
Postal Code |
string |
None. |
| RegisteredDate |
Registred Date |
string |
None. |
| OfficePhoneNumber |
Office Phone Number |
string |
None. |
| PersonalPhoneNumber |
Personal Phone Number |
string |
None. |
| ProcessedDate |
Processed Date |
string |
None. |
| ListName |
List Name, used as file name |
string |
None. |
| ListId |
List Id |
string |
None. |
Response
×
The request was made Successfully! Check the result!.
×
Error Something happen, the Api doesn't have a response.
{
"Time": "sample string 1",
"Error": {
"ClassName": "System.Exception",
"Message": null,
"Data": null,
"InnerException": null,
"HelpURL": "sample string 1",
"StackTraceString": null,
"RemoteStackTraceString": null,
"RemoteStackIndex": 0,
"ExceptionMethod": null,
"HResult": 3,
"Source": "sample string 2",
"WatsonBuckets": null
},
"ErrorMessage": "sample string 2",
"Status": "sample string 3",
"Server": "sample string 4",
"Count": 1,
"FavoriteCounts": {
"CommCount": 1,
"PlanCount": 2,
"SpecCount": 3
},
"FavoriteFacets": {
"Cities": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
],
"PostalCodes": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
],
"Markets": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
]
},
"Result": true
}
<Root>
<Time>sample string 1</Time>
<Error>
<ClassName>System.Exception</ClassName>
<Message />
<Data />
<InnerException />
<HelpURL>sample string 1</HelpURL>
<StackTraceString />
<RemoteStackTraceString />
<RemoteStackIndex>0</RemoteStackIndex>
<ExceptionMethod />
<HResult>3</HResult>
<Source>sample string 2</Source>
<WatsonBuckets />
</Error>
<ErrorMessage>sample string 2</ErrorMessage>
<Status>sample string 3</Status>
<Server>sample string 4</Server>
<Count>1</Count>
<FavoriteCounts>
<CommCount>1</CommCount>
<PlanCount>2</PlanCount>
<SpecCount>3</SpecCount>
</FavoriteCounts>
<FavoriteFacets>
<Cities>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Cities>
<Cities>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Cities>
<PostalCodes>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</PostalCodes>
<PostalCodes>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</PostalCodes>
<Markets>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Markets>
<Markets>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Markets>
</FavoriteFacets>
<Result>true</Result>
</Root>
Code Generator
Response Information
ApiResultModelOfBoolean
| Name | Description | Type | Additional information |
|---|---|---|---|
| Time | string |
None. |
|
| Error | Exception |
None. |
|
| ErrorMessage | string |
None. |
|
| Status | string |
None. |
|
| Server | string |
None. |
|
| Count | integer |
None. |
|
| FavoriteCounts | ApiFavoriteCounts |
None. |
|
| FavoriteFacets | ApiFavoriteFacets |
None. |
|
| Result | boolean |
None. |
|
| VerboseLogger | List of IVerboseLogger |
None. |
POST
api/v2/ActOn/AddUserToActOnFile