Overview

Namespaces

  • PipelinerSales
    • ApiClient
      • Http
      • Query
      • Repository
        • Rest

Classes

  • Defaults
  • Entity
  • EntityCollection
  • EntityCollectionIterator
  • PipelinerClient

Interfaces

  • InfoMethodsInterface

Exceptions

  • PipelinerClientException
  • Overview
  • Namespace
  • Class
  • Tree

Interface InfoMethodsInterface

Methods for retrieving information describing data and configuration on the server.

See the Miscellaneous REST methods section at http://workspace.pipelinersales.com/community/api/data/Methods_rest.html for details.

Direct known implementers

PipelinerSales\ApiClient\Repository\Rest\RestInfoMethods
Namespace: PipelinerSales\ApiClient
Located at PipelinerSales/ApiClient/InfoMethodsInterface.php
Methods summary
public string
# fetchTeamPipelineUrl( )

Returns

string
public integer
# fetchTeamPipelineVersion( )

Returns

integer
public string
# fetchServerAPIUtcDateTime( )

Returns

string
public array
# fetchErrorCodes( )

Returns a list of possible error codes along with their messages

Returns a list of possible error codes along with their messages

Returns

array
public string[]
# fetchCollections( )

Returns a list of existing types of collections

Returns a list of existing types of collections

Returns

string[]
public string[]
# fetchEntityPublic( )

Returns a list of existing types of entities

Returns a list of existing types of entities

Returns

string[]
public array
# fetchEntityFields( PipelinerSales\ApiClient\Entity|string $entity )

Returns a list of fields that exist for a specified entity

Returns a list of fields that exist for a specified entity

Parameters

$entity
an entity object or a string with the entity's type (e.g. Account)

Returns

array
API documentation generated by ApiGen