TM-Class Web Services

From TM-XML-Wiki

TM-Class
Main Page | Glossary | Data Dictionary | Web Services | XML Schemas | Change Log | FAQ

The list of web services for the "Push" approach

EuroNice submits data to be processed, and XMarks pushes the processed data back to EuroNice.

Trade Mark's List of Goods and Services Web services

Method	Protocol	Service Domain	Business Context	Resource Class	Identifier/Look-up Expression	Description
POST	http://	XMarks domain/	trademark/	goods-services/	Trademark ID	Service provided by EuroNice to XMarks (1 post per trademark)
DELETE	http://	XMarks domain/	trademark/	goods-services/	Trademark ID	To delete a post in case of mistake
GET	http://	XMarks domain/	trademark/	xmarks-status/	Trademark ID	Service provide by XMarks to EuroNice giving the status of the process in XMarks
POST	http://	EuroNice Domain/	trademark/	goods-services/	Trademark ID	Service provided by XMarks to EuroNice (Improvement or Not of the List of Goods and Services)

Classification Term Synchronization Web Services

Method	Protocol	Service Domain	Business Context	Resource Class	Identifier/Look-up Expression	Description
POST	http://	XMarks domain/	trademark/	classification-term/	Classification Term ID	Service provided by EuroNice to XMarks (1 post per new term)
DELETE	http://	XMarks domain/	trademark/	classification-term/	Classification Term ID	Service provided by EuroNice to XMarks (To delete a classification term - a update will be implemented by 1 Delete followed by 1 Post)

EXAMPLES (Web Service + Payload)

Request for the trademark processing

Web service:

POST http://xmarksdomain/trademark/goods-services/

Payload:

Not Compliant

  <?xml version="1.0" encoding="UTF-8"?>
  <Transaction xmlns="XMarks_Trademark_v0">
    <TransactionBody>
     <TransactionContentDetails>
       <TransactionIdentifier>20080717110835</TransactionIdentifier>
       <TransactionData>
        <TradeMarkDetails>
          <TradeMark>
           <TradeMarkIdentifier>110</TradeMarkIdentifier>
           <TradeMarkProcessingDetails>
             <ProcessingType>Manual</ProcessingType>
             <Deadline>2009-05-30T11:30:10+02:00</Deadline>
           </TradeMarkProcessingDetails>
           <MessageData>
             <Header>000000453311|000005504709|001|EN|ES|EN|US|||T|19|ES|CS|DA|PT|ET|EL|FR|IT|LV|LT|HU|MT|NL|PL|DE|SK|SL|FI|SV|2|</Header>
             <Content>
              <Lang>en</Lang>
              <Data>|4|4|Jewelry, watches and clocks.|8|Articles made of leather and imitations of leather, namely, luggage, handbags, purses, wallets, tote bags, gym bags, all purpose sport bags, fanny packs, back packs, umbrellas and walking canes.|24|quilts; quilt; quilted; quilting; of quilts; Toowels, handkerchiefs, quilts, comforters, bedspreads, sheets, pillowcases, blankets, and tablecloths.|25|Clothing, footwear,headgear, namely, t-shirts, sweat shirts, jerseys, shorts, sweat pants, jackets, hats, caps, scarves, gloves, hosiery, neckties, pajamas, robes night shirts, night gowns, underwear, head bands; wrist; bands; swim suits, skirts, shirts, tank tops, pants, coats, sweaters, leotards, leg warmers, stockings, socks, panty hose, tights, belts, shoes, athletic shoes, slippers, boots, sandaaaaals and rainwear.||F|Red|T||F|</Data>
             </Content>
             <Content>
              <Lang>pt</Lang>
              <Data>|4|14|alfinetes para chapéus; alfinete para chapéus|21|Articles made of leather and imitations of leather, namely, luggage, handbags, purses, wallets, tote bags, gym bags, all purpose sport bags, fanny packs, back packs, umbrellas and walking canes.|24|quilts; quilt; quilted; quilting; of quilts; Toowels, handkerchiefs, quilts, comforters, bedspreads, sheets, pillowcases, blankets, and tablecloths.|25|Clothing, footwear,headgear, namely, t-shirts, sweat shirts, jerseys, shorts, sweat pants, jackets, hats, caps, scarves, gloves, hosiery, neckties, pajamas, robes night shirts, night gowns, underwear, head bands; wrist; bands; swim suits, skirts, shirts, tank tops, pants, coats, sweaters, leotards, leg warmers, stockings, socks, panty hose, tights, belts, shoes, athletic shoes, slippers, boots, sandaaaaals and rainwear.||F|Red|T||F|</Data>
             </Content>
           </MessageData>
          </TradeMark>
        </TradeMarkDetails>
       </TransactionData>
     </TransactionContentDetails>
    </TransactionBody>
  </Transaction>

Response:

201 + URI to the newly created trademark on XMarks side

Submit the trademark back to EuroNice

When the trademark is processed or the deadline is reached, XMarks updates the trademark on the EuroNice side.

Web service:

POST http://euronicedomain/trademark/goods-services/

Payload:

Not Compliant

  <Transaction>
     <TradeMarkTransactionBody>
        <TransactionContentDetails>
           <TransactionIdentifier>ID</TransactionIdentifier>
           <TransactionData>
             <TradeMarkDetails> 
               <TradeMarkProcessingDetails>
                 <ProcessingType>OFF/AUTOMATIC/MANUAL/MIXED</ProcessingType>
                 <ProcessingError>Error Code</ProcessingError>
                 <ProcessingStatistics>Detailed information about processing</ProcessingStatistics>
  …
               </TradeMarkProcessingDetails>
               <TradeMark>
                 <TradeMarkIdentifier>ID</TradeMarkIdentifier>
                 <MessageData>Data Updated by XMarks Processing</MessageData>
               </TradeMark>
             </TradeMarkDetails>
           </TransactionData>
        </TransactionContentDetails>
     </TradeMarkTransactionBody>
  </Transaction>

Response:

201 + URI to the newly created trademark on EuroNice side

Delete the trademark from XMarks

When EuroNice gets the processed trademark, it deletes it on the XMarks side. The delete operation can be invoked for other reasons as well. For example: the processing might not be needed, since the trademark has been removed from EuroNice.

Web service:

DELETE http://euronicedomain/trademark/goods-services/

Response:

200

Perform other operations on trademarks

If needed, EuroNice can GET trademarks whenever needed. For example: it can check the status of a trademark.

Web service:

GET http://xmarksdomain/trademark/xmarks-status/

Response:

200

Data synchronization

New classification term

Web service:

POST http://xmarksdomain/trademark/classification-term/

Payload:

Not Compliant

  <?xml version="1.0" encoding="UTF-8"?>
  <Transaction xmlns="XMarks_ClassificationTerm_v0">
    <TransactionBody>
     <TransactionContentDetails>
       <TransactionIdentifier>20080710171847</TransactionIdentifier>
       <TransactionData>
        <ClassificationTermDetails>
          <ClassificationTerm>
           <MessageData>
             <identry>9999</identry>
             <sttemp>0</sttemp>
             <idlang>en</idlang>
             <odexpression>0</odexpression>
             <sthomograph>0</sthomograph>
             <usage>10</usage>
             <master>1</master>
             <nosource>0</nosource>
             <prexpression>test</prexpression>
             <idclass>21</idclass>
             <expression>test123</expression>
             <numwords>1</numwords>
             <dtmerge>2002-05-30T11:30:10+02:00</dtmerge>
           </MessageData>
          </ClassificationTerm>
        </ClassificationTermDetails>
       </TransactionData>
     </TransactionContentDetails>
    </TransactionBody>
  </Transaction>

Response: 201 + URI to the newly created classification term on XMarks side.

Delete the classification term

Web service:

DELETE http://xmarksdomain/trademark/classification-term/

Response:

200

Update the classification term

In order to update an existing classification term, EuroNice has to delete it, and post the new version.

Web service:

DELETE http://xmarksdomain/classification-term/

Web service:

POST http://xmarksdomain/classification-term/