Make a request ยป

SubscriberService.GetAllSubscribers

Get all Subscribers in this account (Queued) See code examples


URL Parameters

Http verb: POST
URI: Full url: http://se.api.anpasia.com/v1/subscribers/all
URL parameters:
Not used

Body parameters

Body parameters
source
The details about what demographic data to return

AllDemographics Boolean True if we should return all the demographic data fields
FieldNames List
<String>		 List of fieldnames if we only want to retrieve a limited set of demographic data fields
Body Example

{
    "AllDemographics": false,
    "FieldNames": [
        "Address",
        "ZipCode",
        "City",
        "Age"
    ]
}
<DemographicData xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AllDemographics>false</AllDemographics>
  <FieldNames xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <a:string>Address</a:string>
    <a:string>ZipCode</a:string>
    <a:string>City</a:string>
    <a:string>Age</a:string>
  </FieldNames>
</DemographicData>
                

Response

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

Code Int32 The response Code.
Message String The response Message.
Result
The response Result.

OperationGuid Guid ID of this operation
PollURL String The URL to poll for the status of this operation
Body Example


{
    "Code": 1,
    "Message": "OK",
    "Result": {
        "OperationGuid": "14dfc699-636a-4baf-b517-1651eb7da30f",
        "PollURL": "http:\/\/se.api.anpdm.com\/v1\/xxxxxxx.json"
    }
}
<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Code>1</Code>
  <Message>OK</Message>
  <Result>
    <OperationGuid>6289eaa4-613a-460e-a073-30573f574392</OperationGuid>
    <PollURL>http://se.api.anpdm.com/v1/xxxxxxx.xml</PollURL>
  </Result>
</Response>
                

Help

Code examples


curl -i -X POST
-H 'Content-type: application/json'
-H 'Accept: application/json' 
-H 'Authorization: basic $api_key_64baseformat'
-d '{
    "AllDemographics": false,
    "FieldNames": [
        "Address",
        "ZipCode",
        "City",
        "Age"
    ]
}'
url http://se.api.anpasia.com/v1/subscribers/all