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
"use strict";
export class CampaignActionPaymentResponsesDetailView {
    /** @param {{Id?:number,UniqueIdentifier?:string,FirstName?:string,LastName?:string,ContactNumber?:string,Email?:string,InvoiceNumber?:string,AmountOutstanding?:number,AmountPaid?:number,RequestDate?:string,StatusCodesDescription?:string,StatusCodesId?:number,CampaignActionsId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    Id;
    /** @type {string} */
    UniqueIdentifier;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    ContactNumber;
    /** @type {string} */
    Email;
    /** @type {string} */
    InvoiceNumber;
    /** @type {?number} */
    AmountOutstanding;
    /** @type {?number} */
    AmountPaid;
    /** @type {?string} */
    RequestDate;
    /** @type {string} */
    StatusCodesDescription;
    /** @type {?number} */
    StatusCodesId;
    /** @type {?number} */
    CampaignActionsId;
}
export class CampaignActionPaymentDetailsResponse {
    /** @param {{campaignActionInboxResponsesDetailViews?:CampaignActionPaymentResponsesDetailView[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CampaignActionPaymentResponsesDetailView[]} */
    campaignActionInboxResponsesDetailViews;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class CampaignActionPaymentDetailsRequest {
    /** @param {{PublicAccessGuid?:string,CampaignActionsId?:number,PageNumber?:number,PageSize?:number,UniqueIdentifier?:string,FirstName?:string,LastName?:string,ContactNumber?:string,Email?:string,StatusCodesId?:number,InvoiceNumber?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PublicAccessGuid;
    /** @type {number} */
    CampaignActionsId;
    /** @type {number} */
    PageNumber;
    /** @type {number} */
    PageSize;
    /** @type {string} */
    UniqueIdentifier;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    ContactNumber;
    /** @type {string} */
    Email;
    /** @type {?number} */
    StatusCodesId;
    /** @type {string} */
    InvoiceNumber;
}

JavaScript CampaignActionPaymentDetailsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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