digitaluapi

<back to all web services

CampaignCustomersToIncludeAddUpdate

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT POST/customerstoinclude/{CampaignsId}
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class CampaignCustomersToIncludeAddUpdate implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $CampaignsId=0,
        /** @var int[]|null */
        public ?array $CustomersId=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CampaignsId'])) $this->CampaignsId = $o['CampaignsId'];
        if (isset($o['CustomersId'])) $this->CustomersId = JsonConverters::fromArray('int', $o['CustomersId']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CampaignsId)) $o['CampaignsId'] = $this->CampaignsId;
        if (isset($this->CustomersId)) $o['CustomersId'] = JsonConverters::toArray('int', $this->CustomersId);
        return empty($o) ? new class(){} : $o;
    }
}

PHP CampaignCustomersToIncludeAddUpdate 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 /customerstoinclude/{CampaignsId} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CampaignCustomersToIncludeAddUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <CampaignsId>0</CampaignsId>
  <CustomersId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </CustomersId>
</CampaignCustomersToIncludeAddUpdate>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">false</boolean>