2017 © Pedro Peláez
 

library axosoft-api

Module Axosift API wrapper

image

reliv/axosoft-api

Module Axosift API wrapper

  • Friday, February 2, 2018
  • by reliv
  • Repository
  • 7 Watchers
  • 0 Stars
  • 3,146 Installations
  • PHP
  • 2 Dependents
  • 0 Suggesters
  • 4 Forks
  • 0 Open issues
  • 14 Versions
  • 0 % Grown

The README.md

Module for Axosoft On-Time API

Description

PHP wrapper for Axosoft API, (*1)

Developers

This package contains a basic framework and a class structure for wrapping the API for AxoSoft (On-Time)., (*2)

Please help us finish these API classes. We have only written a limited number of classes to support our needs., (*3)

If you wish to use the API library and an API classe you require is missing, you may utilize the Generic classes to build requests., (*4)

Example of standard list call

    // Get AxosoftApi from ZF2 service manager
    $axosoftApi = $this->getServiceLocator()->get('Reliv\AxosoftApi\Service\AxosoftApi');

    // Build request
    $request = new ApiRequestList();
    $request->setProjectId(10);
    $request->setSearchString('search for me');
    $request->setSearchField('name');
    $request->setPage(1);
    $request->setPageSize(1);

    // Get Response
    $response = $axosoftApi->send($request);

    // Handle error
    if ($axosoftApi->hasError($response)) {
        throw new \Exception('Call Failed.');
    }

    $dataArray = $response->getResponseData();
    $someValue = $response->getResponseProperty('somekey');

Example of generic list call

    // Get AxosoftApi from ZF2 service manager
    $axosoftApi = $this->getServiceLocator()->get('Reliv\AxosoftApi\Service\AxosoftApi');

    // Build request
    $request = new GenericApiRequest('/api/v5/items');

    $request->setRequestParameter('project_id', 10);
    $request->setRequestParameter('search_string', 'search for me');
    $request->setRequestParameter('search_field', 'name');
    $request->setRequestParameter('page', 1);
    $request->setRequestParameter('page_size', 1);

    // Get Response
    $response = $axosoftApi->send($request);

    // Handle error
    if ($axosoftApi->hasError($response)) {
        throw new \Exception('Call Failed.');
    }

    $dataArray = $response->getResponseData();
    $someValue = $response->getResponseProperty('somekey');

ToDo

  • Write the rest of the API classes
  • Create API request validators
  • May implement command pattern to simplify API calls

The Versions

02/02 2018

dev-master

9999999-dev https://github.com/reliv/axosoft-api

Module Axosift API wrapper

  Sources   Download

BSD BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module axosoft ontime

02/02 2018

1.2.4

1.2.4.0 https://github.com/reliv/axosoft-api

Module Axosift API wrapper

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module axosoft ontime

02/02 2018

1.2.3

1.2.3.0 https://github.com/reliv/axosoft-api

Module Axosift API wrapper

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module axosoft ontime

31/03 2016

1.2.2

1.2.2.0 https://github.com/reliv/axosoft-api

Module Axosift API wrapper

  Sources   Download

BSD

The Requires

 

The Development Requires

by James Jervis

api zf2 module axosoft ontime

22/03 2016

1.2.0

1.2.0.0 https://github.com/reliv/axosoft-api

Module Axosift API wrapper

  Sources   Download

BSD

The Requires

 

The Development Requires

by James Jervis

api zf2 module axosoft ontime

22/03 2016

1.2.1

1.2.1.0 https://github.com/reliv/axosoft-api

Module Axosift API wrapper

  Sources   Download

BSD

The Requires

 

The Development Requires

by James Jervis

api zf2 module axosoft ontime

04/06 2015

1.1.0

1.1.0.0 https://github.com/reliv/axosoft-api

Module Axosift API wrapper

  Sources   Download

BSD

The Requires

 

The Development Requires

by James Jervis

api zf2 module axosoft ontime

20/05 2015

1.0.6

1.0.6.0 https://github.com/reliv/axosoft-api

Module Axosift API wrapper

  Sources   Download

BSD

The Requires

 

The Development Requires

by James Jervis

api zf2 module axosoft ontime

12/05 2015

1.0.5

1.0.5.0 https://github.com/reliv/axosoft-api

Module Axosift API wrapper

  Sources   Download

BSD

The Requires

 

by James Jervis

api zf2 module axosoft ontime

05/05 2015

1.0.4

1.0.4.0 https://github.com/reliv/axosoft-api

Module Axosift API wrapper

  Sources   Download

BSD

The Requires

 

by James Jervis

api zf2 module axosoft ontime

24/04 2015

1.0.3

1.0.3.0 https://github.com/reliv/axosoft-api

Module Axosift API wrapper

  Sources   Download

BSD

The Requires

 

by James Jervis

api zf2 module axosoft ontime

24/04 2015

1.0.2

1.0.2.0 https://github.com/reliv/axosoft-api

Module Axosift API wrapper

  Sources   Download

BSD

The Requires

 

by James Jervis

api zf2 module axosoft ontime

23/04 2015

1.0.1

1.0.1.0 https://github.com/reliv/axosoft-api

Module Axosift API wrapper

  Sources   Download

BSD

The Requires

 

by James Jervis

api zf2 module axosoft ontime

23/04 2015

1.0.0

1.0.0.0 https://github.com/reliv/axosoft-api

Module Axosift API wrapper

  Sources   Download

BSD

The Requires

 

by James Jervis

api zf2 module axosoft ontime