How Can I POLL for changes via the API?

The actual code for the polling commands can be found in the API documentation available in the download section of our website.

 

Polling will allow you to receive and acknowledge messages regarding the following events:

  • Notifications on changes;
  • Notifications on claims;
  • Notifications on SMD creation;
  • Additional: watermark messages.

Notifications contain the following elements:

 

  • A counter that shows how many poll messages are in your queue;
  • The ID of the current message (the message that is displayed);
  • The POLL messages, each preceded by the message type unique identifier:
    • 102 Proof of use (POU) is expire
    • 103 Proof of use (POU) has been verified and approved
    • 104 Proof of use (POU) has not been approved and invalidated
    • 105 Proof of use (POU) is not approved. Further attention needed
    • 107 Mark certificate expired
    • 123 Mark has been verified and approved
    • 124 Mark is not approved. Further attention needed
    • 126 Mark has not been approved and invalidate
    • 127 Mark has not been corrected within 20 days and invalidated.
    • 134 Exception : validator still needs more info to approve mark
    • 137 Mark expired
    • 146 Correction period expired
    • 154 Exception : user request to re-edit after changes
    • 164 Exception : mark can be re-edited
    • 190 POU will expire soon
    • 191 Mark registration will expire soon
    • 196 Warning : Mark about to be invalidated due to INCORRECT status time-out
    • 197 Mark will expire soon
    • 198 Mark has been deactivated
    • 199 Mark transferred out/SMD has been revoked
    • 210 The domain name [$dn] was registered during sunrise
    • 220 The domain name [$dn] was registered during claims period
    • 230 The domain name [$dn] has been registered
    • 240 The domain name [$dn] has been registered in the Qualified Launch Program
    • 251 The variant name [$dn] has been activated
    • 310 SMD has been created
    • 320 SMD has been regenerated
    • 330 SMD has been revoked
    • 400 Account status has gone below watermark level ($level)
    • 500 UDRP/Court case status change
       
  • The ID of the Trademark Record the poll message is referring to;
  • The name of the Mark Record the poll message is referring to.

 

If the current poll message has been processed you will need to send an acknowledgement, in the acknowledgement command you will need to use the ID of the current message, in order to de-queue the message and receive the next message.

 

In addition to the above mentioned notifications, a poll request can also provide you with a “watermark” message, if your pre-paid amount has gone below $1000.

Watermark messages contain the following elements:

 

  • A counter that shows how many poll messages are in your queue;
  • The ID of the current message (the message that is displayed);
  • A message preceded by the message type unique identifier: “400 Account status has gone below watermark level”

 

You will also have to de-queue this message with an acknowledgement command in order receive the next message.

Polling is available on the production and OT&E environments.

In addition ti this the API v2 also automatically adds the number of poll messages pending in the responses the API sends out.

 

Total votes: 5908

FAQ

API (Automated Interface)

billing

Brandpulse

correction process

documentary evidence

general

invoicing

Mark Record Transfer

mark record verification

New gTLD program

Notifications

official agents

online payment

OT&E

prepayment account

pricing

proof of use

Registrars

Registries

Renewal

Signed Mark Data (SMD)

Strawman Model - Abused Labels

Sunrise Services

support

trademark claims services

Trademark Eligibility Requirements

trademark submission

user registration