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
CampaignActionPaymentDetailsRequest Parameters:
NameParameterData TypeRequiredDescription
PublicAccessGuidpathGuidYes
CampaignActionsIdquerylongYes
PageNumberqueryintNo
PageSizequeryintNo
UniqueIdentifierquerystringNo
FirstNamequerystringNo
LastNamequerystringNo
ContactNumberquerystringNo
EmailquerystringNo
StatusCodesIdquerylong?No
InvoiceNumberquerystringNo
CampaignActionPaymentDetailsResponse Parameters:
NameParameterData TypeRequiredDescription
campaignActionInboxResponsesDetailViewsformList<CampaignActionPaymentResponsesDetailView>No
ResponseStatusformResponseStatusNo
CampaignActionPaymentResponsesDetailView Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
UniqueIdentifierformstringNo
FirstNameformstringNo
LastNameformstringNo
ContactNumberformstringNo
EmailformstringNo
InvoiceNumberformstringNo
AmountOutstandingformdouble?No
AmountPaidformdouble?No
RequestDateformDateTimeOffset?No
StatusCodesDescriptionformstringNo
StatusCodesIdformlong?No
CampaignActionsIdformlong?No

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

HTTP + OTHER

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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}