Class: CollectionUsersResponse

Classes_Responses~CollectionUsersResponse(fetchedResponse)

Represents an API response from the /collections/{collectionId}/users endpoint.

Constructor

new CollectionUsersResponse(fetchedResponse)

constructor - Creates an instance of CollectionUsersResponse based on the provided HTTPResponse.

Parameters:
Name Type Description
fetchedResponse HTTPResponse

The original response from the PSS Fleet Data API.

Source:

Extends

Members

metadata :CollectionMetadata

collection - The CollectionMetadata object contained in the response, if the responseJson is not null. Else, null.

Type:
  • CollectionMetadata
Source:

responseJson :object|Array.<object>

responseJson - The object or array of objects parsed from the JSON in the response, if the statusCode is in the 2xx range. Else, null.

Type:
  • object | Array.<object>
Overrides:
Source:

statusCode :integer

statusCode - The HTTP status code of the response.

Type:
  • integer
Overrides:
Source:

users :Array.<PssUser>

users - An array of PssUser objects contained in the response, if the responseJson is not null. Else, an empty array.

Type:
  • Array.<PssUser>
Source: