Lianja
Lianja
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 Lianja Downloads
llSuccess = .F.
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// 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"
// }
// ]
// }
// ]
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("name","My first procedure")
loJson.UpdateString("description","Awesome! Here is the description of my first procedure")
loJson.UpdateString("members[0].firstname","John")
loJson.UpdateString("members[0].lastname","Doe")
loJson.UpdateString("members[0].email","john.doe@yousign.fr")
loJson.UpdateString("members[0].phone","+33612345678")
loJson.UpdateString("members[0].fileObjects[0].file","/files/6c123a8d-e5cf-4534-8da0-81886376ba2c")
loJson.UpdateInt("members[0].fileObjects[0].page",2)
loJson.UpdateString("members[0].fileObjects[0].position","230,499,464,589")
loJson.UpdateString("members[0].fileObjects[0].mention","Read and approved")
loJson.UpdateString("members[0].fileObjects[0].mention2","Signed by John Doe")
// Adds the "Authorization: Bearer YOUR_API_KEY" header.
loHttp.AuthToken = "YOUR_API_KEY"
loResp = createobject("CkHttpResponse")
llSuccess = loHttp.HttpJson("POST","https://staging-api.yousign.com/procedures",loJson,"application/json",loResp)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
release loResp
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loHttp
release loJson
release loResp
release loSbResponseBody
release loJResp
return
endif
// 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
lcId = loJResp.StringOf("id")
lcName = loJResp.StringOf("name")
lcDescription = loJResp.StringOf("description")
lcCreatedAt = loJResp.StringOf("createdAt")
lcUpdatedAt = loJResp.StringOf("updatedAt")
lcFinishedAt = loJResp.StringOf("finishedAt")
lcExpiresAt = loJResp.StringOf("expiresAt")
lcStatus = loJResp.StringOf("status")
lcCreator = loJResp.StringOf("creator")
lcCreatorFirstName = loJResp.StringOf("creatorFirstName")
lcCreatorLastName = loJResp.StringOf("creatorLastName")
lcWorkspace = loJResp.StringOf("workspace")
llTemplate = loJResp.BoolOf("template")
llOrdered = loJResp.BoolOf("ordered")
lcParent = loJResp.StringOf("parent")
llRelatedFilesEnable = loJResp.BoolOf("relatedFilesEnable")
llArchive = loJResp.BoolOf("archive")
i = 0
lnCount_i = loJResp.SizeOfArray("metadata")
do while i < lnCount_i
loJResp.I = i
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("config")
do while i < lnCount_i
loJResp.I = i
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("members")
do while i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("members[i].id")
lcUser = loJResp.StringOf("members[i].user")
lcV_type = loJResp.StringOf("members[i].type")
lcFirstname = loJResp.StringOf("members[i].firstname")
lcLastname = loJResp.StringOf("members[i].lastname")
lcEmail = loJResp.StringOf("members[i].email")
lcPhone = loJResp.StringOf("members[i].phone")
lnPosition = loJResp.IntOf("members[i].position")
lcCreatedAt = loJResp.StringOf("members[i].createdAt")
lcUpdatedAt = loJResp.StringOf("members[i].updatedAt")
lcFinishedAt = loJResp.StringOf("members[i].finishedAt")
lcStatus = loJResp.StringOf("members[i].status")
lcComment = loJResp.StringOf("members[i].comment")
lcOperationLevel = loJResp.StringOf("members[i].operationLevel")
lcOperationModeSmsConfig = loJResp.StringOf("members[i].operationModeSmsConfig")
lcParent = loJResp.StringOf("members[i].parent")
j = 0
lnCount_j = loJResp.SizeOfArray("members[i].fileObjects")
do while j < lnCount_j
loJResp.J = j
lcId = loJResp.StringOf("members[i].fileObjects[j].id")
lcFileId = loJResp.StringOf("members[i].fileObjects[j].file.id")
lcFileName = loJResp.StringOf("members[i].fileObjects[j].file.name")
lcFileType = loJResp.StringOf("members[i].fileObjects[j].file.type")
lcFileContentType = loJResp.StringOf("members[i].fileObjects[j].file.contentType")
lcFileDescription = loJResp.StringOf("members[i].fileObjects[j].file.description")
lcFileCreatedAt = loJResp.StringOf("members[i].fileObjects[j].file.createdAt")
lcFileUpdatedAt = loJResp.StringOf("members[i].fileObjects[j].file.updatedAt")
lcFileSha256 = loJResp.StringOf("members[i].fileObjects[j].file.sha256")
lcFileWorkspace = loJResp.StringOf("members[i].fileObjects[j].file.workspace")
lcFileCreator = loJResp.StringOf("members[i].fileObjects[j].file.creator")
llFileProtected = loJResp.BoolOf("members[i].fileObjects[j].file.protected")
lnFilePosition = loJResp.IntOf("members[i].fileObjects[j].file.position")
lcFileParent = loJResp.StringOf("members[i].fileObjects[j].file.parent")
lnPage = loJResp.IntOf("members[i].fileObjects[j].page")
lcPosition_str = loJResp.StringOf("members[i].fileObjects[j].position")
lcFieldName = loJResp.StringOf("members[i].fileObjects[j].fieldName")
lcMention = loJResp.StringOf("members[i].fileObjects[j].mention")
lcMention2 = loJResp.StringOf("members[i].fileObjects[j].mention2")
lcCreatedAt = loJResp.StringOf("members[i].fileObjects[j].createdAt")
lcUpdatedAt = loJResp.StringOf("members[i].fileObjects[j].updatedAt")
lcParent = loJResp.StringOf("members[i].fileObjects[j].parent")
lcReason = loJResp.StringOf("members[i].fileObjects[j].reason")
k = 0
lnCount_k = loJResp.SizeOfArray("members[i].fileObjects[j].file.metadata")
do while k < lnCount_k
loJResp.K = k
k = k + 1
enddo
j = j + 1
enddo
j = 0
lnCount_j = loJResp.SizeOfArray("members[i].notificationsEmail")
do while j < lnCount_j
loJResp.J = j
j = j + 1
enddo
j = 0
lnCount_j = loJResp.SizeOfArray("members[i].operationCustomModes")
do while j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("members[i].operationCustomModes[j]")
j = j + 1
enddo
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("subscribers")
do while i < lnCount_i
loJResp.I = i
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("files")
do while i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("files[i].id")
lcName = loJResp.StringOf("files[i].name")
lcV_type = loJResp.StringOf("files[i].type")
lcContentType = loJResp.StringOf("files[i].contentType")
lcDescription = loJResp.StringOf("files[i].description")
lcCreatedAt = loJResp.StringOf("files[i].createdAt")
lcUpdatedAt = loJResp.StringOf("files[i].updatedAt")
lcSha256 = loJResp.StringOf("files[i].sha256")
lcWorkspace = loJResp.StringOf("files[i].workspace")
lcCreator = loJResp.StringOf("files[i].creator")
llV_protected = loJResp.BoolOf("files[i].protected")
lnPosition = loJResp.IntOf("files[i].position")
lcParent = loJResp.StringOf("files[i].parent")
j = 0
lnCount_j = loJResp.SizeOfArray("files[i].metadata")
do while j < lnCount_j
loJResp.J = j
j = j + 1
enddo
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("archiveMetadata")
do while i < lnCount_i
loJResp.I = i
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("fields")
do while i < lnCount_i
loJResp.I = i
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("permissions")
do while i < lnCount_i
loJResp.I = i
i = i + 1
enddo
release loHttp
release loJson
release loResp
release loSbResponseBody
release loJResp