API - Workers - Retrieve List

Request:

GET /api2/workers/?apiKey=XXXXXX {

_body: true/false <--- if true, returns more details

offset: 1 <--- start at record #

limit: 2 <--- count of records to return

approved: 1  <--- only returned approved workers

vehicle: 1  <--- return vehicles instead of workers

}

Response:

{

"offset": "",

"limit": 25,

"first": "http:\/\/localhost\/jbug\/trunk\/api2\/workers?offset=0&limit=25",

"next": "http:\/\/localhost\/jbug\/trunk\/api2\/workers?offset=25&limit=25",

"previous": "http:\/\/localhost\/jbug\/trunk\/api2\/workers?offset=0&limit=25",

"items": [

{

"id": "2",

"wuname": "lazyjoe",

"regtime": "2007-09-04T13:52:44-04:00",

"modifiedtime": "",

"lastvisit": "2009-02-02T18:19:23-05:00",

"approved": "Yes",

"firstname": "Lazy",

"lastname": "Joe",

"address": "1234 Woodlawn Rd.",

"city": "Akron",

"state": "OH",

"zip": "44306",

"country": "",

"hphone": "(330) 555-5123",

"cphone": "",

"ophone": "",

"email": "lazyjoe@inflatableoffice.com",

"rank": "1",

"notes": "",

"gcalendarid": "",

"payrate": "6.50",

"overviewfilter": "1",

"carrier": "",

"commission_percentage": "0.00",

"commission_rentalsubtotal": "0",

"commission_staffcosts": "0",

"commission_deliveryfees": "0",

"commission_fees": "0",

"commission_couponspackages": "0",

"commission_specials": "0",

"commission_discounts": "0",

"commission_salestax": "0",

"hideshifts": "0",

"mileagerate": "0.00",

"mileagestart": "0",

"lattitude": "",

"longitude": "",

"weightcapacity": "",

"mpg": "",

"href": "http:\/\/localhost\/jbug\/trunk\/api2\/workers\/2",

"regtime_ts": "1188928364",

"regtime_utc": "2007-09-04T17:52:44Z",

"modifiedtime_ts": "",

"modifiedtime_utc": "",

"lastvisit_ts": "1233616763",

"lastvisit_utc": "2009-02-02T23:19:23Z"

},

{

"id": "1",

"wuname": "Test",

"regtime": "2007-09-04T13:52:44-04:00",

"modifiedtime": "",

"lastvisit": "2009-02-02T18:19:23-05:00",

"approved": "Yes",

"firstname": "Jim",

"lastname": "Jones",

"address": "1234 Woodlawn Rd.",

"city": "Akron",

"state": "OH",

"zip": "44306",

"country": "",

"hphone": "(330) 555-5123",

"cphone": "",

"ophone": "",

"email": "test@inflatableoffice.com",

"rank": "5",

"notes": "",

"gcalendarid": "",

"payrate": "10.00",

"overviewfilter": "1",

"carrier": "",

"commission_percentage": "0.00",

"commission_rentalsubtotal": "0",

"commission_staffcosts": "0",

"commission_deliveryfees": "0",

"commission_fees": "0",

"commission_couponspackages": "0",

"commission_specials": "0",

"commission_discounts": "0",

"commission_salestax": "0",

"hideshifts": "0",

"mileagerate": "0.00",

"mileagestart": "0",

"lattitude": "",

"longitude": "",

"weightcapacity": "",

"mpg": "",

"href": "http:\/\/localhost\/jbug\/trunk\/api2\/workers\/1",

"regtime_ts": "1188928364",

"regtime_utc": "2007-09-04T17:52:44Z",

"modifiedtime_ts": "",

"modifiedtime_utc": "",

"lastvisit_ts": "1233616763",

"lastvisit_utc": "2009-02-02T23:19:23Z"

},

{

"id": "546",

"wuname": "ssmith",

"regtime": "",

"modifiedtime": "",

"lastvisit": "",

"approved": "Yes",

"firstname": "Kim",

"lastname": "Speedster",

"address": "",

"city": "",

"state": "OH",

"zip": "",

"country": "",

"hphone": "(330) 234-3032",

"cphone": "",

"ophone": "",

"email": "kimmy222@yahoo.com",

"rank": "4",

"notes": "",

"gcalendarid": "",

"payrate": "9.00",

"overviewfilter": "1",

"carrier": "",

"commission_percentage": "0.00",

"commission_rentalsubtotal": "0",

"commission_staffcosts": "0",

"commission_deliveryfees": "0",

"commission_fees": "0",

"commission_couponspackages": "0",

"commission_specials": "0",

"commission_discounts": "0",

"commission_salestax": "0",

"hideshifts": "0",

"mileagerate": "0.00",

"mileagestart": "0",

"lattitude": "",

"longitude": "",

"weightcapacity": "",

"mpg": "",

"href": "http:\/\/localhost\/jbug\/trunk\/api2\/workers\/546",

"regtime_ts": "0",

"regtime_utc": "",

"modifiedtime_ts": "",

"modifiedtime_utc": "",

"lastvisit_ts": "0",

"lastvisit_utc": ""

}

]

}

Is article helpful?