Make a request ยป

OptOutService.GetOptOutAllByDateIntervalPaginated

Get global optout list for an account between dates. (Paginated) See code examples


URL Parameters

Http verb: Get
URI: Full url: http://se.api.anpasia.com/optouts/v2/global/{startDateStr}/{endDateStr}/{pageNumber}/{pageSize}
URL parameters:
startDateStrStringThe start of the date interval. Format YYYYMMDDTHHMMSS
endDateStrStringThe end date of the interval. Format YYYYMMDDTHHMMSS
pageNumberStringThe page in the resultset to return, starts with 1
pageSizeStringThe size of each page resultset, minimum 1

Body parameters

Body parameters
Not used

Response

Body parameters
returns
A response object which includes the paginated result, status code and a message.

Code Int32 The response Code.
Message String The response Message.
OptOutAllItem
OptOutAll item

Id Int64 Id of the Optoutall
Email String The Email
Reason String The reason for the opt out
MailingListId Nullable<Int32> The mailinglist which the optout was made from
SendQueueId Nullable<Int32> The Sendqueueid which the opt out was madee from
Created DateTime The date when the opt out was created
Name String The Name
Format String The format
ExternalId String The externalId
CountryCode String The countrycode
PhoneNumber String The phoneNumber
SubscriberId Int64 The subscriberId
Body Example


{
    "Code": 1,
    "Message": "OK",
    "Result": {
        "TotalCount": 1,
        "TotalPages": 1,
        "Items": [
            {
                "CountryCode": "46",
                "Created": "\/Date(1015286583000+0800)\/",
                "Email": "noreply@apsis.com",
                "ExternalId": "externalId",
                "Format": "Html",
                "Id": 456,
                "MailingListId": 456,
                "Name": "Patrik",
                "PhoneNumber": "555-456",
                "Reason": "Hard Bounce",
                "SendQueueId": 456,
                "SubscriberId": 456
            }
        ]
    }
}
<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Code>1</Code>
  <Message>OK</Message>
  <Result>
    <TotalCount>1</TotalCount>
    <TotalPages>1</TotalPages>
    <Items>
      <OptOutAllItem>
        <CountryCode>46</CountryCode>
        <Created>2002-03-05T08:03:03</Created>
        <Email>noreply@apsis.com</Email>
        <ExternalId>externalId</ExternalId>
        <Format>Html</Format>
        <Id>456</Id>
        <MailingListId>456</MailingListId>
        <Name>Patrik</Name>
        <PhoneNumber>555-456</PhoneNumber>
        <Reason>Hard Bounce</Reason>
        <SendQueueId>456</SendQueueId>
        <SubscriberId>456</SubscriberId>
      </OptOutAllItem>
    </Items>
  </Result>
</Response>
                

Help

Code examples


curl -i -X GET
-H 'Content-type: application/json'
-H 'Accept: application/json' 
-H 'Authorization: basic $api_key_64baseformat'
url http://se.api.anpasia.com/optouts/v2/global/{startDateStr}/{endDateStr}/{pageNumber}/{pageSize}