Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
' Use this online tool to generate code from sample JSON: Generate Code to Create JSON
' The following JSON is sent in the request body.
' {
' "data": {
' "date": "<date>",
' "description": "<string>",
' "category": "<string>",
' "id": "<integer>",
' "attachment_url": "<string>",
' "attachment_token": "<string>"
' }
' }
Dim json As New Chilkat.JsonObject
json.UpdateString("data.date","<date>")
json.UpdateString("data.description","<string>")
json.UpdateString("data.category","<string>")
json.UpdateString("data.id","<integer>")
json.UpdateString("data.attachment_url","<string>")
json.UpdateString("data.attachment_token","<string>")
http.SetRequestHeader("Content-Type","application/json")
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("Accept","application/json")
Dim sbRequestBody As New Chilkat.StringBuilder
json.EmitSb(sbRequestBody)
Dim resp As Chilkat.HttpResponse = http.PTextSb("PUT","https://api-v2.fattureincloud.it/c/:company_id/archive/:document_id",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "data": {
' "id": "<integer>",
' "date": "<date>",
' "description": "<string>",
' "attachment_url": "<string>",
' "category": "<string>",
' "attachment_token": "<string>"
' }
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim Id As String = jResp.StringOf("data.id")
Dim Date As String = jResp.StringOf("data.date")
Dim Description As String = jResp.StringOf("data.description")
Dim Attachment_url As String = jResp.StringOf("data.attachment_url")
Dim Category As String = jResp.StringOf("data.category")
Dim Attachment_token As String = jResp.StringOf("data.attachment_token")
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"date": "<date>",
"description": "<string>",
"category": "<string>",
"id": "<integer>",
"attachment_url": "<string>",
"attachment_token": "<string>"
}
}'
https://api-v2.fattureincloud.it/c/:company_id/archive/:document_id
Postman Collection Item JSON
{
"name": "Modify Archive Document",
"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": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"date\": \"<date>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"id\": \"<integer>\",\n \"attachment_url\": \"<string>\",\n \"attachment_token\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/c/:company_id/archive/:document_id",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"archive",
":document_id"
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
},
{
"key": "document_id",
"value": "<integer>"
}
]
},
"description": "Modifies the specified archive document."
},
"response": [
{
"name": "The modified Archived Document",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"date\": \"<date>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"id\": \"<integer>\",\n \"attachment_url\": \"<string>\",\n \"attachment_token\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/c/:company_id/archive/:document_id",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"archive",
":document_id"
],
"variable": [
{
"key": "company_id"
},
{
"key": "document_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"id\": \"<integer>\",\n \"date\": \"<date>\",\n \"description\": \"<string>\",\n \"attachment_url\": \"<string>\",\n \"category\": \"<string>\",\n \"attachment_token\": \"<string>\"\n }\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"date\": \"<date>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"id\": \"<integer>\",\n \"attachment_url\": \"<string>\",\n \"attachment_token\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/c/:company_id/archive/:document_id",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"archive",
":document_id"
],
"variable": [
{
"key": "company_id"
},
{
"key": "document_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"date\": \"<date>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"id\": \"<integer>\",\n \"attachment_url\": \"<string>\",\n \"attachment_token\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/c/:company_id/archive/:document_id",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"archive",
":document_id"
],
"variable": [
{
"key": "company_id"
},
{
"key": "document_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
