digitaluapi

<back to all web services

CampaignActionInboxDetailsRequest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/campaign/responses/inbox/{PublicAccessGuid}/Campaign Action Inbox Detail Responses
CampaignActionInboxDetailsRequest Parameters:
NameParameterData TypeRequiredDescription
PublicAccessGuidpathGuidYes
CampaignActionsIdquerylongYes
PageNumberqueryintNo
PageSizequeryintNo
UniqueIdentifierquerystringNo
FirstNamequerystringNo
LastNamequerystringNo
ContactNumberquerystringNo
EmailquerystringNo
StatusCodesIdquerylong?No
CampaignActionInboxDetailsResponse Parameters:
NameParameterData TypeRequiredDescription
campaignActionInboxResponsesDetailViewsformList<CampaignActionInboxResponsesDetailView>No
ResponseStatusformResponseStatusNo
CampaignActionInboxResponsesDetailView Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
UniqueIdentifierformstringNo
FirstNameformstringNo
LastNameformstringNo
ContactNumberformstringNo
EmailformstringNo
ActionTimestampformDateTimeOffset?No
StatusCodesDescriptionformstringNo
StatusCodesIdformlong?No
CampaignActionsIdformlong?No

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

<CampaignActionInboxDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <campaignActionInboxResponsesDetailViews xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
    <d2p1:CampaignActionInboxResponsesDetailView>
      <d2p1:ActionTimestamp xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:ActionTimestamp>
      <d2p1:CampaignActionsId>0</d2p1:CampaignActionsId>
      <d2p1:ContactNumber>String</d2p1:ContactNumber>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:StatusCodesDescription>String</d2p1:StatusCodesDescription>
      <d2p1:StatusCodesId>0</d2p1:StatusCodesId>
      <d2p1:UniqueIdentifier>String</d2p1:UniqueIdentifier>
    </d2p1:CampaignActionInboxResponsesDetailView>
  </campaignActionInboxResponsesDetailViews>
</CampaignActionInboxDetailsResponse>