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 'package:servicestack/servicestack.dart';
import 'dart:collection';

class ArchiveCampaignResponse implements IConvertible
{
    bool? Success;
    ResponseStatus? ResponseStatus;

    ArchiveCampaignResponse({this.Success,this.ResponseStatus});
    ArchiveCampaignResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Success = json['Success'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Success': Success,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "ArchiveCampaignResponse";
    TypeContext? context = _ctx;
}

class ArchiveCampaign implements IConvertible
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    String? PublicAccessGuid;

    ArchiveCampaign({this.PublicAccessGuid});
    ArchiveCampaign.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        PublicAccessGuid = json['PublicAccessGuid'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'PublicAccessGuid': PublicAccessGuid
    };

    getTypeName() => "ArchiveCampaign";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'duengageapi.uat.scadsoftware.com', types: <String, TypeInfo> {
    'ArchiveCampaignResponse': TypeInfo(TypeOf.Class, create:() => ArchiveCampaignResponse()),
    'ArchiveCampaign': TypeInfo(TypeOf.Class, create:() => ArchiveCampaign()),
});

Dart 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"}}}