digitaluapi

<back to all web services

CampaignCustomerVerificationsRequest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/campaign/verifications/{PublicAccessGuid}/Campaign Verification Responses
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using digitaluapi.ServiceModel;
using digitaluapi.ServiceModel.Types;

namespace digitaluapi.ServiceModel
{
    public partial class CampaignCustomerVerificationsRequest
    {
        [Validate("NotNull")]
        public virtual Guid PublicAccessGuid { get; set; }

        public virtual int PageNumber { get; set; }
        public virtual int PageSize { get; set; }
        public virtual string UniqueIdentifier { get; set; }
        public virtual string FirstName { get; set; }
        public virtual string LastName { get; set; }
        public virtual string ContactNumber { get; set; }
        public virtual string Email { get; set; }
        public virtual long? StatusCodesId { get; set; }
    }

    public partial class CampaignCustomerVerificationsResponse
    {
        public virtual List<CampaignCustomerVerificationsDetailView> campaignCustomerVerificationsDetailView { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace digitaluapi.ServiceModel.Types
{
    public partial class CampaignCustomerVerificationsDetailView
    {
        [DataMember(Order=1)]
        public virtual long? Id { get; set; }

        [DataMember(Order=2)]
        public virtual int? CurrenciesId { get; set; }

        [DataMember(Order=3)]
        public virtual string CurrencyName { get; set; }

        [DataMember(Order=4)]
        public virtual string Address { get; set; }

        [DataMember(Order=5)]
        public virtual int? Age { get; set; }

        [DataMember(Order=6)]
        public virtual string City { get; set; }

        [DataMember(Order=7)]
        public virtual string ContactNumber { get; set; }

        [DataMember(Order=8)]
        public virtual string Email { get; set; }

        [DataMember(Order=9)]
        public virtual string EthnicGroup { get; set; }

        [DataMember(Order=10)]
        public virtual string FirstName { get; set; }

        [DataMember(Order=11)]
        public virtual string Gender { get; set; }

        [DataMember(Order=12)]
        public virtual string HomeLanguage { get; set; }

        [DataMember(Order=13)]
        public virtual string IdNumber { get; set; }

        [DataMember(Order=14)]
        public virtual string LastName { get; set; }

        [DataMember(Order=15)]
        public virtual string PostalCode { get; set; }

        [DataMember(Order=16)]
        public virtual string Region { get; set; }

        [DataMember(Order=17)]
        public virtual string Suburb { get; set; }

        [DataMember(Order=18)]
        public virtual string UniqueIdentifier { get; set; }

        [DataMember(Order=19)]
        public virtual DateTime? BirthDate { get; set; }

        [DataMember(Order=20)]
        public virtual string Country { get; set; }

        [DataMember(Order=21)]
        public virtual string PassportNumber { get; set; }

        [DataMember(Order=22)]
        public virtual string UpdatedAddress { get; set; }

        [DataMember(Order=23)]
        public virtual int? UpdatedAge { get; set; }

        [DataMember(Order=24)]
        public virtual string UpdatedCity { get; set; }

        [DataMember(Order=25)]
        public virtual string UpdatedContactNumber { get; set; }

        [DataMember(Order=26)]
        public virtual string UpdatedEmail { get; set; }

        [DataMember(Order=27)]
        public virtual string UpdatedEthnicGroup { get; set; }

        [DataMember(Order=28)]
        public virtual string UpdatedFirstName { get; set; }

        [DataMember(Order=29)]
        public virtual string UpdatedGender { get; set; }

        [DataMember(Order=30)]
        public virtual string UpdatedHomeLanguage { get; set; }

        [DataMember(Order=31)]
        public virtual string UpdatedIdNumber { get; set; }

        [DataMember(Order=32)]
        public virtual string UpdatedLastName { get; set; }

        [DataMember(Order=33)]
        public virtual string UpdatedPostalCode { get; set; }

        [DataMember(Order=34)]
        public virtual string UpdatedRegion { get; set; }

        [DataMember(Order=35)]
        public virtual string UpdatedSuburb { get; set; }

        [DataMember(Order=36)]
        public virtual string UpdatedUniqueIdentifier { get; set; }

        [DataMember(Order=37)]
        public virtual DateTime? UpdatedBirthDate { get; set; }

        [DataMember(Order=38)]
        public virtual string UpdatedCountry { get; set; }

        [DataMember(Order=39)]
        public virtual string UpdatedPassportNumber { get; set; }

        [DataMember(Order=40)]
        public virtual long? StatusCodesId { get; set; }

        [DataMember(Order=41)]
        public virtual string StatusCodesDescription { get; set; }

        [DataMember(Order=42)]
        public virtual string Reason { get; set; }

        [DataMember(Order=43)]
        public virtual long? CustomersId { get; set; }

        [DataMember(Order=44)]
        public virtual long? CampaignsId { get; set; }

        [DataMember(Order=45)]
        public virtual DateTimeOffset? CapturedDate { get; set; }

        [DataMember(Order=46)]
        public virtual string UpdatedIdUrl { get; set; }

        [DataMember(Order=47)]
        public virtual string UpdatedPassportUrl { get; set; }

        [DataMember(Order=48)]
        public virtual string UpdatedAddressUrl { get; set; }

        [DataMember(Order=49)]
        public virtual Guid? CampaignPublicAccessGuid { get; set; }
    }

}

C# CampaignCustomerVerificationsRequest 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.

GET /campaign/verifications/{PublicAccessGuid}/ HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CampaignCustomerVerificationsResponse 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>
  <campaignCustomerVerificationsDetailView xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
    <d2p1:CampaignCustomerVerificationsDetailView>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:Age>0</d2p1:Age>
      <d2p1:BirthDate>0001-01-01T00:00:00</d2p1:BirthDate>
      <d2p1:CampaignPublicAccessGuid>00000000-0000-0000-0000-000000000000</d2p1:CampaignPublicAccessGuid>
      <d2p1:CampaignsId>0</d2p1:CampaignsId>
      <d2p1:CapturedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:CapturedDate>
      <d2p1:City>String</d2p1:City>
      <d2p1:ContactNumber>String</d2p1:ContactNumber>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:CurrenciesId>0</d2p1:CurrenciesId>
      <d2p1:CurrencyName>String</d2p1:CurrencyName>
      <d2p1:CustomersId>0</d2p1:CustomersId>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:EthnicGroup>String</d2p1:EthnicGroup>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:Gender>String</d2p1:Gender>
      <d2p1:HomeLanguage>String</d2p1:HomeLanguage>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IdNumber>String</d2p1:IdNumber>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:PassportNumber>String</d2p1:PassportNumber>
      <d2p1:PostalCode>String</d2p1:PostalCode>
      <d2p1:Reason>String</d2p1:Reason>
      <d2p1:Region>String</d2p1:Region>
      <d2p1:StatusCodesDescription>String</d2p1:StatusCodesDescription>
      <d2p1:StatusCodesId>0</d2p1:StatusCodesId>
      <d2p1:Suburb>String</d2p1:Suburb>
      <d2p1:UniqueIdentifier>String</d2p1:UniqueIdentifier>
      <d2p1:UpdatedAddress>String</d2p1:UpdatedAddress>
      <d2p1:UpdatedAddressUrl>String</d2p1:UpdatedAddressUrl>
      <d2p1:UpdatedAge>0</d2p1:UpdatedAge>
      <d2p1:UpdatedBirthDate>0001-01-01T00:00:00</d2p1:UpdatedBirthDate>
      <d2p1:UpdatedCity>String</d2p1:UpdatedCity>
      <d2p1:UpdatedContactNumber>String</d2p1:UpdatedContactNumber>
      <d2p1:UpdatedCountry>String</d2p1:UpdatedCountry>
      <d2p1:UpdatedEmail>String</d2p1:UpdatedEmail>
      <d2p1:UpdatedEthnicGroup>String</d2p1:UpdatedEthnicGroup>
      <d2p1:UpdatedFirstName>String</d2p1:UpdatedFirstName>
      <d2p1:UpdatedGender>String</d2p1:UpdatedGender>
      <d2p1:UpdatedHomeLanguage>String</d2p1:UpdatedHomeLanguage>
      <d2p1:UpdatedIdNumber>String</d2p1:UpdatedIdNumber>
      <d2p1:UpdatedIdUrl>String</d2p1:UpdatedIdUrl>
      <d2p1:UpdatedLastName>String</d2p1:UpdatedLastName>
      <d2p1:UpdatedPassportNumber>String</d2p1:UpdatedPassportNumber>
      <d2p1:UpdatedPassportUrl>String</d2p1:UpdatedPassportUrl>
      <d2p1:UpdatedPostalCode>String</d2p1:UpdatedPostalCode>
      <d2p1:UpdatedRegion>String</d2p1:UpdatedRegion>
      <d2p1:UpdatedSuburb>String</d2p1:UpdatedSuburb>
      <d2p1:UpdatedUniqueIdentifier>String</d2p1:UpdatedUniqueIdentifier>
    </d2p1:CampaignCustomerVerificationsDetailView>
  </campaignCustomerVerificationsDetailView>
</CampaignCustomerVerificationsResponse>