Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_SbRequestBody
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JarrResp
integer li_RespStatusCode
oleobject loo_Json
string ls_Link
string ls_Collected_at
string ls_Display_name
string ls_First_name
string ls_Last_name
string ls_Second_last_name
string ls_Address
string ls_Email
string ls_Phone_number
string ls_Collected_at
string ls_Status
string ls_Acceptance_rate
integer j
integer li_Count_j
string ls_Value
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "{{secretId}}"
loo_Http.Password = "{{secretPassword}}"
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "session": "39cd6a88-8ee3-4e59-a861-b8a2187e0f4c",
// "token": "1234ab",
// "link": "683005d6-f45c-4adb-b289-f1a12f50f80c",
// "save_data": true
// }
loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.UpdateString("session","39cd6a88-8ee3-4e59-a861-b8a2187e0f4c")
loo_Json.UpdateString("token","1234ab")
loo_Json.UpdateString("link","683005d6-f45c-4adb-b289-f1a12f50f80c")
loo_Json.UpdateBool("save_data",1)
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_SbRequestBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbRequestBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Json.EmitSb(loo_SbRequestBody)
loo_Resp = loo_Http.PTextSb("PATCH","https://domain.com/api/owners/",loo_SbRequestBody,"utf-8","application/json",0,0)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JarrResp = create oleobject
// Use "Chilkat_9_5_0.JsonArray" for versions of Chilkat < 10.0.0
li_rc = loo_JarrResp.ConnectToNewObject("Chilkat.JsonArray")
loo_JarrResp.LoadSb(loo_SbResponseBody)
loo_JarrResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JarrResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody
destroy loo_JarrResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// [
// {
// "link": "<uuid>",
// "collected_at": "<dateTime>",
// "display_name": "<string>",
// "first_name": "<string>",
// "last_name": "<string>",
// "second_last_name": "<string>",
// "address": "<string>",
// "email": "<email>",
// "phone_number": "<string>",
// "accounts": [
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// ],
// "gig_data": {
// "collected_at": "<dateTime>",
// "status": "<string>",
// "acceptance_rate": "<number>"
// }
// },
// {
// "link": "<uuid>",
// "collected_at": "<dateTime>",
// "display_name": "<string>",
// "first_name": "<string>",
// "last_name": "<string>",
// "second_last_name": "<string>",
// "address": "<string>",
// "email": "<email>",
// "phone_number": "<string>",
// "accounts": [
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// ],
// "gig_data": {
// "collected_at": "<dateTime>",
// "status": "<string>",
// "acceptance_rate": "<number>"
// }
// }
// ]
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
i = 0
li_Count_i = loo_JarrResp.Size
do while i < li_Count_i
loo_Json = loo_JarrResp.ObjectAt(i)
ls_Link = loo_Json.StringOf("link")
ls_Collected_at = loo_Json.StringOf("collected_at")
ls_Display_name = loo_Json.StringOf("display_name")
ls_First_name = loo_Json.StringOf("first_name")
ls_Last_name = loo_Json.StringOf("last_name")
ls_Second_last_name = loo_Json.StringOf("second_last_name")
ls_Address = loo_Json.StringOf("address")
ls_Email = loo_Json.StringOf("email")
ls_Phone_number = loo_Json.StringOf("phone_number")
ls_Collected_at = loo_Json.StringOf("gig_data.collected_at")
ls_Status = loo_Json.StringOf("gig_data.status")
ls_Acceptance_rate = loo_Json.StringOf("gig_data.acceptance_rate")
j = 0
li_Count_j = loo_Json.SizeOfArray("accounts")
do while j < li_Count_j
loo_Json.J = j
ls_Value = loo_Json.StringOf("accounts[j].value")
j = j + 1
loop
destroy loo_Json
i = i + 1
loop
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody
destroy loo_JarrResp
Curl Command
curl -X PATCH
-u '{{secretId}}:{{secretPassword}}'
-H "Content-Type: application/json"
-d '{
"session": "39cd6a88-8ee3-4e59-a861-b8a2187e0f4c",
"token": "1234ab",
"link": "683005d6-f45c-4adb-b289-f1a12f50f80c",
"save_data": true
}'
https://domain.com/api/owners/
Postman Collection Item JSON
{
"name": "Resume",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"session\": \"39cd6a88-8ee3-4e59-a861-b8a2187e0f4c\",\n \"token\": \"1234ab\",\n \"link\": \"683005d6-f45c-4adb-b289-f1a12f50f80c\",\n \"save_data\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/api/owners/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"owners",
""
]
},
"description": "Used to resume an Owner retrieve session that was paused because an MFA token was required by the institution."
},
"response": [
{
"name": "Ok (when save_data=false)",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/owners",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"owners"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"link\": \"<uuid>\",\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"display_name\": \"<string>\",\n\t\t\"first_name\": \"<string>\",\n\t\t\"last_name\": \"<string>\",\n\t\t\"second_last_name\": \"<string>\",\n\t\t\"address\": \"<string>\",\n\t\t\"email\": \"<email>\",\n\t\t\"phone_number\": \"<string>\",\n\t\t\"accounts\": [\n\t\t\t{\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t],\n\t\t\"gig_data\": {\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"status\": \"<string>\",\n\t\t\t\"acceptance_rate\": \"<number>\"\n\t\t}\n\t},\n\t{\n\t\t\"link\": \"<uuid>\",\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"display_name\": \"<string>\",\n\t\t\"first_name\": \"<string>\",\n\t\t\"last_name\": \"<string>\",\n\t\t\"second_last_name\": \"<string>\",\n\t\t\"address\": \"<string>\",\n\t\t\"email\": \"<email>\",\n\t\t\"phone_number\": \"<string>\",\n\t\t\"accounts\": [\n\t\t\t{\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t],\n\t\t\"gig_data\": {\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"status\": \"<string>\",\n\t\t\t\"acceptance_rate\": \"<number>\"\n\t\t}\n\t}\n]"
},
{
"name": "Created (when save_data=true)",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/owners",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"owners"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"link\": \"<uuid>\",\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"display_name\": \"<string>\",\n\t\t\"first_name\": \"<string>\",\n\t\t\"last_name\": \"<string>\",\n\t\t\"second_last_name\": \"<string>\",\n\t\t\"address\": \"<string>\",\n\t\t\"email\": \"<email>\",\n\t\t\"phone_number\": \"<string>\",\n\t\t\"accounts\": [\n\t\t\t{\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t],\n\t\t\"gig_data\": {\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"status\": \"<string>\",\n\t\t\t\"acceptance_rate\": \"<number>\"\n\t\t}\n\t},\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"link\": \"<uuid>\",\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"display_name\": \"<string>\",\n\t\t\"first_name\": \"<string>\",\n\t\t\"last_name\": \"<string>\",\n\t\t\"second_last_name\": \"<string>\",\n\t\t\"address\": \"<string>\",\n\t\t\"email\": \"<email>\",\n\t\t\"phone_number\": \"<string>\",\n\t\t\"accounts\": [\n\t\t\t{\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t],\n\t\t\"gig_data\": {\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"status\": \"<string>\",\n\t\t\t\"acceptance_rate\": \"<number>\"\n\t\t}\n\t}\n]"
},
{
"name": "Bad request error",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/owners",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"owners"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/owners",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"owners"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
},
{
"name": "Request Timeout",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/owners",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"owners"
]
}
},
"status": "Request Timeout",
"code": 408,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
},
{
"name": "MFA Token Required",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/owners",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"owners"
]
}
},
"status": "Precondition Required",
"code": 428,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"code\": \"<string>\",\n\t\"message\": \"<string>\",\n\t\"request_id\": \"<uuid>\",\n\t\"session\": \"<uuid>\",\n\t\"expiry\": \"<integer>\",\n\t\"link\": \"<uuid>\",\n\t\"token_generation_data\": {\n\t\t\"instructions\": \"<string>\",\n\t\t\"type\": \"<string>\",\n\t\t\"value\": \"<string>\"\n\t}\n}"
},
{
"name": "Unexpected Error",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/owners",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"owners"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
}
]
}
