Weeding Jobs

Get Weeding Job

GET /api/.../weedingjobs/{id}

Return properties of a weeding job.

Request Information

Parameters
Name Type Required Description
id Integer Yes The id of the record set.

Response Information

Example
application/json, text/json 
{
    "RecordSetID": 328,
    "RecordSetName": "Weeding 2023-06-01",
    "OrganizationOwnerID": 82
    "OrganizationOwnerName": "Test Branch Eleven",
    "NumberOfRecords": 118,
    "WeedingTemplateID": 24,
    "WeedingTemplateName": "Weeding - Summer Titles",
    "WeedingStatusID": 1,
    "WeedingStatus": "Pending",
    "CreatorID": 1828,
    "CreatorName": "jane.smith",
    "CreationDate": "2021-06-14T16:37:08.077-04:00",
    "ModifierID": 2811,
    "ModifierName": "harold.stevens",
    "ModificationDate": "2022-11-08T09:23:04.504-04:00",
    "DiscardAmount": 47.83,
    "ExceedsDiscardAmountThreshold": false
}

HTTP Response Codes

Code Description
200 OK. Success
404 Not Found


Get All Weeding Jobs

GET /api/.../weedingjobs

Return all weeding jobs.

Response Information

Example
application/json, text/json 
[
    {
        "RecordSetID": 328,
        "RecordSetName": "Weeding 2023-06-01",
        "OrganizationOwnerID": 82
        "OrganizationOwnerName": "Test Branch Eleven",
        "NumberOfRecords": 118,
        "WeedingTemplateID": 24,
        "WeedingTemplateName": "Weeding - Summer Titles",
        "WeedingStatusID": 1,
        "WeedingStatus": "Pending",
        "CreatorID": 1828,
        "CreatorName": "jane.smith",
        "CreationDate": "2021-06-14T16:37:08.077-04:00",
        "ModifierID": 2811,
        "ModifierName": "harold.stevens",
        "ModificationDate": "2022-11-08T09:23:04.504-04:00",
        "DiscardAmount": 47.83,
        "ExceedsDiscardAmountThreshold": false
    }
]

HTTP Response Codes

Code Description
200 OK. Success
404 Not Found


Create Weeding Job

POST /api/.../weedingjobs

Create a new weeding job.

Request Information

Parameters
Name Type Required Description
DtoWeedingJobData WeedingJob Yes Define this parameter in the request body.
DtoWeedingJobData
Property Type Nullable Description
RecordSetID string No The unique id assigned to the record set.
WeedingTemplateID string No The unique id assigned to the weeding template.
WeedingStatusID string No The id assigned to the weeding status. Accepts: 1

Response Information

Example
application/json, text/json

True is returned upon success.

true

HTTP Response Codes

Code Description
200 OK. Success
400 Failure
404 Not Found


Update Weeding Job

PUT /api/.../weedingjobs/{id}

Update a weeding job.

Request Information

Parameters
Name Type Required Description
DtoWeedingJobData WeedingJob Yes Define this parameter in the request body.
DtoWeedingJobData
Property Type Nullable Description
RecordSetID string No The unique id assigned to the record set.
WeedingTemplateID string No The unique id assigned to the weeding template.
WeedingStatusID string No The id assigned to the weeding status. Accepts:
1 (Pending), 2 (In Review), 3 (Approval Requested), 4 (Approved)

Response Information

Example
application/json, text/json

True is returned upon success.

true

HTTP Response Codes

Code Description
200 OK. Success
400 Failure
404 Not Found


Bulk Update Weeding Jobs

PUT /api/.../weedingjobs

Update a list of weeding jobs.

Request Information

Parameters
Name Type Required Description
DtoWeedingJobBulkUpdateData WeedingJobs Yes Define this parameter in the request body.
DtoWeedingJobBulkUpdateData
Property Type Nullable Description
WeedingStatusID string No The id assigned to the weeding status.
Accepts: 1 (Pending), 4 (Approved)
RecordSetIDs List of integers No The list of record set identifiers to be updated.
WeedingAlertAcknowledged Boolean No Has the user acknowledged that the record set(s) include alerts.

Response Information

Example
application/json, text/json 
[
    {
        "FailedIDs": [
            1234,
            1238
        ],
        "SuccessIDs": [
            1235,
            1236,
            1237,
            1239,
            1240
        ]
    }
]

HTTP Response Codes

Code Description
200 OK. Success
400 Failure
404 Not Found