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
namespace digitaluapi.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CampaignActionPaymentResponsesDetailView() = 
        [<DataMember(Order=1)>]
        member val Id:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember(Order=2)>]
        member val UniqueIdentifier:String = null with get,set

        [<DataMember(Order=3)>]
        member val FirstName:String = null with get,set

        [<DataMember(Order=4)>]
        member val LastName:String = null with get,set

        [<DataMember(Order=5)>]
        member val ContactNumber:String = null with get,set

        [<DataMember(Order=6)>]
        member val Email:String = null with get,set

        [<DataMember(Order=7)>]
        member val InvoiceNumber:String = null with get,set

        [<DataMember(Order=8)>]
        member val AmountOutstanding:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember(Order=9)>]
        member val AmountPaid:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember(Order=10)>]
        member val RequestDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set

        [<DataMember(Order=11)>]
        member val StatusCodesDescription:String = null with get,set

        [<DataMember(Order=12)>]
        member val StatusCodesId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember(Order=13)>]
        member val CampaignActionsId:Nullable<Int64> = new Nullable<Int64>() with get,set

    [<AllowNullLiteral>]
    type CampaignActionPaymentDetailsResponse() = 
        member val campaignActionInboxResponsesDetailViews:ResizeArray<CampaignActionPaymentResponsesDetailView> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type CampaignActionPaymentDetailsRequest() = 
        [<Validate(Validator="NotNull")>]
        member val PublicAccessGuid:Guid = new Guid() with get,set

        [<Validate(Validator="NotNull")>]
        member val CampaignActionsId:Int64 = new Int64() with get,set

        member val PageNumber:Int32 = new Int32() with get,set
        member val PageSize:Int32 = new Int32() with get,set
        member val UniqueIdentifier:String = null with get,set
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set
        member val ContactNumber:String = null with get,set
        member val Email:String = null with get,set
        member val StatusCodesId:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val InvoiceNumber:String = null with get,set

F# 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"}}}