digitaluapi

<back to all web services

CampaignActionPaymentDetailsRequest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/campaign/responses/payment/{PublicAccessGuid}/Campaign Action Payment Detail Responses
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignActionPaymentResponsesDetailView:
    id: Optional[int] = None
    unique_identifier: Optional[str] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    contact_number: Optional[str] = None
    email: Optional[str] = None
    invoice_number: Optional[str] = None
    amount_outstanding: Optional[float] = None
    amount_paid: Optional[float] = None
    request_date: Optional[datetime.datetime] = None
    status_codes_description: Optional[str] = None
    status_codes_id: Optional[int] = None
    campaign_actions_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignActionPaymentDetailsResponse:
    campaign_action_inbox_responses_detail_views: Optional[List[CampaignActionPaymentResponsesDetailView]] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignActionPaymentDetailsRequest:
    # @Validate(Validator="NotNull")
    public_access_guid: Optional[str] = None

    # @Validate(Validator="NotNull")
    campaign_actions_id: int = 0

    page_number: int = 0
    page_size: int = 0
    unique_identifier: Optional[str] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    contact_number: Optional[str] = None
    email: Optional[str] = None
    status_codes_id: Optional[int] = None
    invoice_number: Optional[str] = None

Python CampaignActionPaymentDetailsRequest 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.

GET /campaign/responses/payment/{PublicAccessGuid}/ HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	campaignActionInboxResponsesDetailViews: 
	[
		{
			Id: 0,
			UniqueIdentifier: String,
			FirstName: String,
			LastName: String,
			ContactNumber: String,
			Email: String,
			InvoiceNumber: String,
			AmountOutstanding: 0,
			AmountPaid: 0,
			RequestDate: 0001-01-01T00:00:00.0000000+00:00,
			StatusCodesDescription: String,
			StatusCodesId: 0,
			CampaignActionsId: 0
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}