GET /external/api/v3/customer/getbouncers
Get a list of bouncers.
Request Information
URI Parameters
Name | Description | Type | Additional information | Nullable |
---|---|---|---|---|
TransactionDateFilter |
Filter on the transaction date. |
DateFilter |
None |
False |
IncludeTestRecords |
Include test records. |
boolean |
None |
False |
DataFilters |
Filter on data. |
Collection of CustomerDataFilter |
None |
False |
Cursor |
Token to retrieve the next set of data. Token can be found in the NextCursor property of the result. Leave empty for the first cursor. |
string |
None |
False |
Limit |
Total requested. Max and default are set at 100. |
integer |
None |
False |
Body Parameters
None.
Response Information
Resource Description
List of bounced customers.
GetBouncedCustomersResponseName | Description | Type | Additional information | Nullable |
---|---|---|---|---|
Bouncers | Collection of BouncedCustomer |
None |
False | |
NextCursor |
Token to retrieve the next set of customers - Add token to the Cursor property of the request. |
string |
None |
False |
Response Formats
application/json, text/json
Sample:
{ "Bouncers": [ { "Reason": "sample string 1", "Exception": "sample string 2", "CustomerStatus": "sample string 3", "DateSent": "2024-12-07T17:41:24.6654094+01:00", "DateReminded": "2024-12-07T17:41:24.6654094+01:00", "Email": "sample string 4", "TransactionDate": "2024-12-07T17:41:24.6654094+01:00", "SurveyClosedDate": "2024-12-07T17:41:24.6654094+01:00", "Data": [ { "CustomerDataColumnId": 1, "Name": "sample string 2", "Value": "sample string 3", "IsEncrypted": true, "CertificateThumbprint": "sample string 5", "EncryptionKey": "sample string 6" }, { "CustomerDataColumnId": 1, "Name": "sample string 2", "Value": "sample string 3", "IsEncrypted": true, "CertificateThumbprint": "sample string 5", "EncryptionKey": "sample string 6" } ], "Language": "sample string 5", "IsContactRequested": true, "IsConcept": true }, { "Reason": "sample string 1", "Exception": "sample string 2", "CustomerStatus": "sample string 3", "DateSent": "2024-12-07T17:41:24.6654094+01:00", "DateReminded": "2024-12-07T17:41:24.6654094+01:00", "Email": "sample string 4", "TransactionDate": "2024-12-07T17:41:24.6654094+01:00", "SurveyClosedDate": "2024-12-07T17:41:24.6654094+01:00", "Data": [ { "CustomerDataColumnId": 1, "Name": "sample string 2", "Value": "sample string 3", "IsEncrypted": true, "CertificateThumbprint": "sample string 5", "EncryptionKey": "sample string 6" }, { "CustomerDataColumnId": 1, "Name": "sample string 2", "Value": "sample string 3", "IsEncrypted": true, "CertificateThumbprint": "sample string 5", "EncryptionKey": "sample string 6" } ], "Language": "sample string 5", "IsContactRequested": true, "IsConcept": true } ], "NextCursor": "sample string 1" }
application/xml, text/xml
Sample:
<GetBouncedCustomersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V2.Responses"> <NextCursor xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Domain.Shared.Responses">sample string 1</NextCursor> <Bouncers xmlns:d2p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models"> <d2p1:BouncedCustomer> <d2p1:Data> <d2p1:CustomerData> <d2p1:CertificateThumbprint>sample string 5</d2p1:CertificateThumbprint> <d2p1:CustomerDataColumnId>1</d2p1:CustomerDataColumnId> <d2p1:EncryptionKey>sample string 6</d2p1:EncryptionKey> <d2p1:IsEncrypted>true</d2p1:IsEncrypted> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Value>sample string 3</d2p1:Value> </d2p1:CustomerData> <d2p1:CustomerData> <d2p1:CertificateThumbprint>sample string 5</d2p1:CertificateThumbprint> <d2p1:CustomerDataColumnId>1</d2p1:CustomerDataColumnId> <d2p1:EncryptionKey>sample string 6</d2p1:EncryptionKey> <d2p1:IsEncrypted>true</d2p1:IsEncrypted> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Value>sample string 3</d2p1:Value> </d2p1:CustomerData> </d2p1:Data> <d2p1:Email>sample string 4</d2p1:Email> <d2p1:IsConcept>true</d2p1:IsConcept> <d2p1:IsContactRequested>true</d2p1:IsContactRequested> <d2p1:Language>sample string 5</d2p1:Language> <d2p1:SurveyClosedDate>2024-12-07T17:41:24.6654094+01:00</d2p1:SurveyClosedDate> <d2p1:TransactionDate>2024-12-07T17:41:24.6654094+01:00</d2p1:TransactionDate> <d2p1:CustomerStatus>sample string 3</d2p1:CustomerStatus> <d2p1:DateReminded>2024-12-07T17:41:24.6654094+01:00</d2p1:DateReminded> <d2p1:DateSent>2024-12-07T17:41:24.6654094+01:00</d2p1:DateSent> <d2p1:Exception>sample string 2</d2p1:Exception> <d2p1:Reason>sample string 1</d2p1:Reason> </d2p1:BouncedCustomer> <d2p1:BouncedCustomer> <d2p1:Data> <d2p1:CustomerData> <d2p1:CertificateThumbprint>sample string 5</d2p1:CertificateThumbprint> <d2p1:CustomerDataColumnId>1</d2p1:CustomerDataColumnId> <d2p1:EncryptionKey>sample string 6</d2p1:EncryptionKey> <d2p1:IsEncrypted>true</d2p1:IsEncrypted> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Value>sample string 3</d2p1:Value> </d2p1:CustomerData> <d2p1:CustomerData> <d2p1:CertificateThumbprint>sample string 5</d2p1:CertificateThumbprint> <d2p1:CustomerDataColumnId>1</d2p1:CustomerDataColumnId> <d2p1:EncryptionKey>sample string 6</d2p1:EncryptionKey> <d2p1:IsEncrypted>true</d2p1:IsEncrypted> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Value>sample string 3</d2p1:Value> </d2p1:CustomerData> </d2p1:Data> <d2p1:Email>sample string 4</d2p1:Email> <d2p1:IsConcept>true</d2p1:IsConcept> <d2p1:IsContactRequested>true</d2p1:IsContactRequested> <d2p1:Language>sample string 5</d2p1:Language> <d2p1:SurveyClosedDate>2024-12-07T17:41:24.6654094+01:00</d2p1:SurveyClosedDate> <d2p1:TransactionDate>2024-12-07T17:41:24.6654094+01:00</d2p1:TransactionDate> <d2p1:CustomerStatus>sample string 3</d2p1:CustomerStatus> <d2p1:DateReminded>2024-12-07T17:41:24.6654094+01:00</d2p1:DateReminded> <d2p1:DateSent>2024-12-07T17:41:24.6654094+01:00</d2p1:DateSent> <d2p1:Exception>sample string 2</d2p1:Exception> <d2p1:Reason>sample string 1</d2p1:Reason> </d2p1:BouncedCustomer> </Bouncers> </GetBouncedCustomersResponse>
Response Status Codes
Status Code | Name | Description |
---|---|---|
200 | OK | The request has succeeded. |
400 | Bad Request | Fulfilling the request would cause an invalid state. Request needs modification. |
401 | Unauthorized | Missing or invalid authentication token. |
403 | Forbidden | Server refuses to authorize the request. |
408 | Request Timeout | The server timed out waiting for the request. |
429 | Too Many Requests | Too many requests in a given amount of time. |
500 | Internal Server Error | The server encountered an unexpected condition which prevented it from fulfilling the request. |
503 | Service Unavailable | The server is unable to proces the request at the moment, try again later. |