digitaluapi

<back to all web services

ArchiveCampaign

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/campaign/archive/{PublicAccessGuid}Archive Campaign
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

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

    public static class ArchiveCampaignResponse
    {
        public Boolean Success = null;
        public ResponseStatus ResponseStatus = null;
        
        public Boolean isSuccess() { return Success; }
        public ArchiveCampaignResponse setSuccess(Boolean value) { this.Success = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ArchiveCampaignResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java ArchiveCampaign DTOs

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

HTTP + CSV

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

POST /campaign/archive/{PublicAccessGuid} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"PublicAccessGuid":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Success":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}