BasePath: /IPMSAPI [v1]

Description: Gets (Retrieves) the party types collection.

• URL: /api/Lookups/partytypes

• Headers:

  Authorization = Basic authentication. Header value should be base64 encoded string in clientCode:apiKey format.
  

• Method: GET

• URL Parameters

• Data Parameters

• Responses:

  • Response: OK
    Code: 200
    Content: { "PartyTypeId": { "type": "string" }, "CustomValue": { "type": "string" }, "Description": { "type": "string" }, "DisplaySettingId": { "format": "int32", "type": "integer" }, "UpdateDate": { "format": "date-time", "type": "string" } }
  • Response: Unauthorized
    Code: 401
    
  • Response: NotFound
    Code: 404
    
  • Response: InternalServerError
    Code: 500
    

Description: Gets (Retrieves) the parties collection.

• URL: /api/Lookups/parties

• Headers:

  Authorization = Basic authentication. Header value should be base64 encoded string in clientCode:apiKey format.
  

• Method: GET

• URL Parameters

• Data Parameters

• Responses:

  • Response: OK
    Code: 200
    Content: { "PartyId": { "type": "string" }, "Code": { "type": "string" }, "Description": { "type": "string" }, "PartyTypeId": { "type": "string" }, "PartyDetailId": { "format": "int32", "type": "integer" }, "FirstName": { "type": "string" }, "MiddleInitial": { "type": "string" }, "LastName": { "type": "string" }, "Email": { "type": "string" }, "Active": { "type": "boolean" }, "UpdateDate": { "format": "date-time", "type": "string" } }
  • Response: Unauthorized
    Code: 401
    
  • Response: NotFound
    Code: 404
    
  • Response: InternalServerError
    Code: 500
    

Description: Gets (Retrieves) the countries collection.

• URL: /api/Lookups/countries

• Headers:

  Authorization = Basic authentication. Header value should be base64 encoded string in clientCode:apiKey format.
  

• Method: GET

• URL Parameters

• Data Parameters

• Responses:

  • Response: OK
    Code: 200
    Content: { "CountryId": { "format": "int32", "type": "integer" }, "CountryName": { "type": "string" }, "Wipo": { "type": "string" }, "CountryCode": { "type": "string" }, "UpdateDate": { "format": "date-time", "type": "string" }, "IpTypes": { "type": "array", "items": { "format": "int32", "type": "integer" } } }
  • Response: Unauthorized
    Code: 401
    
  • Response: NotFound
    Code: 404
    
  • Response: InternalServerError
    Code: 500
    

Description: Gets (Retrieves) the codes collection.

• URL: /api/Lookups/codes

• Headers:

  Authorization = Basic authentication. Header value should be base64 encoded string in clientCode:apiKey format.
  

• Method: GET

• URL Parameters

• Data Parameters

• Responses:

  • Response: OK
    Code: 200
    Content: { "CodeId": { "type": "string" }, "Code": { "type": "string" }, "Description": { "type": "string" }, "CodeTypeId": { "type": "string" }, "Active": { "type": "boolean" }, "UpdateDate": { "format": "date-time", "type": "string" }, "DisplaySettingId": { "format": "int32", "type": "integer" } }
  • Response: Unauthorized
    Code: 401
    
  • Response: NotFound
    Code: 404
    
  • Response: InternalServerError
    Code: 500
    

Description: Posts (Creates) the fields for specified master table.

• URL: /api/{ipType}

• Headers:

  Authorization = Basic authentication. Header value should be base64 encoded string in clientCode:apiKey format.
  

• Method: POST

• URL Parameters

  ipType

  string

  Required: True

• Data Parameters

  fields

  Object
[ { "Name": "string", "Value": {} } ]

  Required: True

• Responses:

  • Response: Created
    Code: 201
    Content: { "ResultData": [ { "Name": "string", "Value": {} } ], "Message": "string", "MessageDetail": "string" }
  • Response: BadRequest
    Code: 400
    
  • Response: Unauthorized
    Code: 401
    
  • Response: Forbidden
    Code: 403
    
  • Response: NotFound
    Code: 404
    
  • Response: Conflict
    Code: 409
    
  • Response: InternalServerError
    Code: 500
    

Description: Puts (Updates) the fields for specified master table.

• URL: /api/{ipType}/{masterId}

• Headers:

  Authorization = Basic authentication. Header value should be base64 encoded string in clientCode:apiKey format.
  

• Method: PUT

• URL Parameters

  ipType

  string

  Required: True

  masterId

  integer

  Required: True

• Data Parameters

  fields

  Object
[ { "Name": "string", "Value": {} } ]

  Required: True

• Responses:

  • Response: OK
    Code: 200
    Content: { "ResultData": [ { "Name": "string", "Value": {} } ], "Message": "string", "MessageDetail": "string" }
  • Response: BadRequest
    Code: 400
    
  • Response: Unauthorized
    Code: 401
    
  • Response: Forbidden
    Code: 403
    
  • Response: NotFound
    Code: 404
    
  • Response: Conflict
    Code: 409
    
  • Response: InternalServerError
    Code: 500
    

Description: Posts (Creates) the selected file.

• URL: /api/TempFile

• Headers:

  Authorization = Basic authentication. Header value should be base64 encoded string in clientCode:apiKey format.
  

• Method: POST

• URL Parameters

• Data Parameters

  file

  file

  Required: True

• Responses:

  • Response: OK
    Code: 200
    
  • Response: BadRequest
    Code: 400
    
  • Response: Unauthorized
    Code: 401
    
  • Response: Conflict
    Code: 409
    
  • Response: UnsupportedMediaType
    Code: 415
    
  • Response: InternalServerError
    Code: 500
    

Description: Posts (Creates) the selected file through byte array.

• URL: /api/File

• Headers:

  Authorization = Basic authentication. Header value should be base64 encoded string in clientCode:apiKey format.
  

• Method: POST

• URL Parameters

• Data Parameters

  fileName

  string

  Required: True

  fileBytes

  array of bytes

  Required: True

• Responses:

  • Response: OK
    Code: 200
    
  • Response: BadRequest
    Code: 400
    
  • Response: Unauthorized
    Code: 401
    
  • Response: Conflict
    Code: 409
    
  • Response: InternalServerError
    Code: 500
    

Description: Puts (Updates) the fields for specified child table.

• URL: /api/{ipType}/{masterId}/{childName}

• Headers:

  Authorization = Basic authentication. Header value should be base64 encoded string in clientCode:apiKey format.
  

• Method: PUT

• URL Parameters

  ipType

  string

  Required: True

  masterId

  integer

  Required: True

  childName

  string

  Required: True

• Data Parameters

  fields

  array of array
[ [ { "Name": "string", "Value": {} } ] ]

Example values for Party field

{
"Name": "Party Name",
"Value": "PartyId"
}

{
"Name": "Party Name",
"PartyTypeId": "PartyTypeId Value",
"Description": "Party Description"
}

{
"Name": "Party Name",
"Description": "Party Description"
}

{
"Name": "Party Name",
"PartyTypeId": "PartyTypeId Value",
"Email": "Party Email"
}

{
"Name": "Party Name",
"Email": "Party Email"
}

Example values for Code field

{
"Name": "Code Name",
"Value": "CodeId"
}

{
"Name": "Code Name",
"Code": "Code Value",
"CodeTypeId": "CodeTypeId Value",
}

{
"Name": "Code Name",
"Code": "Code Value",
}

{
"Name": "Code Name",
"Description": "Code Description",
}

Example values for Country field

{
"Name": "Country Name",
"Value": "CountryId"
}

{
"Name": "Country Name",
"Wipo": "Wipo Value",
}

{
"Name": "Country Name",
"Country": "Country Value",
}


  Required: True

• Responses:

  • Response: OK
    Code: 200
    Content: { "ResultData": [ [ { "Name": "string", "Value": {} } ] ], "Message": "string", "MessageDetail": "string" }
  • Response: BadRequest
    Code: 400
    
  • Response: Unauthorized
    Code: 401
    
  • Response: Forbidden
    Code: 403
    
  • Response: NotFound
    Code: 404
    
  • Response: InternalServerError
    Code: 500
    

Description: Posts (Creates) the fields for specified child table.

• URL: /api/{ipType}/{masterId}/{childName}

• Headers:

  Authorization = Basic authentication. Header value should be base64 encoded string in clientCode:apiKey format.
  

• Method: POST

• URL Parameters

  ipType

  string

  Required: True

  masterId

  integer

  Required: True

  childName

  string

  Required: True

• Data Parameters

  fields

  array of array
[ [ { "Name": "string", "Value": {} } ] ]

Example values for Party field

{
"Name": "Party Name",
"Value": "PartyId"
}

{
"Name": "Party Name",
"PartyTypeId": "PartyTypeId Value",
"Description": "Party Description"
}

{
"Name": "Party Name",
"Description": "Party Description"
}

{
"Name": "Party Name",
"PartyTypeId": "PartyTypeId Value",
"Email": "Party Email"
}

{
"Name": "Party Name",
"Email": "Party Email"
}

Example values for Code field

{
"Name": "Code Name",
"Value": "CodeId"
}

{
"Name": "Code Name",
"Code": "Code Value",
"CodeTypeId": "CodeTypeId Value",
}

{
"Name": "Code Name",
"Code": "Code Value",
}

{
"Name": "Code Name",
"Description": "Code Description",
}

Example values for Country field

{
"Name": "Country Name",
"Value": "CountryId"
}

{
"Name": "Country Name",
"Wipo": "Wipo Value",
}

{
"Name": "Country Name",
"Country": "Country Value",
}


  Required: True

• Responses:

  • Response: Created
    Code: 201
    Content: { "ResultData": [ [ { "Name": "string", "Value": {} } ] ], "Message": "string", "MessageDetail": "string" }
  • Response: BadRequest
    Code: 400
    
  • Response: Unauthorized
    Code: 401
    
  • Response: Forbidden
    Code: 403
    
  • Response: NotFound
    Code: 404
    
  • Response: InternalServerError
    Code: 500
    

• Notes:

  For child sections: Title, Description, Text3 and Text4, allowed to add only one record for each master ids.

Description: Posts (Creates) the fields for case record.

• URL: /api/CaseRecord/{ipType}

• Headers:

  Authorization = Basic authentication. Header value should be base64 encoded string in clientCode:apiKey format.
  

• Method: POST

• URL Parameters

  ipType

  string

  Required: True

• Data Parameters

  caseRecord

  Object
{ "Items": [ { "Name": "string", "Value": {} } ], "ChildSections": [ { "SectionName": "Name of child section.", "Items": [ [ { "Name": "string", "Value": {} } ] ] } ] }

  Required: True

• Responses:

  • Response: Created
    Code: 201
    Content: { "ResultData": { "Items": [ { "Name": "string", "Value": {} } ], "ChildSections": [ { "SectionName": "Name of child section.", "Items": [ [ { "Name": "string", "Value": {} } ] ] } ] }, "Message": "string", "MessageDetail": "string" }
  • Response: BadRequest
    Code: 400
    
  • Response: Unauthorized
    Code: 401
    
  • Response: Forbidden
    Code: 403
    
  • Response: NotFound
    Code: 404
    
  • Response: Conflict
    Code: 409
    
  • Response: InternalServerError
    Code: 500
    

Description: Puts (Updates) the fields for specified case record.

• URL: /api/CaseRecord/{ipType}/{masterId}

• Headers:

  Authorization = Basic authentication. Header value should be base64 encoded string in clientCode:apiKey format.
  

• Method: PUT

• URL Parameters

  ipType

  string

  Required: True

  masterId

  integer

  Required: True

• Data Parameters

  caseRecord

  Object
{ "Items": [ { "Name": "string", "Value": {} } ], "ChildSections": [ { "SectionName": "Name of child section.", "Items": [ [ { "Name": "string", "Value": {} } ] ] } ] }

  Required: True

• Responses:

  • Response: OK
    Code: 200
    Content: { "ResultData": { "Items": [ { "Name": "string", "Value": {} } ], "ChildSections": [ { "SectionName": "Name of child section.", "Items": [ [ { "Name": "string", "Value": {} } ] ] } ] }, "Message": "string", "MessageDetail": "string" }
  • Response: BadRequest
    Code: 400
    
  • Response: Unauthorized
    Code: 401
    
  • Response: Forbidden
    Code: 403
    
  • Response: NotFound
    Code: 404
    
  • Response: Conflict
    Code: 409
    
  • Response: InternalServerError
    Code: 500
    

Description: Gets (Retrieves) the patent filing forms data.

• URL: /api/patentfilingforms

• Headers:

  Authorization = Basic authentication. Header value should be base64 encoded string in clientCode:apiKey format.
  

• Method: GET

• URL Parameters

  pageNumber

  integer

  Required: False

  pageSize

  integer

  Required: False

  patentMasterId

  integer

  Required: False

  docketNumber

  string

  Required: False

  country

  string

  Required: False

  caseType

  string

  Required: False

  filingType

  string

  Required: False

  relationType

  string

  Required: False

  patentNumber

  string

  Required: False

  filingNumber

  string

  Required: False

  publicationNumber

  string

  Required: False

  publicationDate

  string

  Required: False

  applicationNumber

  string

  Required: False

  applicationDate

  string

  Required: False

  grantDate

  string

  Required: False

• Data Parameters

• Responses:

  • Response: OK
    Code: 200
    Content: { "TotalCount": { "format": "int32", "type": "integer" }, "Count": { "format": "int32", "type": "integer" }, "Items": { "type": "object" } }
  • Response: Unauthorized
    Code: 401
    
  • Response: NotFound
    Code: 404
    
  • Response: InternalServerError
    Code: 500
    

Description: Search for Trademarks reporting data.

• URL: /api/trademarkreporting

• Headers:

  Authorization = Basic authentication. Header value should be base64 encoded string in clientCode:apiKey format.
  

• Method: GET

• URL Parameters

  page

  integer

  Required: False

  pageSize

  integer

  Required: False

  trademarkMasterId

  integer

  Required: False

  attorney

  string

  Required: False

  caseType

  string

  Required: False

  clientDivision

  string

  Required: False

  country

  string

  Required: False

  currentApplicationDate

  DateTime

  Required: False

  currentApplicationNumber

  string

  Required: False

  currentExpirationDate

  DateTime

  Required: False

  currentOwner

  string

  Required: False

  currentRegistrationDate

  DateTime

  Required: False

  currentRegistrationNumber

  string

  Required: False

  currentRenewalDate

  DateTime

  Required: False

  docketNumber

  string

  Required: False

  status

  string

  Required: False

  filingType

  string

  Required: False

  operatingGroup

  string

  Required: False

  text

  string

  Required: False

  classNumber

  string

  Required: False

  goods

  string

  Required: False

• Data Parameters

• Responses:

  • Response: OK
    Code: 200
    Content: { "TotalCount": { "format": "int32", "type": "integer" }, "Count": { "format": "int32", "type": "integer" }, "Items": { "type": "object" } }
  • Response: BadRequest
    Code: 400
    
  • Response: Unauthorized
    Code: 401
    
  • Response: NotFound
    Code: 404
    
  • Response: InternalServerError
    Code: 500