# Retrieve Remote Office Compliance Report

Retrieves the remote office compliance report with patch status per remote office.

## Endpoint

`GET /dcapi/patch/reports/roCompliance`

## Request

### Request URL

`https://{server-hostname}:8383/dcapi/patch/reports/roCompliance`

### Scope

`PatchMgmt.READ`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

### Sample Request

```curl
curl --request GET \
  --url https://appdomain/dcapi/patch/reports/roCompliance \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP Code 200

#### Response Body: application/json

- JSON object
  - **Links** — JSON object
    - Pagination links for next and previous pages
  - **messageResponse** — JSON array
    - Array of remote office compliance entries
  - **metadata** — JSON object
    - Pagination metadata
  - **status** — string
    - Operation result: success
  - **totalPages** — string
    - Total number of pages available
  - **totalRecords** — string
    - Total number of records matching the query

### Sample Response: HTTP 200

Remote office compliance data

```json
{
  "metadata": {
    "limit": 25,
    "page": 1
  },
  "totalRecords": 2,
  "messageResponse": [
    {
      "CompliancePercentage": "0%",
      "NonCompliantSystems": "10",
      "ComplianceStatus": "Non-compliant",
      "CompliantSystems": "0",
      "MissingPatches": "193",
      "RemoteOfficeName": "localOfficeOne",
      "ManagedComputers": "10",
      "InstalledPatches": "40"
    },
    {
      "CompliancePercentage": "0%",
      "NonCompliantSystems": "14",
      "ComplianceStatus": "Non-compliant",
      "CompliantSystems": "0",
      "MissingPatches": "457",
      "RemoteOfficeName": "Default Remote Office",
      "ManagedComputers": "14",
      "InstalledPatches": "16"
    }
  ],
  "totalPages": 1,
  "Links": {
    "next": null,
    "prev": null
  },
  "status": "success"
}
```

### HTTP Code 500

#### Response Body: application/json

- JSON object
  - **error_code** — string
    - Error code: INTERNAL_ERROR for server-side failures
  - **error_description** — string
    - Localized error description: dc.rest.api_internal_error

### Sample Response: HTTP 500

Server-side error

```json
{
  "error_description": "dc.rest.api_internal_error",
  "error_code": "INTERNAL_ERROR"
}
```

## Possible Response Codes

- **200** — HTTP code
- **500** — HTTP code

## Rate Limit

![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**Duration:** 1 minute | **Threshold:** 50 | **Lock period:** 5 minutes

Duration - Time window for the threshold.  
Threshold - Number of API calls allowed within the specified duration.  
Lock Period - Wait time before consecutive API requests.