Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'fields', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'fieldset', 'basic'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api-v2.fattureincloud.it/c/:company_id/entities/suppliers/:supplier_id', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "data": {
-- "id": "<integer>",
-- "code": "<string>",
-- "name": "<string>",
-- "type": null,
-- "first_name": "<string>",
-- "last_name": "<string>",
-- "contact_person": "<string>",
-- "vat_number": "<string>",
-- "tax_code": "<string>",
-- "address_street": "<string>",
-- "address_postal_code": "<string>",
-- "address_city": "<string>",
-- "address_province": "<string>",
-- "address_extra": "<string>",
-- "country": "<string>",
-- "email": "<string>",
-- "certified_email": "<string>",
-- "phone": "<string>",
-- "fax": "<string>",
-- "notes": "<string>",
-- "bank_iban": "<string>",
-- "created_at": "<string>",
-- "updated_at": "<string>"
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'data.id'
DECLARE @Code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Code OUT, 'data.code'
DECLARE @Name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'data.name'
DECLARE @v_Type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'data.type'
DECLARE @First_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @First_name OUT, 'data.first_name'
DECLARE @Last_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Last_name OUT, 'data.last_name'
DECLARE @Contact_person nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Contact_person OUT, 'data.contact_person'
DECLARE @Vat_number nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Vat_number OUT, 'data.vat_number'
DECLARE @Tax_code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Tax_code OUT, 'data.tax_code'
DECLARE @Address_street nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Address_street OUT, 'data.address_street'
DECLARE @Address_postal_code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Address_postal_code OUT, 'data.address_postal_code'
DECLARE @Address_city nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Address_city OUT, 'data.address_city'
DECLARE @Address_province nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Address_province OUT, 'data.address_province'
DECLARE @Address_extra nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Address_extra OUT, 'data.address_extra'
DECLARE @Country nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Country OUT, 'data.country'
DECLARE @v_Email nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Email OUT, 'data.email'
DECLARE @Certified_email nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Certified_email OUT, 'data.certified_email'
DECLARE @Phone nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Phone OUT, 'data.phone'
DECLARE @Fax nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Fax OUT, 'data.fax'
DECLARE @Notes nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Notes OUT, 'data.notes'
DECLARE @Bank_iban nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Bank_iban OUT, 'data.bank_iban'
DECLARE @Created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'data.created_at'
DECLARE @Updated_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Updated_at OUT, 'data.updated_at'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -G -d "fields=%3Cstring%3E"
-d "fieldset=basic"
-H "Authorization: Bearer <access_token>"
-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/entities/suppliers/:supplier_id
Postman Collection Item JSON
{
"name": "Get Supplier",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "scope",
"value": "entity.clients:r entity.clients:a entity.suppliers:r entity.suppliers:a products:r products:a issued_documents.invoices:r issued_documents.credit_notes:r issued_documents.receipts:r issued_documents.orders:r issued_documents.quotes:r issued_documents.proformas:r issued_documents.delivery_notes:r issued_documents.work_reports:r issued_documents.supplier_orders:r issued_documents.self_invoices:r issued_documents.invoices:a issued_documents.credit_notes:a issued_documents.receipts:a issued_documents.orders:a issued_documents.quotes:a issued_documents.proformas:a issued_documents.delivery_notes:a issued_documents.work_reports:a issued_documents.supplier_orders:a issued_documents.self_invoices:a received_documents:r received_documents:a stock:r stock:a receipts:r receipts:a taxes:r taxes:a archive:r archive:a cashbook:r cashbook:a settings:r settings:a situation:r",
"type": "string"
},
{
"key": "redirect_uri",
"value": "https://api-v2.fattureincloud.it/oauth/token",
"type": "string"
},
{
"key": "accessTokenUrl",
"value": "https://api-v2.fattureincloud.it/oauth/token",
"type": "string"
},
{
"key": "authUrl",
"value": "https://api-v2.fattureincloud.it/oauth/authorize",
"type": "string"
},
{
"key": "grant_type",
"value": "authorization_code",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/entities/suppliers/:supplier_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"entities",
"suppliers",
":supplier_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
},
{
"key": "supplier_id",
"value": "<integer>"
}
]
},
"description": "Gets the specified supplier."
},
"response": [
{
"name": "Example response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/entities/suppliers/:supplier_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"entities",
"suppliers",
":supplier_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id"
},
{
"key": "supplier_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"id\": \"<integer>\",\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": null,\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"contact_person\": \"<string>\",\n \"vat_number\": \"<string>\",\n \"tax_code\": \"<string>\",\n \"address_street\": \"<string>\",\n \"address_postal_code\": \"<string>\",\n \"address_city\": \"<string>\",\n \"address_province\": \"<string>\",\n \"address_extra\": \"<string>\",\n \"country\": \"<string>\",\n \"email\": \"<string>\",\n \"certified_email\": \"<string>\",\n \"phone\": \"<string>\",\n \"fax\": \"<string>\",\n \"notes\": \"<string>\",\n \"bank_iban\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\"\n }\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/entities/suppliers/:supplier_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"entities",
"suppliers",
":supplier_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id"
},
{
"key": "supplier_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/entities/suppliers/:supplier_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"entities",
"suppliers",
":supplier_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id"
},
{
"key": "supplier_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
