Skip to content

Latest commit

 

History

History
974 lines (687 loc) · 32.7 KB

QuotesApi.md

File metadata and controls

974 lines (687 loc) · 32.7 KB

SternerStuff\InsightlyPHP\QuotesApi

All URIs are relative to https://api.insightly.com/v3.1

Method HTTP request Description
addChildEntity POST /Quotation/{id}/QuotationLineItem Adds a Quote Product to a Quote
addEntity POST /Quotation Adds a Quote
addFollow POST /Quotation/{id}/Follow Start following a Quote
deleteChildEntity DELETE /Quotation/{id}/QuotationDocument/{childEntityId} Deletes a Quote Document of a Quote
deleteChildEntity_0 DELETE /Quotation/{id}/QuotationLineItem/{childEntityId} Deletes a Quote Product of a Quote
deleteEntity DELETE /Quotation/{id} Deletes a Quote
deleteFollow DELETE /Quotation/{id}/Follow Stop following a Quote
deleteImageField DELETE /Quotation/{id}/ImageField/{fieldName} Deletes a Quote's Custom Image Field
getChildEntities GET /Quotation/{id}/QuotationDocument Gets a list of Quote Documents of a Quote
getChildEntities_0 GET /Quotation/{id}/QuotationLineItem Gets a list of Quote Products of a Quote
getEntities GET /Quotation Gets a list of Quotes
getEntitiesBySearch GET /Quotation/Search Gets a filtered list of Quotes
getEntity GET /Quotation/{id} Gets a Quote
getFollow GET /Quotation/{id}/Follow Gets a Follow state for a Quote
getImageField GET /Quotation/{id}/ImageField/{fieldName} Gets a Quote's Custom Image Field
updateChildEntity PUT /Quotation/{id}/QuotationLineItem Updates a Quote Product of a Quote
updateEntity PUT /Quotation Updates a Quote
updateImageField PUT /Quotation/{id}/ImageField/{fieldName}/{fileName} Updates a Quote's Custom Image Field

addChildEntity

object[] addChildEntity($id, $authorization, $api_child_entity)

Adds a Quote Product to a Quote

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\QuotesApi(
    // 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()
);
$id = 789; // int | A Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$api_child_entity = new \SternerStuff\InsightlyPHP\Model\APIQuotationLineItem(); // \SternerStuff\InsightlyPHP\Model\APIQuotationLineItem | The child entity to add (just include JSON object as request body)

try {
    $result = $apiInstance->addChildEntity($id, $authorization, $api_child_entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuotesApi->addChildEntity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int A Record's ID
authorization string Authorization [default to {{Authorization}}]
api_child_entity \SternerStuff\InsightlyPHP\Model\APIQuotationLineItem The child entity to add (just include JSON object as request body)

Return type

object[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/json

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

addEntity

object addEntity($authorization, $field_values)

Adds a Quote

If you have trouble with creating a Quote, try creating Quotes via the web interface, and then access those Quotes via the API. This way you can see examples of the fields and sub-elements attached to the Quote. A common source of problems during write/update request is caused when users omit required fields, or insert invalid data in a field (e.g. reference a CATEGORY_ID that does not exist in the user's Insightly instance.

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\QuotesApi(
    // 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()
);
$authorization = "{{Authorization}}"; // string | Authorization
$field_values = new \SternerStuff\InsightlyPHP\Model\\SternerStuff\InsightlyPHP\Model\FieldValues(); // \SternerStuff\InsightlyPHP\Model\FieldValues | The record to add (just include the JSON object as the request body)

try {
    $result = $apiInstance->addEntity($authorization, $field_values);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuotesApi->addEntity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
authorization string Authorization [default to {{Authorization}}]
field_values \SternerStuff\InsightlyPHP\Model\FieldValues The record to add (just include the JSON object as the request body)

Return type

object

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/json

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

addFollow

\SternerStuff\InsightlyPHP\Model\APIFollow addFollow($id, $authorization)

Start following a Quote

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\QuotesApi(
    // 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()
);
$id = 789; // int | A Record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $result = $apiInstance->addFollow($id, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuotesApi->addFollow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int A Record's ID (RECORD_ID)
authorization string Authorization [default to {{Authorization}}]

Return type

\SternerStuff\InsightlyPHP\Model\APIFollow

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/json

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

deleteChildEntity

deleteChildEntity($id, $child_entity_id, $authorization)

Deletes a Quote Document of a Quote

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\QuotesApi(
    // 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()
);
$id = 789; // int | A Record's ID
$child_entity_id = 789; // int | A child entity's ID
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $apiInstance->deleteChildEntity($id, $child_entity_id, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling QuotesApi->deleteChildEntity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int A Record's ID
child_entity_id int A child entity's ID
authorization string Authorization [default to {{Authorization}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/json

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

deleteChildEntity_0

deleteChildEntity_0($id, $child_entity_id, $authorization)

Deletes a Quote Product of a Quote

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\QuotesApi(
    // 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()
);
$id = 789; // int | A Record's ID
$child_entity_id = 789; // int | A child entity's ID
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $apiInstance->deleteChildEntity_0($id, $child_entity_id, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling QuotesApi->deleteChildEntity_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int A Record's ID
child_entity_id int A child entity's ID
authorization string Authorization [default to {{Authorization}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/json

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

deleteEntity

deleteEntity($id, $authorization)

Deletes a Quote

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\QuotesApi(
    // 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()
);
$id = 789; // int | Entity's ID
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $apiInstance->deleteEntity($id, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling QuotesApi->deleteEntity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int Entity's ID
authorization string Authorization [default to {{Authorization}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/json

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

deleteFollow

deleteFollow($id, $authorization)

Stop following a Quote

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\QuotesApi(
    // 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()
);
$id = 789; // int | A Record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $apiInstance->deleteFollow($id, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling QuotesApi->deleteFollow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int A Record's ID (RECORD_ID)
authorization string Authorization [default to {{Authorization}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/json

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

deleteImageField

deleteImageField($id, $field_name, $authorization)

Deletes a Quote's Custom Image Field

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\QuotesApi(
    // 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()
);
$id = 789; // int | A Record's ID
$field_name = "field_name_example"; // string | An image field name
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $apiInstance->deleteImageField($id, $field_name, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling QuotesApi->deleteImageField: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int A Record's ID
field_name string An image field name
authorization string Authorization [default to {{Authorization}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/json

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

getChildEntities

\SternerStuff\InsightlyPHP\Model\APIQuotationDocument[] getChildEntities($id, $authorization)

Gets a list of Quote Documents of a Quote

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\QuotesApi(
    // 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()
);
$id = 789; // int | A Record's ID
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $result = $apiInstance->getChildEntities($id, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuotesApi->getChildEntities: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int A Record's ID
authorization string Authorization [default to {{Authorization}}]

Return type

\SternerStuff\InsightlyPHP\Model\APIQuotationDocument[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/octet-stream, application/json

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

getChildEntities_0

object[] getChildEntities_0($id, $authorization)

Gets a list of Quote Products of a Quote

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\QuotesApi(
    // 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()
);
$id = 789; // int | A Record's ID
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $result = $apiInstance->getChildEntities_0($id, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuotesApi->getChildEntities_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int A Record's ID
authorization string Authorization [default to {{Authorization}}]

Return type

object[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/octet-stream, application/json

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

getEntities

object[] getEntities($authorization, $brief, $skip, $top, $count_total)

Gets a list of Quotes

Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\QuotesApi(
    // 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()
);
$authorization = "{{Authorization}}"; // string | Authorization
$brief = false; // bool | Optional, true if response should only contain top level properties of the record.
$skip = 56; // int | Optional, number of records to skip.
$top = 56; // int | Optional, maximum number of records to return in the response.
$count_total = false; // bool | Optional,true if total number of records should be returned in the response headers.

try {
    $result = $apiInstance->getEntities($authorization, $brief, $skip, $top, $count_total);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuotesApi->getEntities: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
authorization string Authorization [default to {{Authorization}}]
brief bool Optional, true if response should only contain top level properties of the record. [optional] [default to false]
skip int Optional, number of records to skip. [optional]
top int Optional, maximum number of records to return in the response. [optional]
count_total bool Optional,true if total number of records should be returned in the response headers. [optional] [default to false]

Return type

object[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/octet-stream, application/json

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

getEntitiesBySearch

object[] getEntitiesBySearch($authorization, $field_name, $field_value, $updated_after_utc, $brief, $skip, $top, $count_total)

Gets a filtered list of Quotes

To filter with a field name and value, both field_name and field_value parameters must be provided.
Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\QuotesApi(
    // 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()
);
$authorization = "{{Authorization}}"; // string | Authorization
$field_name = "field_name_example"; // string | Optional, field name for object
$field_value = "field_value_example"; // string | Optional, field value of the record
$updated_after_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Optional, earliest date when a record was last updated.
$brief = false; // bool | Optional, true if response should only contain top level properties of the record.
$skip = 56; // int | Optional, number of records to skip.
$top = 56; // int | Optional, maximum number of records to return in the response.
$count_total = false; // bool | Optional, true if total number of records should be returned in the response headers.

try {
    $result = $apiInstance->getEntitiesBySearch($authorization, $field_name, $field_value, $updated_after_utc, $brief, $skip, $top, $count_total);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuotesApi->getEntitiesBySearch: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
authorization string Authorization [default to {{Authorization}}]
field_name string Optional, field name for object [optional]
field_value string Optional, field value of the record [optional]
updated_after_utc \DateTime Optional, earliest date when a record was last updated. [optional]
brief bool Optional, true if response should only contain top level properties of the record. [optional] [default to false]
skip int Optional, number of records to skip. [optional]
top int Optional, maximum number of records to return in the response. [optional]
count_total bool Optional, true if total number of records should be returned in the response headers. [optional] [default to false]

Return type

object[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/octet-stream, application/json

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

getEntity

object getEntity($id, $authorization)

Gets a Quote

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\QuotesApi(
    // 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()
);
$id = 789; // int | The record's ID
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $result = $apiInstance->getEntity($id, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuotesApi->getEntity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int The record's ID
authorization string Authorization [default to {{Authorization}}]

Return type

object

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/octet-stream, application/json

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

getFollow

\SternerStuff\InsightlyPHP\Model\APIFollow getFollow($id, $authorization)

Gets a Follow state for a Quote

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\QuotesApi(
    // 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()
);
$id = 789; // int | A record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $result = $apiInstance->getFollow($id, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuotesApi->getFollow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int A record's ID (RECORD_ID)
authorization string Authorization [default to {{Authorization}}]

Return type

\SternerStuff\InsightlyPHP\Model\APIFollow

Authorization

No authorization required

HTTP request headers

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

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

getImageField

getImageField($id, $field_name, $authorization)

Gets a Quote's Custom Image Field

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\QuotesApi(
    // 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()
);
$id = 789; // int | A Record's ID
$field_name = "field_name_example"; // string | An image field name
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $apiInstance->getImageField($id, $field_name, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling QuotesApi->getImageField: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int A Record's ID
field_name string An image field name
authorization string Authorization [default to {{Authorization}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/octet-stream, application/json

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

updateChildEntity

object[] updateChildEntity($id, $authorization, $api_child_entity)

Updates a Quote Product of a Quote

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\QuotesApi(
    // 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()
);
$id = 789; // int | A Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$api_child_entity = new \SternerStuff\InsightlyPHP\Model\APIQuotationLineItem(); // \SternerStuff\InsightlyPHP\Model\APIQuotationLineItem | The child entity to add (just include the JSON object as request body)

try {
    $result = $apiInstance->updateChildEntity($id, $authorization, $api_child_entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuotesApi->updateChildEntity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int A Record's ID
authorization string Authorization [default to {{Authorization}}]
api_child_entity \SternerStuff\InsightlyPHP\Model\APIQuotationLineItem The child entity to add (just include the JSON object as request body)

Return type

object[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/json

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

updateEntity

object updateEntity($authorization, $field_values)

Updates a Quote

If you have trouble updating a Quote, try accessing the Quote via the GET request to inspect its fields and sub-elements. A common source of problems with write/update requests occurs when users either omit required fields, or insert invalid data into a field (for example, by referring a CATEGORY_ID or LINK_ID which does not exist.

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\QuotesApi(
    // 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()
);
$authorization = "{{Authorization}}"; // string | Authorization
$field_values = new \SternerStuff\InsightlyPHP\Model\\SternerStuff\InsightlyPHP\Model\FieldValues(); // \SternerStuff\InsightlyPHP\Model\FieldValues | The record to update (just include the JSON object as the request body)

try {
    $result = $apiInstance->updateEntity($authorization, $field_values);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuotesApi->updateEntity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
authorization string Authorization [default to {{Authorization}}]
field_values \SternerStuff\InsightlyPHP\Model\FieldValues The record to update (just include the JSON object as the request body)

Return type

object

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/json

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

updateImageField

object[] updateImageField($id, $field_name, $file_name, $authorization, $file)

Updates a Quote's Custom Image Field

This action will replace any existing Image attached to the Quote's image field. The contents of the image data should be sent as binary data in the request payload. See our <a href="http://github.com/Insightly\" target="_blank">client libraries for an example of how this is done.

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\QuotesApi(
    // 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()
);
$id = 789; // int | A Record's ID
$field_name = "field_name_example"; // string | An image field name
$file_name = "file_name_example"; // string | An image file name
$authorization = "{{Authorization}}"; // string | Authorization
$file = "B"; // string | File to upload

try {
    $result = $apiInstance->updateImageField($id, $field_name, $file_name, $authorization, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuotesApi->updateImageField: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int A Record's ID
field_name string An image field name
file_name string An image file name
authorization string Authorization [default to {{Authorization}}]
file string File to upload

Return type

object[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/octet-stream
  • Accept: application/json, text/json

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