digitaluapi

<back to all web services

PauseCampaign

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/campaign/pause/{PublicAccessGuid}Pause Campaign
import 'package:servicestack/servicestack.dart';
import 'dart:collection';

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

    PauseCampaignResponse({this.Success,this.ResponseStatus});
    PauseCampaignResponse.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() => "PauseCampaignResponse";
    TypeContext? context = _ctx;
}

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

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

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

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

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

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

Dart PauseCampaign 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/pause/{PublicAccessGuid} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PauseCampaign 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>
</PauseCampaign>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PauseCampaignResponse 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>
  <Success>false</Success>
</PauseCampaignResponse>