digitaluapi

<back to all web services

StartCampaign

The following routes are available for this service:
POST/campaign/start/{PublicAccessGuid}Start Campaign
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class StartCampaign
    {
        @DataMember(Order=2)
        @Validate(Validator="NotNull")
        public UUID PublicAccessGuid = null;
        
        public UUID getPublicAccessGuid() { return PublicAccessGuid; }
        public StartCampaign setPublicAccessGuid(UUID value) { this.PublicAccessGuid = value; return this; }
    }

    public static class StartCampaignResponse
    {
        public String Status = null;
        public ResponseStatus ResponseStatus = null;
        
        public String getStatus() { return Status; }
        public StartCampaignResponse setStatus(String value) { this.Status = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public StartCampaignResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java StartCampaign DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /campaign/start/{PublicAccessGuid} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StartCampaign xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <PublicAccessGuid>00000000-0000-0000-0000-000000000000</PublicAccessGuid>
</StartCampaign>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StartCampaignResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Status>String</Status>
</StartCampaignResponse>