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

export class CampaignActionPaymentResponsesDetailView
{
    // @DataMember(Order=1)
    public Id?: number;

    // @DataMember(Order=2)
    public UniqueIdentifier: string;

    // @DataMember(Order=3)
    public FirstName: string;

    // @DataMember(Order=4)
    public LastName: string;

    // @DataMember(Order=5)
    public ContactNumber: string;

    // @DataMember(Order=6)
    public Email: string;

    // @DataMember(Order=7)
    public InvoiceNumber: string;

    // @DataMember(Order=8)
    public AmountOutstanding?: number;

    // @DataMember(Order=9)
    public AmountPaid?: number;

    // @DataMember(Order=10)
    public RequestDate?: string;

    // @DataMember(Order=11)
    public StatusCodesDescription: string;

    // @DataMember(Order=12)
    public StatusCodesId?: number;

    // @DataMember(Order=13)
    public CampaignActionsId?: number;

    public constructor(init?: Partial<CampaignActionPaymentResponsesDetailView>) { (Object as any).assign(this, init); }
}

export class CampaignActionPaymentDetailsResponse
{
    public campaignActionInboxResponsesDetailViews: CampaignActionPaymentResponsesDetailView[];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<CampaignActionPaymentDetailsResponse>) { (Object as any).assign(this, init); }
}

export class CampaignActionPaymentDetailsRequest
{
    // @Validate(Validator="NotNull")
    public PublicAccessGuid: string;

    // @Validate(Validator="NotNull")
    public CampaignActionsId: number;

    public PageNumber: number;
    public PageSize: number;
    public UniqueIdentifier: string;
    public FirstName: string;
    public LastName: string;
    public ContactNumber: string;
    public Email: string;
    public StatusCodesId?: number;
    public InvoiceNumber: string;

    public constructor(init?: Partial<CampaignActionPaymentDetailsRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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"}}}