Recommend this page to a friend! |
Classes of Francesco Danti | Scloby Client API | docs/Api/RawMaterialsApi.md | Download |
|
![]() Swagger\Client\RawMaterialsApiAll URIs are relative to https://api.scloby.com/v2 Method | HTTP request | Description ------------- | ------------- | ------------- rawMaterialsGet | GET /raw_materials | Get All Raw Materials rawMaterialsIdDelete | DELETE /raw_materials/{id} | Delete existing Raw material rawMaterialsIdGet | GET /raw_materials/{id} | Get existing raw Material rawMaterialsIdPut | PUT /raw_materials/{id} | Edit existing Raw material rawMaterialsPost | POST /raw_materials | Add new Raw material rawMaterialsGet> \Swagger\Client\Model\RawMaterial rawMaterialsGet($pagination, $per_page, $page) Get All Raw Materials Return a JSON with data about all Raw materials Example
ParametersName | Type | Description | Notes ------------- | ------------- | ------------- | ------------- pagination | bool| Pagination parameter | [optional] per_page | int| Results_per_page | [optional] page | int| PAGE_NUMBER(starting from 0 to TOTAL_PAGE-1) | [optional] Return type\Swagger\Client\Model\RawMaterial AuthorizationHTTP request headers- Content-Type: Not defined - Accept: application/json [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) rawMaterialsIdDelete> rawMaterialsIdDelete($id) Delete existing Raw material In this case you must specify the id in the URL, but it is no necessary in the request body Example
ParametersName | Type | Description | Notes ------------- | ------------- | ------------- | ------------- id | string| id of the raw material that need to be deleted | Return typevoid (empty response body) AuthorizationHTTP request headers- Content-Type: Not defined - Accept: Not defined [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) rawMaterialsIdGet> \Swagger\Client\Model\RawMaterial rawMaterialsIdGet($id) Get existing raw Material In this case you must specify the id in the URL Example
ParametersName | Type | Description | Notes ------------- | ------------- | ------------- | ------------- id | string| id of the Raw material | Return type\Swagger\Client\Model\RawMaterial AuthorizationHTTP request headers- Content-Type: Not defined - Accept: application/json [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) rawMaterialsIdPut> \Swagger\Client\Model\RawMaterial rawMaterialsIdPut($body, $id) Edit existing Raw material In this case you must specify the id in the URL and change the data you wanna update Example
ParametersName | Type | Description | Notes ------------- | ------------- | ------------- | ------------- body | \Swagger\Client\Model\RawMaterial| Object data that need to be updated | id | string| id of the raw material that need to be updated | Return type\Swagger\Client\Model\RawMaterial AuthorizationHTTP request headers- Content-Type: application/json - Accept: application/json [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) rawMaterialsPost> \Swagger\Client\Model\RawMaterial rawMaterialsPost($body) Add new Raw material Returns a Json with the data of the new raw material Example
ParametersName | Type | Description | Notes ------------- | ------------- | ------------- | ------------- body | \Swagger\Client\Model\RawMaterial| Item object that needs to be added. | Return type\Swagger\Client\Model\RawMaterial AuthorizationHTTP request headers- Content-Type: application/json - Accept: application/json [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) |