Navigation :

List Site Revisit Reasons

A GET request retrieves all the reasons associated with job status and site revisits, providing information on site revisit reasons. The reasons are consistent for both job status updates and revisits.

URLs

Environment	Method	URL
Sandbox		https://api-sandbox.fndev.net/api/rest/v2/company/company_id/site-revisit-reasons
Production		https://api.fieldnation.com/api/rest/v2/company/company_id/site-revisit-reasons

Path Parameters

Parameter	Type	Example	Notes
company_id	integer	10	Company ID.

Query Parameters

Refer to Pagination for a list of additional query parameters.

Parameter	Type	Example	Notes
access_token	string	abc123defg459hijk786lmn45	Required.
action_type	string	revisit	Required.

Body

Not applicable.

Response

Returns the Site Revisits Response.

Examples

200 Success Request


{
    "results": [
        {
            "reason_id": 1,
            "parent_reason_id": 0,
            "name": "Part issue",
            "is_custom_reason": false,
            "is_archived": false,
            "cloned_from_reason_id": 0,
            "sub_reasons": [
                {
                    "reason_id": 6,
                    "parent_reason_id": 1,
                    "name": "Part not onsite",
                    "is_custom_reason": false
                },
                {
                    "reason_id": 7,
                    "parent_reason_id": 1,
                    "name": "Part dead on arrival",
                    "is_custom_reason": false
                },
                {
                    "reason_id": 8,
                    "parent_reason_id": 1,
                    "name": "Incorrect part provided",
                    "is_custom_reason": false
                }
            ]
        },
        {
            "reason_id": 2,
            "parent_reason_id": 0,
            "name": "Site issue",
            "is_custom_reason": false,
            "is_archived": false,
            "cloned_from_reason_id": 0,
            "sub_reasons": [
                {
                    "reason_id": 9,
                    "parent_reason_id": 2,
                    "name": "Lift/Tool issue",
                    "is_custom_reason": false
                },
                {
                    "reason_id": 10,
                    "parent_reason_id": 2,
                    "name": "Site turnaway",
                    "is_custom_reason": false
                }
            ]
        },
        {
            "reason_id": 3,
            "parent_reason_id": 0,
            "name": "Additional time/scope required",
            "is_custom_reason": false,
            "is_archived": false,
            "cloned_from_reason_id": 0,
            "sub_reasons": [
                {
                    "reason_id": 11,
                    "parent_reason_id": 3,
                    "name": "Start time delays",
                    "is_custom_reason": false
                },
                {
                    "reason_id": 12,
                    "parent_reason_id": 3,
                    "name": "Bridge line delays",
                    "is_custom_reason": false
                },
                {
                    "reason_id": 13,
                    "parent_reason_id": 3,
                    "name": "Site specific condition",
                    "is_custom_reason": false
                },
                {
                    "reason_id": 14,
                    "parent_reason_id": 3,
                    "name": "Technical complications",
                    "is_custom_reason": false
                }
            ]
        },
        {
            "reason_id": 4,
            "parent_reason_id": 0,
            "name": "Other",
            "is_custom_reason": false,
            "is_archived": false,
            "cloned_from_reason_id": 0,
            "sub_reasons": [
                {
                    "reason_id": 5,
                    "parent_reason_id": 4,
                    "name": "Unable to complete",
                    "is_custom_reason": false
                }
            ]
        }
    ]
}

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

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

Errors

Standard HTTP and OAuth error codes.