<img height="1" width="1" style="display:none" src="https://www.facebook.com/tr?id=1213997082030178&amp;ev=PageView&amp;noscript=1">
Menu
BOOK FREE DEMO

The Tharstern API

Our API provides a secure and reliable layer between data and the Tharstern application, and reduces the need for other software to query and write directly to the Tharstern database.

The API:

  • Uses a RESTful architecture
  • Is .NET based
  • Accepts and returns XML and JSON


We've designed our API to be easy for third-party developers to work with, using conventions and best-practices that developers are typically already familiar with. It's also self-documenting: developers can access resources detailing the available methods and parameters required and try them out in the browser, in real time, without having to write any code.

Watch an overview video of the API or to view a list of methods, see here.

Activities (Method)
Activities (Action)
GET /api/activities
Returns a filtered list of Activities
Attachments (Method)
Attachments (Action)
GET /api/attachments
Returns a filtered list of Attachments
POST /api/attachments
Attaches assets/files to Estimates, Jobs or Orders
GET /api/attachments/{id}/stream
Attaches assets/files to Estimates, Jobs or Orders as bytes
Authentication (Method)
Authentication (Action)
GET/api/Authentication/GenerateAPIToken
Used to generate a token
Contacts (Method)
Contacts (Action)
GET /api/contacts
Returns a filtered list of Contacts
POST /api/contacts
Creates a new Contact
Customers (Method)
Customers (Action)
GET /api/customers
Returns a filtered list of Customers
CustomFields (Method)
CustomFields (Action)
GET /api/customfields
Returns a filtered list of Custom Fields
DeliveryNotes (Method)
DeliveryNotes (Action)
GET /api/deliverynotes
Returns a filtered list of Sales Delivery Notes
GET /api/deliverynotes/{id}
Returns a specific Sales Delivery Note
POST /api/deliverynotes/updateproofofdelivery
Updates the Sales Delivery Note with delivered details
Enums (Method)
Enums (Action)
GET /api/enums
n/a
Estimates (Method)
Estimates (Action)
GET /api/estimates
Returns a filtered list of estimates
EstRequest (Method)
EstRequest (Action)
POST /api/estrequest
Submit an EstRequest and create an Estimate
GET /api/estrequest/{productTypeId}/example
Return an example EstRequest for a ProductType
Filters (Method)
Filters (Action)
GET /api/filters/types
Returns a list of filters for specific types
GET /api/filters
Returns a list of filters
POST /api/filters
Creates/Edits an existing filter (Not Tharstern Filters)
FoldingHeaders (Method)
FoldingHeaders (Action)
GET /api/foldingheaders
Returns a filtered list of Folding Headers
JDF (Method)
JDF (Action)
GET /api/jdfcontrollers
Returns a filtered list of JDF Controllers
GET /api/jdflogs
Returns the JDF logs
Jobs (Method)
Jobs (Action)
GET /api/jobs
Returns a list of Jobs
POST /api/jobs/milestones/update
Updates Job Milestones
POST /api/job/createfromestimate
Creates a Job Req from an Estimate
POST /api/job/refreshproductiondetails
Updates the Estimate onto a Job – production info only
Milestones (Method)
Milestones (Action)
GET /api/milestones
Returns a filtered list of Milestones
Operators (Method)
Operators (Action)
GET /api/operators
Returns a filtered list of Operators
Options (Method)
Options (Action)
GET /api/options
Returns relevant System Options e.g. Document Path
Orders (Method)
Orders (Action)
GET /api/orders
Returns information about Sales Orders
POST /api/orders/submit
Creates a Sales Order
POST /api/orders/submitorderitemasset
Retrospectively submits an asset to a Sales Order
Product (Method)
Product (Action)
GET /api/products
Returns information about Inventory including balances
ProductTypes (Method)
ProductTypes (Action)
GET /api/producttypes
Returns information about Product Types
ScheduleResources (Method)
ScheduleResources (Action)
GET /api/scheduleresources
Returns a filtered list of Schedule Resources
Tasks (Method)
Tasks (Action)
GET /api/tasks
Returns a filtered list of Tasks
POST /api/tasks
Create Tasks inc. RFQ Tasks
GET /api/tasks/{id}
Returns a specific Task
Terminals (Method)
Terminals (Action)
GET /api/terminals
Returns a list of IDC Terminals
Users (Method)
Users (Action)
GET /api/users
Returns the user details for the given email address and password