Navigation :

Update Work Order Site Revisits

A PUT request updates the reasons and billable information for a work order, allowing for accurate tracking of site revisits for a specific site or work order.

URLs

Environment	Method	URL
Sandbox		https://api-sandbox.fndev.net/api/rest/v2/workorders/work_order_id/site-revisit/revisit_id
Production		https://api.fieldnation.com/api/rest/v2/workorders/work_order_id/site-revisit/revisit_id

Path Parameters

Parameter	Type	Example	Notes
work_order_id	integer	729	Work Order ID.
revisit_id	integer	13	Revisit ID.

Query Parameters

Parameter	Type	Example	Notes
access_token	string	abc123defg459hijk786lmn45	Required.

Body Parameters

Update a Site Completion & Revisit

Examples


    {
        "revisit_reason": 13,
        "is_billable": false
    }

Refer to site revisits swagger document for parameter details and examples.

Environment	URL
Sandbox	https://api-sandbox.fndev.net/api/rest/v2/swagger/#/workorder/updateSiteRevisitByWorkOrder
Production	https://api.fieldnation.com/api/rest/v2/swagger/#/workorder/updateSiteRevisitByWorkOrder

Response

Returns the Site Revisits Response.

Examples

200 Success Request


    {
    "revisits": [
        {
            "revisit_id": 13,
            "reason": {
                "id": 13,
                "label": "Site specific condition"
            },
            "is_billable": false,
            "history": [
                {
                    "revisit_id": 13,
                    "label": "Revisit added. (Site specific condition / Not billable)",
                    "author": {
                        "id": 547,
                        "first_name": "Buyer",
                        "last_name": "Admin"
                    },
                    "created_at": {
                        "time_zone": "America/Chicago",
                        "local": {
                            "date": "2024-10-16",
                            "time": "02:12:40"
                        },
                        "utc": "2024-10-16 02:12:40"
                    }
                }
            ]
        }
    ],
    "job_status": {
        "status": "incomplete",
        "reason": {
            "id": 8,
            "label": "Incorrect part provided"
        },
        "history": [
            {
                "label": "Job status updated. (Incomplete / Incorrect part provided)",
                "author": {
                    "id": 547,
                    "first_name": "Buyer",
                    "last_name": "Admin"
                },
                "created_at": {
                    "time_zone": "America/Chicago",
                    "local": {
                        "date": "2024-10-15",
                        "time": "10:37:54"
                    },
                    "utc": "2024-10-15 10:37:54"
                }
            },
            {
                "label": "Job status updated. (Complete)",
                "author": {
                    "id": 547,
                    "first_name": "Buyer",
                    "last_name": "Admin"
                },
                "created_at": {
                    "time_zone": "America/Chicago",
                    "local": {
                        "date": "2024-10-14",
                        "time": "11:16:34"
                    },
                    "utc": "2024-10-14 11:16:34"
                }
            },
            {
                "label": "Job status updated. (Incomplete / Part not onsite)",
                "author": {
                    "id": 547,
                    "first_name": "Buyer",
                    "last_name": "Admin"
                },
                "created_at": {
                    "time_zone": "America/Chicago",
                    "local": {
                        "date": "2024-10-14",
                        "time": "11:15:43"
                    },
                    "utc": "2024-10-14 11:15:43"
                }
            },
            {
                "label": "Job status added. (Complete)",
                "author": {
                    "id": 25,
                    "first_name": "Provider",
                    "last_name": "User"
                },
                "created_at": {
                    "time_zone": "America/Chicago",
                    "local": {
                        "date": "2024-10-14",
                        "time": "11:07:44"
                    },
                    "utc": "2024-10-14 11:07:44"
                }
            }
        ]
    },
    "incident_id": "tarek",
    "related_work_orders": [
        {
            "id": 729,
            "title": "client api 3547 update"
        }
    ]
    }

Refer to site revisits swagger document for parameter details and examples.

Environment	URL
Sandbox	https://api-sandbox.fndev.net/api/rest/v2/swagger/#/workorder/updateSiteRevisitByWorkOrder
Production	https://api.fieldnation.com/api/rest/v2/swagger/#/workorder/updateSiteRevisitByWorkOrder

Errors

Standard HTTP and OAuth error codes.

Examples

404 Not Found

Site revisit does not exists.


{
    "message": "Site revisit does not exists",
    "trace": [],
    "extra": []
}