Upload Contact String

Description

This method allows to upload the Magic string from a Poken Device.

HTTP Method

POST

Path

/devices/uploadcontacts

Authentication

Does not require user authentication.

Parameters

Table 30.  Parameters for " Upload Contact String "

NameTypeValue TypeDescription
contactstringFORMStringThe magic string taken from the device.
timeSinceOffloadFORMLong(optional) the number of milliseconds since the device was locally offloaded on a different system (the PokenPro android application, for example).

Error Codes

20000 ( Device )

An unhandled exception has occured.

20002 ( Device )

Unabled to update the device detail information.

20004 ( Device )

The specified icon name is not valid.

Response Schema

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema elementFormDefault="qualified" version="1.0" targetNamespace="http://xsd.poken.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="uploadResponse">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="accountId" type="xs:long" minOccurs="0"/>
        <xs:element name="objectId" type="xs:long" minOccurs="0"/>
        <xs:element name="campaignId" type="xs:long" minOccurs="0"/>
        <xs:element name="message" type="xs:string" minOccurs="0"/>
        <xs:element name="deviceId" type="xs:long" minOccurs="0"/>
        <xs:element name="countUploadedContacts" type="xs:int" minOccurs="0"/>
        <xs:element name="deviceAccessToken" type="xs:string" minOccurs="0"/>
        <xs:element name="isPassiveTag" type="xs:boolean" minOccurs="0"/>
        <xs:element name="deviceStatus" type="xs:string" minOccurs="0"/>
        <xs:element name="campaignName" type="xs:string" minOccurs="0"/>
        <xs:element name="obfuscateEmail" type="xs:string" minOccurs="0"/>
        <xs:element name="code" type="xs:string" minOccurs="0"/>
        <xs:element name="expires_in" type="xs:long" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<uploadResponse xmlns="http://xsd.poken.com">
	<deviceId>0</deviceId>
	<accountId>0</accountId>
	<objectId>0</objectId>
	<campaignId>0</campaignId>
	<countUploadedContacts>0</countUploadedContacts>
	<message>Some text</message>
	<isPassiveTag>false</isPassiveTag>
	<deviceAccessToken>20797217_1257682_v-FZE-XzTA-PCdVWFUHdqyO3QPE.</deviceAccessToken>
	<deviceStatus>ENABLED</deviceStatus>
	<code>23123123-C-T1uVhh8nKayw8CTUDDHgvgPp</code>
    <expires_in>900</expires_in>    
</uploadResponse>