digitaluapi

<back to all web services

StartCampaign

The following routes are available for this service:
POST/campaign/start/{PublicAccessGuid}Start Campaign
import 'package:servicestack/servicestack.dart';

class StartCampaignResponse implements IConvertible
{
    String? Status;
    ResponseStatus? ResponseStatus;

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

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

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

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

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

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

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

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

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

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

Dart StartCampaign DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	Status: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}