B4X
B4X
Yousign Create Procedure after Uploading the PDF
See more Yousign Examples
Demonstrates the 2nd step of Yousign procedure creation. This is the call to create the procedure after previously uploading the PDF file.Chilkat B4X Downloads
Dim success As Boolean = False
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As ChilkatHttp
http.Initialize("http")
' Implements the following CURL command:
' curl --location --request POST 'https://staging-api.yousign.com/procedures' \
' --header 'Authorization: Bearer YOUR_API_KEY' \
' --header 'Content-Type: application/json' \
' --data-raw '{
' "name": "My first procedure",
' "description": "Awesome! Here is the description of my first procedure",
' "members": [
' {
' "firstname": "John",
' "lastname": "Doe",
' "email": "john.doe@yousign.fr",
' "phone": "+33612345678",
' "fileObjects": [
' {
' "file": "/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
' "page": 2,
' "position": "230,499,464,589",
' "mention": "Read and approved",
' "mention2": "Signed by John Doe"
' }
' ]
' }
' ]
' }'
' Use the following online tool to generate HTTP code from a CURL command
' Convert a cURL Command to HTTP Source Code
' Use this online tool to generate code from sample JSON:
' Generate Code to Create JSON
' The following JSON is sent in the request body.
' {
' "name": "My first procedure",
' "description": "Awesome! Here is the description of my first procedure",
' "members": [
' {
' "firstname": "John",
' "lastname": "Doe",
' "email": "john.doe@yousign.fr",
' "phone": "+33612345678",
' "fileObjects": [
' {
' "file": "/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
' "page": 2,
' "position": "230,499,464,589",
' "mention": "Read and approved",
' "mention2": "Signed by John Doe"
' }
' ]
' }
' ]
' }
Dim json As ChilkatJsonObject
json.Initialize
json.UpdateString("name", "My first procedure")
json.UpdateString("description", "Awesome! Here is the description of my first procedure")
json.UpdateString("members[0].firstname", "John")
json.UpdateString("members[0].lastname", "Doe")
json.UpdateString("members[0].email", "john.doe@yousign.fr")
json.UpdateString("members[0].phone", "+33612345678")
json.UpdateString("members[0].fileObjects[0].file", "/files/6c123a8d-e5cf-4534-8da0-81886376ba2c")
json.UpdateInt("members[0].fileObjects[0].page", 2)
json.UpdateString("members[0].fileObjects[0].position", "230,499,464,589")
json.UpdateString("members[0].fileObjects[0].mention", "Read and approved")
json.UpdateString("members[0].fileObjects[0].mention2", "Signed by John Doe")
' Adds the "Authorization: Bearer YOUR_API_KEY" header.
http.AuthToken = "YOUR_API_KEY"
Dim resp As ChilkatHttpResponse
resp.Initialize
success = http.HttpJson("POST", "https://staging-api.yousign.com/procedures", json, "application/json", resp)
If success = False Then
Log(http.LastErrorText)
Return
End If
Dim sbResponseBody As ChilkatStringBuilder
sbResponseBody.Initialize
resp.GetBodySb(sbResponseBody)
Dim jResp As ChilkatJsonObject
jResp.Initialize
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Log("Response Body:")
Log(jResp.Emit)
Dim respStatusCode As Int = resp.StatusCode
Log("Response Status Code = " & respStatusCode)
If respStatusCode >= 400 Then
Log("Response Header:")
Log(resp.Header)
Log("Failed.")
Return
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "id": "/procedures/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
' "name": "My first procedure",
' "description": "Awesome! Here is the description of my first procedure",
' "createdAt": "2018-12-01T11:49:11+01:00",
' "updatedAt": "2018-12-01T11:49:11+01:00",
' "finishedAt": null,
' "expiresAt": null,
' "status": "active",
' "creator": null,
' "creatorFirstName": null,
' "creatorLastName": null,
' "workspace": "/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
' "template": false,
' "ordered": false,
' "parent": null,
' "metadata": [
' ],
' "config": [
' ],
' "members": [
' {
' "id": "/members/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
' "user": null,
' "type": "signer",
' "firstname": "John",
' "lastname": "Doe",
' "email": "john.doe@yousign.fr",
' "phone": "+33612345678",
' "position": 1,
' "createdAt": "2018-12-01T11:49:11+01:00",
' "updatedAt": "2018-12-01T11:49:11+01:00",
' "finishedAt": null,
' "status": "pending",
' "fileObjects": [
' {
' "id": "/file_objects/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
' "file": {
' "id": "/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
' "name": "The best name for my file.pdf",
' "type": "signable",
' "contentType": "application/pdf",
' "description": null,
' "createdAt": "2018-12-01T11:36:20+01:00",
' "updatedAt": "2018-12-01T11:49:11+01:00",
' "sha256": "bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2",
' "metadata": [
' ],
' "workspace": "/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
' "creator": null,
' "protected": false,
' "position": 0,
' "parent": null
' },
' "page": 2,
' "position": "230,499,464,589",
' "fieldName": null,
' "mention": "Read and approved",
' "mention2": "Signed by John Doe",
' "createdAt": "2018-12-01T11:49:11+01:00",
' "updatedAt": "2018-12-01T11:49:11+01:00",
' "parent": null,
' "reason": "Signed by Yousign"
' }
' ],
' "comment": null,
' "notificationsEmail": [
' ],
' "operationLevel": "custom",
' "operationCustomModes": [
' "sms"
' ],
' "operationModeSmsConfig": null,
' "parent": null
' }
' ],
' "subscribers": [
' ],
' "files": [
' {
' "id": "/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
' "name": "The best name for my file.pdf",
' "type": "signable",
' "contentType": "application/pdf",
' "description": null,
' "createdAt": "2018-12-01T11:36:20+01:00",
' "updatedAt": "2018-12-01T11:49:11+01:00",
' "sha256": "bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2",
' "metadata": [
' ],
' "workspace": "/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
' "creator": null,
' "protected": false,
' "position": 0,
' "parent": null
' }
' ],
' "relatedFilesEnable": false,
' "archive": false,
' "archiveMetadata": [
' ],
' "fields": [
' ],
' "permissions": [
' ]
' }
' Sample code for parsing the JSON response...
' Use the following online tool to generate parsing code from sample JSON:
' Generate Parsing Code from JSON
Dim user As String
Dim v_type As String
Dim firstname As String
Dim lastname As String
Dim email As String
Dim phone As String
Dim position As Int
Dim comment As String
Dim operationLevel As String
Dim operationModeSmsConfig As String
Dim j As Int
Dim count_j As Int
Dim fileId As String
Dim fileName As String
Dim fileType As String
Dim fileContentType As String
Dim fileDescription As String
Dim fileCreatedAt As String
Dim fileUpdatedAt As String
Dim fileSha256 As String
Dim fileWorkspace As String
Dim fileCreator As String
Dim fileProtected As Boolean
Dim filePosition As Int
Dim fileParent As String
Dim page As Int
Dim position_str As String
Dim fieldName As String
Dim mention As String
Dim mention2 As String
Dim reason As String
Dim k As Int
Dim count_k As Int
Dim strVal As String
Dim contentType As String
Dim sha256 As String
Dim v_protected As Boolean
Dim id As String = jResp.StringOf("id")
Dim name As String = jResp.StringOf("name")
Dim description As String = jResp.StringOf("description")
Dim createdAt As String = jResp.StringOf("createdAt")
Dim updatedAt As String = jResp.StringOf("updatedAt")
Dim finishedAt As String = jResp.StringOf("finishedAt")
Dim expiresAt As String = jResp.StringOf("expiresAt")
Dim status As String = jResp.StringOf("status")
Dim creator As String = jResp.StringOf("creator")
Dim creatorFirstName As String = jResp.StringOf("creatorFirstName")
Dim creatorLastName As String = jResp.StringOf("creatorLastName")
Dim workspace As String = jResp.StringOf("workspace")
Dim template As Boolean = jResp.BoolOf("template")
Dim ordered As Boolean = jResp.BoolOf("ordered")
Dim parent As String = jResp.StringOf("parent")
Dim relatedFilesEnable As Boolean = jResp.BoolOf("relatedFilesEnable")
Dim archive As Boolean = jResp.BoolOf("archive")
Dim i As Int = 0
Dim count_i As Int = jResp.SizeOfArray("metadata")
Do While i < count_i
jResp.I = i
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("config")
Do While i < count_i
jResp.I = i
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("members")
Do While i < count_i
jResp.I = i
id = jResp.StringOf("members[i].id")
user = jResp.StringOf("members[i].user")
v_type = jResp.StringOf("members[i].type")
firstname = jResp.StringOf("members[i].firstname")
lastname = jResp.StringOf("members[i].lastname")
email = jResp.StringOf("members[i].email")
phone = jResp.StringOf("members[i].phone")
position = jResp.IntOf("members[i].position")
createdAt = jResp.StringOf("members[i].createdAt")
updatedAt = jResp.StringOf("members[i].updatedAt")
finishedAt = jResp.StringOf("members[i].finishedAt")
status = jResp.StringOf("members[i].status")
comment = jResp.StringOf("members[i].comment")
operationLevel = jResp.StringOf("members[i].operationLevel")
operationModeSmsConfig = jResp.StringOf("members[i].operationModeSmsConfig")
parent = jResp.StringOf("members[i].parent")
j = 0
count_j = jResp.SizeOfArray("members[i].fileObjects")
Do While j < count_j
jResp.J = j
id = jResp.StringOf("members[i].fileObjects[j].id")
fileId = jResp.StringOf("members[i].fileObjects[j].file.id")
fileName = jResp.StringOf("members[i].fileObjects[j].file.name")
fileType = jResp.StringOf("members[i].fileObjects[j].file.type")
fileContentType = jResp.StringOf("members[i].fileObjects[j].file.contentType")
fileDescription = jResp.StringOf("members[i].fileObjects[j].file.description")
fileCreatedAt = jResp.StringOf("members[i].fileObjects[j].file.createdAt")
fileUpdatedAt = jResp.StringOf("members[i].fileObjects[j].file.updatedAt")
fileSha256 = jResp.StringOf("members[i].fileObjects[j].file.sha256")
fileWorkspace = jResp.StringOf("members[i].fileObjects[j].file.workspace")
fileCreator = jResp.StringOf("members[i].fileObjects[j].file.creator")
fileProtected = jResp.BoolOf("members[i].fileObjects[j].file.protected")
filePosition = jResp.IntOf("members[i].fileObjects[j].file.position")
fileParent = jResp.StringOf("members[i].fileObjects[j].file.parent")
page = jResp.IntOf("members[i].fileObjects[j].page")
position_str = jResp.StringOf("members[i].fileObjects[j].position")
fieldName = jResp.StringOf("members[i].fileObjects[j].fieldName")
mention = jResp.StringOf("members[i].fileObjects[j].mention")
mention2 = jResp.StringOf("members[i].fileObjects[j].mention2")
createdAt = jResp.StringOf("members[i].fileObjects[j].createdAt")
updatedAt = jResp.StringOf("members[i].fileObjects[j].updatedAt")
parent = jResp.StringOf("members[i].fileObjects[j].parent")
reason = jResp.StringOf("members[i].fileObjects[j].reason")
k = 0
count_k = jResp.SizeOfArray("members[i].fileObjects[j].file.metadata")
Do While k < count_k
jResp.K = k
k = k + 1
Loop
j = j + 1
Loop
j = 0
count_j = jResp.SizeOfArray("members[i].notificationsEmail")
Do While j < count_j
jResp.J = j
j = j + 1
Loop
j = 0
count_j = jResp.SizeOfArray("members[i].operationCustomModes")
Do While j < count_j
jResp.J = j
strVal = jResp.StringOf("members[i].operationCustomModes[j]")
j = j + 1
Loop
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("subscribers")
Do While i < count_i
jResp.I = i
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("files")
Do While i < count_i
jResp.I = i
id = jResp.StringOf("files[i].id")
name = jResp.StringOf("files[i].name")
v_type = jResp.StringOf("files[i].type")
contentType = jResp.StringOf("files[i].contentType")
description = jResp.StringOf("files[i].description")
createdAt = jResp.StringOf("files[i].createdAt")
updatedAt = jResp.StringOf("files[i].updatedAt")
sha256 = jResp.StringOf("files[i].sha256")
workspace = jResp.StringOf("files[i].workspace")
creator = jResp.StringOf("files[i].creator")
v_protected = jResp.BoolOf("files[i].protected")
position = jResp.IntOf("files[i].position")
parent = jResp.StringOf("files[i].parent")
j = 0
count_j = jResp.SizeOfArray("files[i].metadata")
Do While j < count_j
jResp.J = j
j = j + 1
Loop
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("archiveMetadata")
Do While i < count_i
jResp.I = i
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("fields")
Do While i < count_i
jResp.I = i
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("permissions")
Do While i < count_i
jResp.I = i
i = i + 1
Loop