Validate campaign device

Description

Checks if a device is free and in a provided campaign context

HTTP Method

POST

Path

/devices/validate

Authentication

Does not require user authentication.

Parameters

Table 27.  Parameters for " Validate campaign device "

NameTypeValue TypeDescription
deviceIdFORMlongid of the device to be validated if is free and in the provided campaign context
campaignIdFORMlongthe campaign the device should be part of
inCampaignOnlyFORMboolean(optional) true if the device should be in the provided campaign or can be in the parents also

Error Codes

20000 ( Device )

An unhandled exception has occured.

20006 ( Device )

The provided device is not linked to a campaign.

20012 ( Device )

This device is already linked to an account!

20015 ( Device )

The provided device is not valid

20016 ( Device )

The device is not part of the provided campaign

20017 ( Device )

No valid campaign provided

Response Schema

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

  <xs:element name="response">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="success" type="tns:Status" default="FAILURE" minOccurs="0"/>
        <xs:element name="error" type="tns:Error" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:complexType name="Error">
    <xs:sequence>
      <xs:element name="code" type="xs:string"/>
      <xs:element name="description" type="xs:string"/>
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="Status">
    <xs:restriction base="xs:string">
      <xs:enumeration value="SUCCESS"/>
      <xs:enumeration value="FAILURE"/>
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response xmlns="http://xsd.poken.com">
	<success>SUCCESS</success>
</response>