API

The API uses your TechLink Portal client login. If you do not have an account and would like to set one up please contact TechLink Services at (866) 832-5755.

When you connect to the API you will pass your username and password hash in the headers. You will need to pass your password as MD5 encryption. Sending the password in plain text will result in authentication failure. The authentication header must be passed in each API call.

curl -X GET \
http://portal.techlinksvc.net/api/light/site \
-H 'Cache-Control: no-cache' \
-H 'X-Authorization: testuser:0A0B8D58AB1FAB5B5623557DE51E2C6A'


The API is implemented on multiple environments to facilitate development and testing in a consequence-free (or consequential) system.

Sandbox

The TechLink API is implemented in a sandboxed testing environment, so that development working with sample data can be performed. The base address for the sandboxed API is: https://sandbox.techlinksvc.net/api/light/

The sandboxed environment is populated with a copy of the production data. Note that this copy may be somewhat out-of-date, so recently-created job sites, work orders, and user accounts may not be present. The sandboxed environment can be refreshed with more current data on request.

Production (Live Portal)

The production API is implemented on the live TechLink Services portal. The base address for the production API is: https://portal.techlinksvc.net/api/light/

Calls to the production API will be working with live data - work orders will be handled by actual Project Managers and fulfilled by actual Installers. API calls to the production environment should be fully developed, well-tested, and efficiently executed.

The typical API endpoint is accessed via GET (for reads), POST (for writes), or DELETE (for removal) HTTP methods.

Properties

An endpoint property - usually the ID of the endpoint target - is incorporated into the endpoint URL, i.e. a GET request to http://portal.techlinksvc.net/api/light/site/1234/document/567 will access site #1234's document #567. If an endpoint has a stated property, it is required.

Arguments

Endpoint arguments can be included as a URL path component (i.e. http://portal.techlinksvc.net/api/light/site/1234), as a URL query parameter (i.e. http://portal.techlinksvc.net/api/light/site?city=Shelbyville), or in the request's POST fields. These can be required or optional - the endpoint field list will include that information.

Wildcards

Endpoint arguments can sometimes specify that wildcards are enabled. The asterisk ('*') is the only supported wildcard, and designates any number of characters (including zero) matched. For example, searching for 'test*' will match 'testing', 'testable', or 'test', but not 'greatest' - however, '*test*' would match 'greatest'.

(Note that you can still search for a literal '*' by escaping with a backslash, so searching for a site named '\*test' would only match the '*test' site, not the 'greatest' site.)

The following endpoints are supported for job sites.

This endpoint returns client job site IDs. (Note that this refers to the TechLink site object ID, not the client-provided site ID.) Site IDs will be ordered with the newest first.

 

The response will be returned in JSON format:

{
  "code": 200,
  "message": "2 sites found",
  "data": [
    49947,
    49946"
  ],
  "time": 0.2331788539886474609375
}


This endpoint returns detailed information about a client job site.

 

The response will be returned in JSON format:

{
  "code": 200,
  "message": "Site #49947 found",
  "data":{
    "id": 49947,
    "name": "Joe Testers",
    "siteid": "",
    "phone": "803-555-1212",
    "notes": "This is an API test",
    "timezone": "America/New_York",
    "last_modified": "2018-06-04 13:02:04 UTC",
    "contact1": {
      "name": "Joe Tester",
      "phone": "803-555-1212",
      "email": "joetester@myname.com"
    },
    "contact2": {
      "name": "Tom Tester",
      "phone": "706-555-1212",
      "email": "tomtester@myname.com"
    },
    "address": {
      "street": "321 Main Street",
      "street2": "",
      "street3": "",
      "city": "New York",
      "state": "New York",
      "stateabbr": "NY",
      "zip": "10021",
      "country": "",
      "latitude": "41.505069",
      "longitude": "-73.970327"
    },
    "attributes": []
   },
  "time": 0.2020699977874755859375
}


This endpoint creates a new job site.

 

The response will be returned in JSON format:

{
  "code": 200,
  "message": "Site #49947 successfully created",
  "data": {
    "success": true,
    "site_id": 49947,
    "site": {
      (site object - see Get Site Details for definition)
    }
  },
  "time": 1.6196401119232177734375
}


This endpoint updates an existing job site. Only the fields provided (even if empty) will be updated.

 

The response will be returned in JSON format:

{
  "code": 200,
  "message": "Site #49947 successfully updated",
  "data": {
    "success": true,
    "site_id": 49947,
    "site": {
      (site object - see Get Site Details for definition)
    }
  },
  "time": 1.6196401119232177734375
}


This will retrieve all site attributes (general key/value pairs) associated with a job site.

 

The response will be returned in JSON format:

{
  "code": 200,
  "message": "2 attributes for site #49946 found",
  "data": [
    {
      "attribute_id": 63865,
      "site_id": 49946,
      "name": "Attribute sample name",
      "value": "Attribute sample value"
    },
    {
      "attribute_id": 63866,
      "site_id": 49946,
      "name": "Attribute2 sample name",
      "value": "Attribute2 sample value"
    }
  ],
  "time": 0.135857105255126953125
}


This will set (create or update) a custom site attribute. Note that site attributes are referenced by name, not by ID, unlike most other endpoint object references.

 

The response will be returned in JSON format:

{
  "code": 200,
  "message": "Site #49947 attribute successfully set",
  "data": {
    "success": true,
    "attribute_id": 63865,
    "attribute": {
      (site attribute object - see Get Site Attributes for definition)
    }
  },
  "time": 0.3038499355316162109375
}


This will remove a custom site attribute. Note that site attributes are referenced by name, not by ID, unlike most other endpoint object references.

 

The response will be returned in JSON format:

{
  "code": 200,
  "message": "Site #49947 attribute successfully deleted",
  "data": {
    "success": true
  },
  "time": 0.271129131317138671875
}


This will retrieve all site-specific documents for a job site.

 

The response will be returned in JSON format:

{
  "code": 200,
  "message": "1 document found",
  "data": [
    {
      "document_id": 16168,
      "site_id": 49946,
      "filename": "testdocument.doc",
      "description": "Test File",
      "url": ""
    }
  ],
  "time": 0.1463930606842041015625
}


This will retrieve the raw file data for a site-specific document for a job site.

 

The response will be returned as raw data suitable for saving to a file

This will create a new site-specific document for a job site.

 

The response will be returned in JSON format:

{
  "code": 200,
  "message": "Document #16167 saved for site #49947",
  "data": {
    "success": true,
    "document_id": 16167,
    "document": {
      (site-document object - see Get Site Documents for definition)
    }
  },
  "time": 0.1828458309173583984375
}