Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

A person can also be tracked/linked by a Phone Number (MDN). This alternate identifier is usually sufficient in the short term but is not an ideal identification long term as Phone Numbers can be changed, returned, ported and recycled.

Contents 

Page Tree
root@self
startDepth1

Associating Person Records

...

This is the JSON representation of a Person entity within the APIs.

Code Block

{
   "person_id":"AB3423",
   "external_person_id":"542342",
   "mobile_phone":{
      "mdn":"2995551234",
      "carrier_code":"104"
   },
   "custom_fields":{
      "first_name":"Steve",
      "birthdate":"1950-12-01T00:00:00Z",
      "rewards_id":"543557654",
      "favorite_stores":[
         {
            "id":"4",
            "name":"My Hardware Store"
         },
         {
            "id":"12",
            "name":"Local Grocery"
         }
      ]
   },
   "created_at":"2012-04-05T14:30Z",
   "updated_at":"2012-05-08T19:30Z",
   "url":"/companies/:id/mobiledb/persons/:person_id"
}

...

Data Element

Type

Description

person_id

String

Vibes unique identifier for each person record in the Mobile Database.

external_person_id

String

Customer's unique identifier for a person in the Mobile Database. This value is optional, but if specified, must be unique within the Mobile Database.

mobile_phone

Object

Object representation of a Person's mobile phone. A person can have only one active Mobile Phone at a time.

mobile_phone.mdn

String

The Mobile Directory Number (dialable number)

mobile_phone.carrier_code

String

The Cellular Carrier associated with this Mobile number. Please see #TBD for a list of valid Carrier Codes

custom_fields

Object

 

Custom Field Types

...