These requests retrieve personal information.
Personal Information
This request provides the personal information fields; it works with Subscriber Personal Information to get values for a subscriber.
| Data Element | Type | Length | Conditional | Description |
|---|---|---|---|---|
| Count | Int | False | Unique count | |
| length_in_characters | Int | True | Characters allowed | |
| default_value | String | 50 | False | Default value |
| is_deleted | Int | False | True/False | |
| Description | String | 50 | False | Description |
| end_year | String | 50 | False | Ending year (for date type) |
| is_date | Int | False | True/False | |
| personal_information_id | Int | True | Unique ID | |
| is_hidden | Int | False | Is this hidden? | |
| is_mobile_phone | Int | False | True/False | |
| is_numeric | Int | False | True/False | |
| is_phone | String | 50 | False | Is this a phone type? |
| minimum_length | Int | False | Minimum length | |
| Name | String | 50 | True | Name |
| is_proper_case | Int | False | Enforce proper case? | |
| is_required | Int | False | Is required? | |
| start_year | String | 4 | False | Starting Year |
| personal_information_type_id | Int | True | Unique ID of the personal info field |
Request
<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
<Brand id="0">Test</Brand>
<User></User>
<Grids>
<Grid type="subscriber_personal_information">
<ReturnFields>
<DataElement>personal_information_value</DataElement>
<DataElement>personal_information_id</DataElement>
<DataElement>personal_information_name</DataElement>
<DataElement>subscriber_personal_information_id</DataElement>
</ReturnFields>
</Grid>
</Grids>
</GridRequest>
Subscriber Personal Information
Provides subscriber personalization information for a subscriber.
| Data Element | Type | Length | Conditional | Description |
|---|---|---|---|---|
| Count | Int | False | Number of matches based on criteria | |
| String | 100 | True | Subscriber email address | |
| Subscriber_personal_information_ID | Int | True | Unique Subscriber Personal Information ID | |
| subscriber_id | Int | True | Unique Subscriber ID | |
| Cancellation_type_id | Int | True | Cancellation ID when unsubscribed | |
| Cancellation_type_description | String | 255 | True | Description of cancellation reason |
| Personal_information_ID | Int | True | Personal Information ID | |
| Personal_Information_Name | String | 255 | True | Personal Information Name |
| Personal_Information_Value | String | 1000 | True | Personal Information Value |
| user_id | Int | True | Unique remote ID |
Request
<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
<Brand id="0">Test</Brand>
<User></User>
<Grids>
<Grid type="subscriber_personal_information">
<ReturnFields>
<DataElement>personal_information_value</DataElement>
<DataElement>personal_information_id</DataElement>
<DataElement>personal_information_name</DataElement>
<DataElement>subscriber_personal_information_id</DataElement>
</ReturnFields>
</Grid>
</Grids>
</GridRequest>
Persona
This document returns persona information.
| Data Element | Type | Length | Conditional | Description |
|---|---|---|---|---|
| subscriber_email | String | -1 | True | Subscriber Email Address |
| subscriber_id | Int | True | Unique Subscriber ID | |
| remote_id | String | 50 | True | Subscriber ID for the remote system |
| type_id | Int | True | Unique Score Type ID | |
| type_name | String | 255 | True | Score type name |
| description | String | 2000 | True | Score name |
| score_id | Int | True | Score description |
Request
<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/"> <Password>password</Password>
<Brand id="9999">Test Brand</Brand>
<User></User>
<Grids>
<Grid type="subscriber_persona">
<Conditions>
<Condition>
<Single>
<DataElement>subscriber_id</DataElement>
<DataValue>500970706</DataValue>
<Comparator>EQ</Comparator>
</Single>
</Condition>
</Conditions>
<ReturnFields>
<DataElement>subscriber_email</DataElement>
<DataElement>subscriber_id</DataElement>
<DataElement>remote_id</DataElement>
<DataElement>type_id</DataElement>
<DataElement>type_name</DataElement>
<DataElement>description</DataElement>
<DataElement>score_id</DataElement>
</ReturnFields>
</Grid>
</Grids>
</GridRequest>
Response
<?xml version="1.0" encoding="utf-8"?>
<GridResponse xmlns="http://partner.informz.net/aapi/2009/08/">
<Brand id="9999">Test Brand</Brand>
<User></User>
<Grids>
<Grid type="subscriber_persona">
<Record row="1">
<Fields>
<Field element="subscriber_email">crazyladydeb@juno.com</Field>
<Field element="subscriber_id">500970706</Field>
<Field element="remote_id" />
<Field element="type_id">2</Field>
<Field element="type_name">Persona</Field>
<Field element="description">Subscribers who do not match another Persona Type</Field>
<Field element="score_id">12241</Field>
</Fields>
</Record>
</Grid>
</Grids>
</GridResponse>