POST

Create Watching

Creates a new Watching record for a trademark.

Important

Calls to this method must include the cookie .LawPanel.AuthCookie in order to identify you at user level. For more details about authentication please check this link. To obtain the cookie you can use the method Login.

Request URL

Request headers

string

User authentication cookie. Read more about how to you get it from here.

string
Subscription key which provides access to this API.

Request body

  • string Required firm_portfolio_id: The trademark ID to watch. To get a list of your trademarks please check this link.
  • string Required user_id: The user ID to recieve email notifications when watching has news. To get a list of your users please check this link.
  • string Required frequency_id: The frequency ID to send email notifications when watching has news. To get a list of frequencies available check this link.
  • integer Required sensitivity: The sensitivity to match a trademark. 0 means very strict, 20 is more flexible. For example, if your trademark is "LawPanel" and you set this value to 0, you'll only receive notifications about new trademarks like "Law Panel", or "LawPanel". If you set it to 20 you'll receive notifications about new trademarks like "A law", or "The panel".

Loading...
                  {
  "type": "object",
  "properties": {
    "firm_portfolio_id": {
      "type": "string"
    },
    "user_id": {
      "type": "string"
    },
    "frequency_id": {
      "type": "string"
    },
    "sensitivity": {
      "type": "integer"
    }
  },
  "example": {
    "firm_portfolio_id": "541fe28f-21f5-40c4-8c15-aad8012ad11c",
    "user_id": "03ce7827-aac0-477d-a01b-aad8012abc99",
    "frequency_id": "c94a7d6d-83e1-4186-b3fe-a6720147e2d2",
    "sensitivity": 10
  }
}
                  
              

Response 201

Returns a representation for the new Watching record created.

  • string id: The watching ID.
  • string user_id: The user ID to recieve email notifications when watching has news. To get a list of your users please check this link.
  • string user_name: Human-readable user name to receive notifications.
  • integer sensitivity: The sensitivity to match a trademark. 0 means very strict, 20 is more flexible. For example, if your trademark is "LawPanel" and you set this value to 0, you'll only receive notifications about new trademarks like "Law Panel", or "LawPanel". If you set it to 20 you'll receive notifications about new trademarks like "A law", or "The panel".
  • string application_number: The trademark application number for the watching.
  • string application_number: The trademark text for the watching.
  • string last_search_date: Last search date for matches in ISO-8601 (UTC) format.
  • string classes: Comma separated search class numbers for the watched trademark.
  • string registry_id: The registry ID where watching will be performed. To get a list of registries available please check this link.
  • string registry_name: Human-readable registry name to perform the watching.
  • string frequency_id: The frequency ID to send notifications about watching matches. To get a list of frequencies available please check this link.
  • string frequency_name: Human-readable frequency name to notify about matches.
  • string firm_portfolio_id: The trademark ID to watch. To get a list of your trademarks please check this link.
  • string last_notification_date_time: Last date when a notification was sent to inform about matches.Date is showed in ISO-8601 (UTC) format.

Loading...
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "user_id": {
      "type": "string"
    },
    "user_name": {
      "type": "string"
    },
    "sensitivity": {
      "type": "integer"
    },
    "application_number": {
      "type": "string"
    },
    "trademark": {
      "type": "string"
    },
    "last_search_date": {},
    "last_search_results": {},
    "classes": {
      "type": "string"
    },
    "registry_id": {
      "type": "string"
    },
    "registry_name": {
      "type": "string"
    },
    "frequency_id": {
      "type": "string"
    },
    "frequency_name": {
      "type": "string"
    },
    "firm_portfolio_id": {
      "type": "string"
    },
    "interesting_watching_history_records": {
      "type": "integer"
    },
    "last_notification_date_time": {}
  },
  "example": {
    "id": "7ba96a95-6ae3-4cdd-a860-ab4a00d3ae7f",
    "user_id": "03ce7827-aac0-477d-a01b-aad8012abc99",
    "user_name": "chapeti+alsina003@gmail.com",
    "sensitivity": 20,
    "firm_portfolio_id": "605366ae-6ba7-4f0c-acc4-ab4a00d38883",
    "application_number": "0303456",
    "trademark": "5ARTH",
    "classes": "20",
    "registry_id": "bdbc9579-0462-4449-b7e8-a835017ea7c4",
    "registry_name": "GB",
    "frequency_id": "c94a7d6d-83e1-4186-b3fe-a6720147e2d2",
    "frequency_name": "Weekly",
    "events": [
      {
        "id": "7ba96a95-6ae3-4cdd-a860-ab4a00d3ae7f|3139581561719999999",
        "unix_time_stamp": 1579741428,
        "application_date": "2020-01-02T00:00:00Z",
        "application_number": "UK00003455018",
        "trademark": "5ARTH",
        "classes": "20",
        "databases": "GB",
        "owner_applicant": "Lai Feifeng",
        "status": "Pending",
        "good_and_services": "20: desks [furniture], office furniture, furniture, chairs, display stands, [...]",
        "handled": false
      }
    ],
    "created": "2020-01-22T12:50:42.5533169Z",
    "last_search_date": "2020-01-23T01:05:06.9702455Z",
    "last_notification_date_time": "2020-01-23T01:05:06.9702455Z"
  }
}
* See getting started for more information on how to use this API. You can also check the API change history.