Overview

Namespaces

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

Classes

  • RestCreatedResponse
  • RestInfoMethods
  • RestRepository
  • RestRepositoryFactory
  • Overview
  • Namespace
  • Class
  • Tree

Class RestInfoMethods

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.

PipelinerSales\ApiClient\Repository\Rest\RestInfoMethods implements PipelinerSales\ApiClient\InfoMethodsInterface
Namespace: PipelinerSales\ApiClient\Repository\Rest
Located at PipelinerSales/ApiClient/Repository/Rest/RestInfoMethods.php
Methods summary
public
# __construct( $baseUrl, PipelinerSales\ApiClient\Http\HttpInterface $httpClient )
public string
# fetchTeamPipelineUrl( )

Returns

string

Implementation of

PipelinerSales\ApiClient\InfoMethodsInterface::fetchTeamPipelineUrl()
public integer
# fetchTeamPipelineVersion( )

Returns

integer

Implementation of

PipelinerSales\ApiClient\InfoMethodsInterface::fetchTeamPipelineVersion()
public string
# fetchServerAPIUtcDateTime( )

Returns

string

Implementation of

PipelinerSales\ApiClient\InfoMethodsInterface::fetchServerAPIUtcDateTime()
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

Implementation of

PipelinerSales\ApiClient\InfoMethodsInterface::fetchErrorCodes()
public string[]
# fetchCollections( )

Returns a list of existing types of collections

Returns a list of existing types of collections

Returns

string[]

Implementation of

PipelinerSales\ApiClient\InfoMethodsInterface::fetchCollections()
public string[]
# fetchEntityPublic( )

Returns a list of existing types of entities

Returns a list of existing types of entities

Returns

string[]

Implementation of

PipelinerSales\ApiClient\InfoMethodsInterface::fetchEntityPublic()
public array
# fetchEntityFields( Entity|string $entityName )

Returns a list of fields that exist for a specified entity

Returns a list of fields that exist for a specified entity

Parameters

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

Returns

array

Implementation of

PipelinerSales\ApiClient\InfoMethodsInterface::fetchEntityFields()
public
# getHttpClient( )
public
# getBaseUrl( )
API documentation generated by ApiGen