ProjectsResourceApi.md

FortnoxApi\ProjectsResourceApi

All URIs are relative to http://localhost, except if the operation defines another base path.

Method	HTTP request	Description
createProjectsResource()	POST /3/projects	Create a project
getProjectsResource()	GET /3/projects/{ProjectNumber}	Retrieve a single project
listProjectsResource()	GET /3/projects	Retrieve a list of projects
removeProjectsResource()	DELETE /3/projects/{ProjectNumber}	Remove a project
updateProjectsResource()	PUT /3/projects/{ProjectNumber}	Update a project

createProjectsResource()

createProjectsResource($project): \FortnoxApi\Model\ProjectWrap

Create a project

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new FortnoxApi\Api\ProjectsResourceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$project = new \FortnoxApi\Model\ProjectWrap(); // \FortnoxApi\Model\ProjectWrap | to create

try {
    $result = $apiInstance->createProjectsResource($project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsResourceApi->createProjectsResource: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
project	\FortnoxApi\Model\ProjectWrap	to create	[optional]

Return type

\FortnoxApi\Model\ProjectWrap

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getProjectsResource()

getProjectsResource($project_number): \FortnoxApi\Model\ProjectWrap

Retrieve a single project

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new FortnoxApi\Api\ProjectsResourceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$project_number = 56; // int | identifies the project

try {
    $result = $apiInstance->getProjectsResource($project_number);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsResourceApi->getProjectsResource: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
project_number	int	identifies the project

Return type

\FortnoxApi\Model\ProjectWrap

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listProjectsResource()

listProjectsResource(): \FortnoxApi\Model\ProjectListItemList

Retrieve a list of projects

The project register can return a list of records or a single record. By specifying a ProjectNumber in the URL, a single record will be returned. If no ProjectNumber is provided, a list of records will be returned.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new FortnoxApi\Api\ProjectsResourceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->listProjectsResource();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsResourceApi->listProjectsResource: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\FortnoxApi\Model\ProjectListItemList

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

removeProjectsResource()

removeProjectsResource($project_number)

Remove a project

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new FortnoxApi\Api\ProjectsResourceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$project_number = 56; // int | identifies the project

try {
    $apiInstance->removeProjectsResource($project_number);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsResourceApi->removeProjectsResource: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
project_number	int	identifies the project

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateProjectsResource()

updateProjectsResource($project_number, $project): \FortnoxApi\Model\ProjectWrap

Update a project

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new FortnoxApi\Api\ProjectsResourceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$project_number = 56; // int | identifies the project
$project = new \FortnoxApi\Model\ProjectWrap(); // \FortnoxApi\Model\ProjectWrap | to update

try {
    $result = $apiInstance->updateProjectsResource($project_number, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsResourceApi->updateProjectsResource: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
project_number	int	identifies the project
project	\FortnoxApi\Model\ProjectWrap	to update	[optional]

Return type

\FortnoxApi\Model\ProjectWrap

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]