Offices: GetReferenceCounts

This method returns a list of each type of object and the number of objects of that type referencing the specified office. Note that an office cannot be deleted while existing objects reference it.

Request

HTTP request

GET /restapi/v2/accounts/{accountId}/offices/{officeId}/reference_counts

Parameters

Parameter NameValueDescription
Path Parameters
officeIdinteger

(Required) The id of the office.

accountIdstring

(Required) The globally unique identifier (GUID) for the account.

Responses

CodeDescriptionReference
200

Reference counts successfully retrieved.

OfficeReferenceCountList
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Offices::GetReferenceCounts

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

OfficeReferenceCount

A complex element containing the number and type of each object referencing the office.

referenceTypestring

The type of object referencing the office.

referencedCountinteger

The number of objects of this type referencing the office.

OfficeReferenceCountList

Contains a list of each type of object and the number of objects of that type referencing the office.

referencesCounts[OfficeReferenceCount]

A list of each type of object and the number of objects of that type referencing the office.

}} />