Get a List of Stock Worksheets for a Job
Retrieves a list of worksheets based on jobs stock item.
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | GetStockWorksheetsForJob | Required |
JobId | Int | Filter by JobId. | Required |
JobRef | String | Filter by Job Reference. | Required |
StockItemId | Int | Filter by StockItemId. Filter the worksheets by a stock item Id. If left empty all stock items will be processed. | Optional |
UseMovement | Bool | Uses the stock movement for the job to retrieve stock items instead of the job stock. | Optional |
Response Codes
Code | Message | Information |
---|---|---|
0 | Response Data | See 'Response' example tab |
0 | There are no worksheets for the job specified. | No record found using the specified parameters |
2 | You must specify a valid JobId or JobReference parameter. | Mandatory parameter was not supplied |
2 | The StockItemId is missing or is in an incorrect format. | Integer value is invalid or was not specified (when required) |
2 | The JobId or JobReference provided does not return a valid job. | No record found using the specified parameters |
2 | The job has no stock items assigned to it from the parameters supplied. | No record found using the specified parameters |
2 | The job has no stock items assigned to it. | No record found using the specified parameters |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=GetStockWorksheetsForJob&JobId=60853970
Response Data
{ "Code": 0, "Result": [ { "Question": "Is the equipment being left on site?", "QuestionId": 2488877, "QuestionOrder": 1, "QuestionMandatory": false, "QuestionOnJob": true, "QuestionType": "Boolean", "AnswerId": 681219409, "AnswerText": "true", "AnswerNote": "", "AnswerDate": "2022-05-25 08:36", "StockItemId": 3919071 }, { "Question": "How many days?", "QuestionId": 2488878, "QuestionOrder": 2, "QuestionMandatory": false, "QuestionOnJob": true, "QuestionType": "NumberInteger", "AnswerId": 681219410, "AnswerText": "5", "AnswerNote": "", "AnswerDate": "2022-05-25 08:36", "StockItemId": 3919071 } ] }