# TaskLabours
This zone allows you to pull the [labour](https://help.aroflo.com/display/office/Task+Worksheet+Labour) recorded on tasks without the overhead of the rest of the task information.
## WHERE filters
| Field | Value |
| --- | --- |
| taskid | AroFlo ID |
| status | STRING(quote,notstarted,inprogress,pending,completed,archived) |
| labourlineid | AroFlo ID |
| isinventory | BOOLEAN |
| workdate | DATE(YYYY-MM-DD) |
| workdatetimestart | DATETIME(YYYY-MM-DD HH:mm:ss) |
| workdatetimeend | DATETIME(YYYY-MM-DD HH:mm:ss) |
| lablinkprocessed | BOOLEAN |
| lablinkprocesseddate | DATE(YYYY-MM-DD) |
| lablocked | BOOLEAN |
| labverified | BOOLEAN |
| labeodapproved | BOOLEAN |
| deleteddate | DATE(YYYY-MM-DD) |
| deleteddatetime | DATETIME(YYYY-MM-DD HH:mm:ss) |
**Default WHERE clause**
AND workdate > DATEADD(d, -30, GETUTCDATE())
## ORDER BY
| Field |
| --- |
| clientname |
| orgname |
| jobnumber |
| refcode |
| lablinkprocesseddate |
## POSTXML Variable definition
<labours>
<labour>
<lineid>AroFlo ID</lineid> <comment class='preserveHtml' class='preserveHtml' class='preserveHtml'> INSERT no / UPDATE required -->
<lablinkprocessed>BOOLEAN</lablinkprocessed> <comment class='preserveHtml' class='preserveHtml' class='preserveHtml'> INSERT no / UPDATE required -->
<task>
<taskid>AroFlo ID</taskid> <comment class='preserveHtml' class='preserveHtml' class='preserveHtml'> INSERT no / UPDATE required -->
</task>
</labour>
</labours>
**Authorization:** bearer
---
### GET Get Tasklabours
`GET https://api.aroflo.com/{{urlVarString}}`
Return the first page of task labour that have not been processed by the API. We do this by filtering on the lablinkprocessed field, which we should set TRUE after we process the data from AroFlo.
```
if (requestType == 'GET') {
var urlVarString = [
'zone=' + encodeURIComponent('tasklabours')
,'where=' + encodeURIComponent('and|lablinkprocessed|=|false')
,'page=' + encodeURIComponent('1')
];
urlVarString = urlVarString.join('&');
}
```
**Authorization:** bearer
**Headers:**
| Header | Value | Description |
| --- | --- | --- |
| `Authentication` | `HMAC {{af_hmac_signature}}` | |
| `HostIP` | `XXX.XXX.XXX.XXX` | |
| `Authorization` | `{{Authorization}}` | |
| `Accept` | `text/json` | |
| `afdatetimeutc` | `{{af_iso_timestamp}}` | |
**Pre-request Script:**
```javascript
//What type of HTTP Request we're making GET|POST
var requestType = 'GET';
//When using a GET request set the urlVarString.
//Also ensuring that all values are URIencoded
if (requestType == 'GET') {
var urlVarString = [
'zone=' + encodeURIComponent('tasklabours')
,'where=' + encodeURIComponent('and|lablinkprocessed|=|false')
,'page=' + encodeURIComponent('1')
];
urlVarString = urlVarString.join('&');
pm.environment.set("urlVarString", '?' +urlVarString);
//We now call the Authentication function and pass it our requestType and urlVarString
AroFloAuth(requestType, urlVarString)
}
//When using a POST request set the formVarString
if (requestType == 'POST') {
var formVarString = [
'zone=' + encodeURIComponent('tasklabours')
,'postxml='
];
formVarString = formVarString.join('&');
pm.environment.set("formVarString", formVarString);
//We now call the Authentication function and pass it our requestType and formVarString
AroFloAuth(requestType, formVarString)
}
//The Authentication flow has been moved into a function to highlight that this is code that you must replicate in your own system/app/language
//and must be called for every request. Each request requires it's own HMAC signature.
function AroFloAuth(requestType, VarString) {
//secret_key is a new auth key shown once only in the AroFloAPI Settings page.
let secret_key = pm.environment.get('secret_key');
//We now need to set a timestamp as an ISO 8601 UTC timestamp e.g. "2018-07-25T01:39:57.135Z"
let d = new Date();
let isotimestamp = d.toISOString();
//You need to send us what IP you are sending from
let HostIP = pm.environment.get('HostIP');
//urlPath is currently '' and should not be changed
let urlPath = '';
//rather than setting &format in the URL Variable scope, we now define an accept header
//accept can be either 'text/json' or 'text/xml'
let accept = pm.environment.get('accept');
//we also removed the uEncoded,pEncoded & orgEncoded from the URL variable scope and it is now set as an Authorization header
//All values should be URIencoded
let Authorization = 'uencoded='+encodeURIComponent(pm.environment.get('uEncoded'))+'&pencoded='+encodeURIComponent(pm.environment.get('pEncoded'))+'&orgEncoded='+encodeURIComponent(pm.environment.get('orgEncoded'));
//Setting the first field to our request type GET|POST
let payload = [requestType];
//If the HostIP hasn't been set then we can exclude that from our Auth string. Just remember to also exclude it from your header
if (typeof HostIP != 'undefined') {
payload.push(HostIP);
pm.environment.set("HostIP", HostIP);
}
//We now add the rest of the fields needed to our payload array
payload.push(urlPath);
payload.push(accept);
payload.push(Authorization);
payload.push(isotimestamp);
payload.push(VarString);
//Create our hash using all of the fields we added to the payload array as a string, separated by '+' and encoded with our secret_key
let hash = CryptoJS.HmacSHA512( payload.join('+'), secret_key);
//Update the environment variables
pm.environment.set("urlPath", urlPath);
pm.environment.set("accept", accept);
pm.environment.set("Authorization", Authorization);
pm.environment.set("af_hmac_signature", hash.toString());
pm.environment.set("af_iso_timestamp", isotimestamp);
}//end function
```
### Example Responses
#### Get Tasklabours (OK 200)
```json
{
"status": "0",
"statusmessage": "Login OK",
"zoneresponse": {
"maxpageresults": "500",
"pagenumber": "1",
"queryresponsetimes": {
"labours": 42
},
"currentpageresults": 1,
"labours": [
{
"labverified": "false",
"task": {
"taskid": "JSZaXyVQPFggCg==",
"status": "Not Started",
"org": {
"orgid": "JCdKUyZRMCAgCg==",
"orgname": "Bradley Sandbox"
},
"linkprocesseddate": " ",
"refcode": "Aardva5",
"jobnumber": "1049",
"linkprocessed": "false",
"client": {
"clientid": "JCdKUydSQCAgCg==",
"clientname": "Aardvaark ConsultantsCLR2"
}
},
"worktype": "NT",
"workdatetimeend": "2018/10/23 09:00:00",
"lablinkprocesseddatetime": "2018/10/23",
"endtime": "Oct 23, 2018 9:00:00 AM",
"lablinkprocesseddate": "2018/10/23",
"deleted": "0",
"user": {
"userid": "JCQ6XyRRUCAgCg==",
"username": "Bradley Sandbox"
},
"lablinkprocessed": "false",
"cost": "0.0000",
"starttime": "Oct 23, 2018 7:00:00 AM",
"deleteddate": "",
"hours": "2.00",
"sell": "83.0000",
"lineid": "JSYqQyVRXFQgCg==",
"workdatetimestart": "2018/10/23 07:00:00",
"note": "this is a task labour",
"lablocked": "false",
"deletedtime": "",
"deleteddatetime": " ",
"workdate": "2018/10/23"
}
]
}
}
```
---
### POST Mark Tasklabours LinkProcessed
`POST https://api.aroflo.com/`
Mark a labour item as linkprocessed. Note that the taskid and lineid are both required fields. Multiple labour items can be processed in this method by using additional `` keys.
```
if (requestType == 'POST') {
var formVarString = [
'zone=' + encodeURIComponent('tasklabours')
,'postxml=' + encodeURIComponent('labours>JSYqQyVRXFQgCg==trueJSZaXyVQPFggCg==')
];
formVarString = formVarString.join('&');
}
```
**Authorization:** bearer
**Headers:**
| Header | Value | Description |
| --- | --- | --- |
| `Authentication` | `HMAC {{af_hmac_signature}}` | |
| `HostIP` | `XXX.XXX.XXX.XXX` | |
| `Authorization` | `{{Authorization}}` | |
| `Accept` | `text/json` | |
| `afdatetimeutc` | `{{af_iso_timestamp}}` | |
| `Content-Type` | `application/x-www-form-urlencoded` | |
**Body:**
```
{{formVarString}}
```
**Pre-request Script:**
```javascript
//What type of HTTP Request we're making GET|POST
var requestType = 'POST';
//When using a GET request set the urlVarString.
//Also ensuring that all values are URIencoded
if (requestType == 'GET') {
var urlVarString = [
'zone=' + encodeURIComponent('tasklabours')
,'where=' + encodeURIComponent('and|lablinkprocessed|=|false')
,'page=' + encodeURIComponent('1')
];
urlVarString = urlVarString.join('&');
pm.environment.set("urlVarString", '?' +urlVarString);
//We now call the Authentication function and pass it our requestType and urlVarString
AroFloAuth(requestType, urlVarString)
}
//When using a POST request set the formVarString
if (requestType == 'POST') {
var formVarString = [
'zone=' + encodeURIComponent('tasklabours')
,'postxml=' + encodeURIComponent('<labours><labour><lineid>JSYqQyVRXFQgCg==</lineid><lablinkprocessed>true</lablinkprocessed><task><taskid>JSZaXyVQPFggCg==</taskid></task></labour></labours>')
];
formVarString = formVarString.join('&');
pm.environment.set("formVarString", formVarString);
//We now call the Authentication function and pass it our requestType and formVarString
AroFloAuth(requestType, formVarString)
}
//The Authentication flow has been moved into a function to highlight that this is code that you must replicate in your own system/app/language
//and must be called for every request. Each request requires it's own HMAC signature.
function AroFloAuth(requestType, VarString) {
//secret_key is a new auth key shown once only in the AroFloAPI Settings page.
let secret_key = pm.environment.get('secret_key');
//We now need to set a timestamp as an ISO 8601 UTC timestamp e.g. "2018-07-25T01:39:57.135Z"
let d = new Date();
let isotimestamp = d.toISOString();
//You need to send us what IP you are sending from
let HostIP = pm.environment.get('HostIP');
//urlPath is currently '' and should not be changed
let urlPath = '';
//rather than setting &format in the URL Variable scope, we now define an accept header
//accept can be either 'text/json' or 'text/xml'
let accept = pm.environment.get('accept');
//we also removed the uEncoded,pEncoded & orgEncoded from the URL variable scope and it is now set as an Authorization header
//All values should be URIencoded
let Authorization = 'uencoded='+encodeURIComponent(pm.environment.get('uEncoded'))+'&pencoded='+encodeURIComponent(pm.environment.get('pEncoded'))+'&orgEncoded='+encodeURIComponent(pm.environment.get('orgEncoded'));
//Setting the first field to our request type GET|POST
let payload = [requestType];
//If the HostIP hasn't been set then we can exclude that from our Auth string. Just remember to also exclude it from your header
if (typeof HostIP != 'undefined') {
payload.push(HostIP);
pm.environment.set("HostIP", HostIP);
}
//We now add the rest of the fields needed to our payload array
payload.push(urlPath);
payload.push(accept);
payload.push(Authorization);
payload.push(isotimestamp);
payload.push(VarString);
//Create our hash using all of the fields we added to the payload array as a string, separated by '+' and encoded with our secret_key
let hash = CryptoJS.HmacSHA512( payload.join('+'), secret_key);
//Update the environment variables
pm.environment.set("urlPath", urlPath);
pm.environment.set("accept", accept);
pm.environment.set("Authorization", Authorization);
pm.environment.set("af_hmac_signature", hash.toString());
pm.environment.set("af_iso_timestamp", isotimestamp);
}//end function
```
### Example Responses
#### Mark Tasklabours LinkProcessed (OK 200)
```json
{
"status": "0",
"statusmessage": "Login OK",
"zoneresponse": {
"postresults": {
"updatetotal": 1,
"errors": [],
"updates": {
"labours": [
{
"task": {
"taskid": "JSZaXyVQPFggCg=="
},
"lineid": "JSYqQyVRXFQgCg==",
"lablinkprocessed": "true"
}
]
},
"inserttotal": 0,
"inserts": {
"labours": []
}
}
}
}
```
---
### GET Get Tasklabours for workdatetimestart
`GET https://api.aroflo.com/{{urlVarString}}`
**Authorization:** bearer
**Headers:**
| Header | Value | Description |
| --- | --- | --- |
| `Authentication` | `HMAC {{af_hmac_signature}}` | |
| `HostIP` | `XXX.XXX.XXX.XXX` | |
| `Authorization` | `{{Authorization}}` | |
| `Accept` | `text/json` | |
| `afdatetimeutc` | `{{af_iso_timestamp}}` | |
**Pre-request Script:**
```javascript
//What type of HTTP Request we're making GET|POST
var requestType = 'GET';
//When using a GET request set the urlVarString.
//Also ensuring that all values are URIencoded
if (requestType == 'GET') {
var urlVarString = [
'zone=' + encodeURIComponent('tasklabours')
,'where=' + encodeURIComponent('and|workdatetimestart|>|2022/10/10 00:00:00')
,'page=' + encodeURIComponent('1')
];
urlVarString = urlVarString.join('&');
pm.environment.set("urlVarString", '?' +urlVarString);
//We now call the Authentication function and pass it our requestType and urlVarString
AroFloAuth(requestType, urlVarString)
}
//When using a POST request set the formVarString
if (requestType == 'POST') {
var formVarString = [
'zone=' + encodeURIComponent('tasklabours')
,'postxml='
];
formVarString = formVarString.join('&');
pm.environment.set("formVarString", formVarString);
//We now call the Authentication function and pass it our requestType and formVarString
AroFloAuth(requestType, formVarString)
}
//The Authentication flow has been moved into a function to highlight that this is code that you must replicate in your own system/app/language
//and must be called for every request. Each request requires it's own HMAC signature.
function AroFloAuth(requestType, VarString) {
//secret_key is a new auth key shown once only in the AroFloAPI Settings page.
let secret_key = pm.environment.get('secret_key');
//We now need to set a timestamp as an ISO 8601 UTC timestamp e.g. "2018-07-25T01:39:57.135Z"
let d = new Date();
let isotimestamp = d.toISOString();
//You need to send us what IP you are sending from
let HostIP = pm.environment.get('HostIP');
//urlPath is currently '' and should not be changed
let urlPath = '';
//rather than setting &format in the URL Variable scope, we now define an accept header
//accept can be either 'text/json' or 'text/xml'
let accept = pm.environment.get('accept');
//we also removed the uEncoded,pEncoded & orgEncoded from the URL variable scope and it is now set as an Authorization header
//All values should be URIencoded
let Authorization = 'uencoded='+encodeURIComponent(pm.environment.get('uEncoded'))+'&pencoded='+encodeURIComponent(pm.environment.get('pEncoded'))+'&orgEncoded='+encodeURIComponent(pm.environment.get('orgEncoded'));
//Setting the first field to our request type GET|POST
let payload = [requestType];
//If the HostIP hasn't been set then we can exclude that from our Auth string. Just remember to also exclude it from your header
if (typeof HostIP != 'undefined') {
payload.push(HostIP);
pm.environment.set("HostIP", HostIP);
}
//We now add the rest of the fields needed to our payload array
payload.push(urlPath);
payload.push(accept);
payload.push(Authorization);
payload.push(isotimestamp);
payload.push(VarString);
//Create our hash using all of the fields we added to the payload array as a string, separated by '+' and encoded with our secret_key
let hash = CryptoJS.HmacSHA512( payload.join('+'), secret_key);
//Update the environment variables
pm.environment.set("urlPath", urlPath);
pm.environment.set("accept", accept);
pm.environment.set("Authorization", Authorization);
pm.environment.set("af_hmac_signature", hash.toString());
pm.environment.set("af_iso_timestamp", isotimestamp);
}//end function
```
### Example Responses
#### Get Tasklabours (OK 200)
```json
{
"status": "0",
"statusmessage": "Login OK",
"zoneresponse": {
"maxpageresults": "500",
"pagenumber": "1",
"queryresponsetimes": {
"labours": 42
},
"currentpageresults": 1,
"labours": [
{
"labverified": "false",
"task": {
"taskid": "JSZaXyVQPFggCg==",
"status": "Not Started",
"org": {
"orgid": "JCdKUyZRMCAgCg==",
"orgname": "Bradley Sandbox"
},
"linkprocesseddate": " ",
"refcode": "Aardva5",
"jobnumber": "1049",
"linkprocessed": "false",
"client": {
"clientid": "JCdKUydSQCAgCg==",
"clientname": "Aardvaark ConsultantsCLR2"
}
},
"worktype": "NT",
"workdatetimeend": "2018/10/23 09:00:00",
"lablinkprocesseddatetime": "2018/10/23",
"endtime": "Oct 23, 2018 9:00:00 AM",
"lablinkprocesseddate": "2018/10/23",
"deleted": "0",
"user": {
"userid": "JCQ6XyRRUCAgCg==",
"username": "Bradley Sandbox"
},
"lablinkprocessed": "false",
"cost": "0.0000",
"starttime": "Oct 23, 2018 7:00:00 AM",
"deleteddate": "",
"hours": "2.00",
"sell": "83.0000",
"lineid": "JSYqQyVRXFQgCg==",
"workdatetimestart": "2018/10/23 07:00:00",
"note": "this is a task labour",
"lablocked": "false",
"deletedtime": "",
"deleteddatetime": " ",
"workdate": "2018/10/23"
}
]
}
}
```
