CampaignTaxi Web Service Reference

Table of Contents

Overview

Description

This document contains Web Service descriptions for the following services.

Web Services

Name  Description 
CampaignTaxi  API Version 4

CampaignTaxi Web Service

Description

API Version 4

Type

SOAP

See Also

Methods | Complex Types | Simple Types

Methods: CampaignTaxi

Methods

Name 
ClientGetCustomAttributes 
ClientGetSubscriptions 
CompetitionAddEntry 
CompetitionGetConsumerDetails 
CompetitionGetDetails 
ConsumerAdd 
ConsumerAuthenticate 
ConsumerChangePassword 
ConsumerConfirmActivation 
ConsumerGetDetails 
ConsumerGetSubscriptions 
ConsumerResendActivation 
ConsumerResetPassword 
ConsumerSubscribe 
ConsumerUnsubscribe 
ConsumerUpdate 
InteractionInsert 

Method: ClientGetCustomAttributes

Input (Literal)

The input of this method is the argument ClientGetCustomAttributes having the structure defined by the following table.

Element  Type 
clientKey  string 

Output (Literal)

The output of this method is the argument ClientGetCustomAttributesResponse having the structure defined by the following table.

Element  Type 
ClientGetCustomAttributesResult  ResultCustomAttributes 

Method: ClientGetSubscriptions

Input (Literal)

The input of this method is the argument ClientGetSubscriptions having the structure defined by the following table.

Element  Type 
clientKey  string 

Output (Literal)

The output of this method is the argument ClientGetSubscriptionsResponse having the structure defined by the following table.

Element  Type 
ClientGetSubscriptionsResult  ResultSubscriptions 

Method: CompetitionAddEntry

Input (Literal)

The input of this method is the argument CompetitionAddEntry having the structure defined by the following table.

Element  Type 
id  ConsumerId 
moduleKey  string 

Output (Literal)

The output of this method is the argument CompetitionAddEntryResponse having the structure defined by the following table.

Element  Type 
CompetitionAddEntryResult  ResultCompetitionEntry 

Method: CompetitionGetConsumerDetails

Input (Literal)

The input of this method is the argument CompetitionGetConsumerDetails having the structure defined by the following table.

Element  Type 
id  ConsumerId 
moduleKey  string 

Output (Literal)

The output of this method is the argument CompetitionGetConsumerDetailsResponse having the structure defined by the following table.

Element  Type 
CompetitionGetConsumerDetailsResult  ResultCompetitionConsumerDetails 

Method: CompetitionGetDetails

Input (Literal)

The input of this method is the argument CompetitionGetDetails having the structure defined by the following table.

Element  Type 
moduleKey  string 

Output (Literal)

The output of this method is the argument CompetitionGetDetailsResponse having the structure defined by the following table.

Element  Type 
CompetitionGetDetailsResult  ResultCompetitionDetails 

Method: ConsumerAdd

Input (Literal)

The input of this method is the argument ConsumerAdd having the structure defined by the following table.

Element  Type 
consumer  Consumer 
lookupMode  IdMode 
subscriptionKeys  ArrayOfstring 
moduleKey  string 

Output (Literal)

The output of this method is the argument ConsumerAddResponse having the structure defined by the following table.

Element  Type 
ConsumerAddResult  ResultConsumerAdd 

Method: ConsumerAuthenticate

Input (Literal)

The input of this method is the argument ConsumerAuthenticate having the structure defined by the following table.

Element  Type 
username  string 
password  string 
moduleKey  string 

Output (Literal)

The output of this method is the argument ConsumerAuthenticateResponse having the structure defined by the following table.

Element  Type 
ConsumerAuthenticateResult  ResultConsumerAuthenticate 

Method: ConsumerChangePassword

Input (Literal)

The input of this method is the argument ConsumerChangePassword having the structure defined by the following table.

Element  Type 
username  string 
password  string 
moduleKey  string 

Output (Literal)

The output of this method is the argument ConsumerChangePasswordResponse having the structure defined by the following table.

Element  Type 
ConsumerChangePasswordResult  ResultConsumerPassword 

Method: ConsumerConfirmActivation

Input (Literal)

The input of this method is the argument ConsumerConfirmActivation having the structure defined by the following table.

Element  Type 
confirmationKey  string 
moduleKey  string 

Output (Literal)

The output of this method is the argument ConsumerConfirmActivationResponse having the structure defined by the following table.

Element  Type 
ConsumerConfirmActivationResult  ResultConfirmActivation 

Method: ConsumerGetDetails

Input (Literal)

The input of this method is the argument ConsumerGetDetails having the structure defined by the following table.

Element  Type 
id  ConsumerId 
clientKey  string 

Output (Literal)

The output of this method is the argument ConsumerGetDetailsResponse having the structure defined by the following table.

Element  Type 
ConsumerGetDetailsResult  ResultConsumerDetails 

Method: ConsumerGetSubscriptions

Input (Literal)

The input of this method is the argument ConsumerGetSubscriptions having the structure defined by the following table.

Element  Type 
id  ConsumerId 
clientKey  string 

Output (Literal)

The output of this method is the argument ConsumerGetSubscriptionsResponse having the structure defined by the following table.

Element  Type 
ConsumerGetSubscriptionsResult  ResultSubscriptions 

Method: ConsumerResendActivation

Input (Literal)

The input of this method is the argument ConsumerResendActivation having the structure defined by the following table.

Element  Type 
id  ConsumerId 
moduleKey  string 

Output (Literal)

The output of this method is the argument ConsumerResendActivationResponse having the structure defined by the following table.

Element  Type 
ConsumerResendActivationResult  ResultResendActivation 

Method: ConsumerResetPassword

Input (Literal)

The input of this method is the argument ConsumerResetPassword having the structure defined by the following table.

Element  Type 
username  string 
moduleKey  string 

Output (Literal)

The output of this method is the argument ConsumerResetPasswordResponse having the structure defined by the following table.

Element  Type 
ConsumerResetPasswordResult  ResultConsumerPassword 

Method: ConsumerSubscribe

Input (Literal)

The input of this method is the argument ConsumerSubscribe having the structure defined by the following table.

Element  Type 
id  ConsumerId 
subscriptionKeys  ArrayOfstring 
channel  DeliveryChannel 
moduleKey  string 

Output (Literal)

The output of this method is the argument ConsumerSubscribeResponse having the structure defined by the following table.

Element  Type 
ConsumerSubscribeResult  ResultSubscribe 

Method: ConsumerUnsubscribe

Input (Literal)

The input of this method is the argument ConsumerUnsubscribe having the structure defined by the following table.

Element  Type 
id  ConsumerId 
subscriptionKeys  ArrayOfstring 
channels  DeliveryChannel 
moduleKey  string 

Output (Literal)

The output of this method is the argument ConsumerUnsubscribeResponse having the structure defined by the following table.

Element  Type 
ConsumerUnsubscribeResult  ResultUnsubscribe 

Method: ConsumerUpdate

Input (Literal)

The input of this method is the argument ConsumerUpdate having the structure defined by the following table.

Element  Type 
consumer  Consumer 
lookupMode  IdMode 
subscriptionKeys  ArrayOfstring 
moduleKey  string 

Output (Literal)

The output of this method is the argument ConsumerUpdateResponse having the structure defined by the following table.

Element  Type 
ConsumerUpdateResult  ResultConsumerUpdate 

Method: InteractionInsert

Input (Literal)

The input of this method is the argument InteractionInsert having the structure defined by the following table.

Element  Type 
id  ConsumerId 
moduleKey  string 
eventKey  string 

Output (Literal)

The output of this method is the argument InteractionInsertResponse having the structure defined by the following table.

Element  Type 
InteractionInsertResult  ResultInteractionInsert 

Complex Types: CampaignTaxi

Complex Types

Name 
ArrayOfCustomAttribute 
ArrayOfCustomValue 
ArrayOfdateTime 
ArrayOfDraw 
ArrayOfPrize 
ArrayOfPrizeWon 
ArrayOfstring 
ArrayOfSubscription 
ArrayOfWinner 
CompeitionConsumerDetails 
Competition 
Consumer 
ConsumerId 
CustomAttribute 
CustomValue 
Draw 
Prize 
PrizeWon 
ResultCompetitionConsumerDetails 
ResultCompetitionDetails 
ResultCompetitionEntry 
ResultConfirmActivation 
ResultConsumerAdd 
ResultConsumerAuthenticate 
ResultConsumerDetails 
ResultConsumerPassword 
ResultConsumerUpdate 
ResultCustomAttributes 
ResultInteractionInsert 
ResultResendActivation 
ResultSubscribe 
ResultSubscriptions 
ResultUnsubscribe 
Subscription 
Winner 

Complex Type: ArrayOfCustomAttribute

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
CustomAttribute  CustomAttribute 

Complex Type: ArrayOfCustomValue

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
CustomValue  CustomValue 

Complex Type: ArrayOfdateTime

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
dateTime  dateTime 

Complex Type: ArrayOfDraw

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Draw  Draw 

Complex Type: ArrayOfPrize

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Prize  Prize 

Complex Type: ArrayOfPrizeWon

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
PrizeWon  PrizeWon 

Complex Type: ArrayOfstring

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
string  string 

Complex Type: ArrayOfSubscription

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Subscription  Subscription 

Complex Type: ArrayOfWinner

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Winner  Winner 

Complex Type: CompeitionConsumerDetails

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
EntriesLocalDateTime  ArrayOfdateTime 
PrizesWon  ArrayOfPrizeWon 

Complex Type: Competition

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Draws  ArrayOfDraw 
LocalEndDateTime  dateTime 
LocalStartDateTime  dateTime 
Name  string 

Complex Type: Consumer

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Address1  string 
Address2  string 
City  string 
Country  string 
CustomData  ArrayOfCustomValue 
Email  string 
EngagementScore  double 
ExternalId  string 
FirstName  string 
HomeTel  string 
InternalId  string 
IpAddress  string 
LastName  string 
LocalCreationDate  dateTime 
LocalLastInteraction  dateTime 
LocalLastUpdated  dateTime 
Login  string 
MobileTel  string 
Password  string 
Postcode  string 
State  string 
Suburb  string 
WorkTel  string 

Complex Type: ConsumerId

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Id  string 
IdMode  IdMode 

Complex Type: CustomAttribute

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
AllowedValues  ArrayOfstring 
DataType  DataType 
Key  string 
Name  string 

Complex Type: CustomValue

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Key  string 
Value  string 

Complex Type: Draw

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
LocalEndDateTime  dateTime 
LocalStartDateTime  dateTime 
Name  string 
Prizes  ArrayOfPrize 

Complex Type: Prize

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Name  string 
Winners  ArrayOfWinner 

Complex Type: PrizeWon

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Name  string 
NumerOfPrizesWon  int 

Complex Type: ResultCompetitionConsumerDetails

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Details  CompeitionConsumerDetails 
Message  string 
Status  ResultCompetitionConsumerDetails.StatusCode 

Complex Type: ResultCompetitionDetails

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Competition  Competition 
Message  string 
Status  ResultCompetitionDetails.StatusCode 

Complex Type: ResultCompetitionEntry

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Message  string 
Status  ResultCompetitionEntry.StatusCode 

Complex Type: ResultConfirmActivation

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Message  string 
Status  ResultConfirmActivation.StatusCode 

Complex Type: ResultConsumerAdd

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
InternalId  string 
Message  string 
Status  ResultConsumerAdd.StatusCode 

Complex Type: ResultConsumerAuthenticate

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
InternalId  string 
Message  string 
Status  ResultConsumerAuthenticate.StatusCode 

Complex Type: ResultConsumerDetails

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Consumer  Consumer 
Message  string 
Status  ResultConsumerDetails.StatusCode 

Complex Type: ResultConsumerPassword

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Message  string 
NewPassword  string 
Status  ResultConsumerPassword.StatusCode 

Complex Type: ResultConsumerUpdate

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
InternalId  string 
Message  string 
Status  ResultConsumerUpdate.StatusCode 

Complex Type: ResultCustomAttributes

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
CustomAttributes  ArrayOfCustomAttribute 
Message  string 
Status  ResultCustomAttributes.StatusCode 

Complex Type: ResultInteractionInsert

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Message  string 
Status  ResultInteractionInsert.StatusCode 

Complex Type: ResultResendActivation

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
ActivationCode  string 
Message  string 
Status  ResultResendActivation.StatusCode 

Complex Type: ResultSubscribe

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Message  string 
Status  ResultSubscribe.StatusCode 

Complex Type: ResultSubscriptions

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Message  string 
Status  ResultSubscriptions.StatusCode 
Subscriptions  ArrayOfSubscription 

Complex Type: ResultUnsubscribe

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Message  string 
Status  ResultUnsubscribe.StatusCode 

Complex Type: Subscription

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
DeliveryChannel  DeliveryChannel 
IsActive  boolean 
Name  string 
SubscriptionKey  string 

Complex Type: Winner

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type 
Email  string 
ExternalId  string 
FirstName  string 
InternalId  string 
LastName  string 
NumerOfPrizesWon  int 

Simple Types: CampaignTaxi

Simple Types

Name 
DataType 
DeliveryChannel 
IdMode 

Simple Type: DataType

Derived By

Restricting string

Enumeration

Value 
String 
Number 
DateTime 
Lookup 

Simple Type: DeliveryChannel

Derived By

Restricting string

Enumeration

Value 
Email 
Sms 

Simple Type: IdMode

Derived By

Restricting string

Enumeration

Value 
InternalId 
Email 
ExternalId