Chilkat Online Tools

PureBasic / Zoho CRM REST APIs / Contact Roles of a Specific Deal

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://domain.com/crm/v2/Deals/738964000002224056/Contact_Roles",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    ; Sample JSON response:
    ; (Sample code for parsing the JSON response is shown below)

    ; {
    ;   "data": [
    ;     {
    ;       "Owner": {
    ;         "name": "Patricia Boyle",
    ;         "id": "738964000000291009",
    ;         "email": "patricia.b@zylker.com"
    ;       },
    ;       "Email": null,
    ;       "$currency_symbol": "Af",
    ;       "Other_Phone": null,
    ;       "Mailing_State": null,
    ;       "Other_State": null,
    ;       "Other_Country": null,
    ;       "Last_Activity_Time": "2021-03-02T08:06:35+00:00",
    ;       "Department": null,
    ;       "Contact_Role": "738964000000007170",
    ;       "$state": "save",
    ;       "Unsubscribed_Mode": null,
    ;       "$process_flow": false,
    ;       "Assistant": null,
    ;       "Exchange_Rate": 1,
    ;       "Currency": "AFN",
    ;       "Mailing_Country": null,
    ;       "Data_Processing_Basis_Details": null,
    ;       "id": "738964000001112068",
    ;       "Data_Source": "Manual",
    ;       "$approved": true,
    ;       "Reporting_To": null,
    ;       "$approval": {
    ;         "delegate": false,
    ;         "approve": false,
    ;         "reject": false,
    ;         "resubmit": false
    ;       },
    ;       "Other_City": null,
    ;       "$data_source_details": null,
    ;       "Created_Time": "2020-07-09T06:36:27+00:00",
    ;       "$editable": true,
    ;       "Home_Phone": null,
    ;       "Created_By": {
    ;         "name": "Patricia Boyle",
    ;         "id": "738964000000291009",
    ;         "email": "patricia@zylker.com"
    ;       },
    ;       "Secondary_Email": null,
    ;       "Description": null,
    ;       "Vendor_Name": null,
    ;       "Mailing_Zip": null,
    ;       "$review_process": {
    ;         "approve": false,
    ;         "reject": false,
    ;         "resubmit": false
    ;       },
    ;       "Twitter": null,
    ;       "Other_Zip": null,
    ;       "Mailing_Street": null,
    ;       "Salutation": null,
    ;       "First_Name": null,
    ;       "Full_Name": "Boyle",
    ;       "Asst_Phone": null,
    ;       "Record_Image": null,
    ;       "Modified_By": {
    ;         "name": "Patricia Boyle",
    ;         "id": "738964000000291009",
    ;         "email": "patricia@zylker.com"
    ;       },
    ;       "$review": null,
    ;       "Skype_ID": null,
    ;       "Phone": null,
    ;       "Account_Name": {
    ;         "name": "zylker",
    ;         "id": "738964000001112135"
    ;       },
    ;       "Email_Opt_Out": false,
    ;       "Modified_Time": "2020-10-22T14:46:41+00:00",
    ;       "Date_of_Birth": null,
    ;       "Mailing_City": null,
    ;       "Unsubscribed_Time": null,
    ;       "Title": null,
    ;       "Other_Street": null,
    ;       "Mobile": null,
    ;       "$orchestration": false,
    ;       "$stop_processing": false,
    ;       "Last_Name": "Boyle",
    ;       "$in_merge": false,
    ;       "Lead_Source": null,
    ;       "Tag": [
    ;       ],
    ;       "Fax": null,
    ;       "$approval_state": "approved"
    ;     },
    ;     {
    ;       "Owner": {
    ;         "name": "Patricia Boyle",
    ;         "id": "738964000000291009",
    ;         "email": "patricia@zylker.com"
    ;       },
    ;       "Email": null,
    ;       "$currency_symbol": "Af",
    ;       "Other_Phone": null,
    ;       "Mailing_State": null,
    ;       "Other_State": null,
    ;       "Other_Country": null,
    ;       "Last_Activity_Time": null,
    ;       "Department": null,
    ;       "Contact_Role": "738964000000007170",
    ;       "$state": "save",
    ;       "Unsubscribed_Mode": null,
    ;       "$process_flow": false,
    ;       "Assistant": null,
    ;       "Exchange_Rate": 1,
    ;       "Currency": "AFN",
    ;       "Mailing_Country": null,
    ;       "Data_Processing_Basis_Details": null,
    ;       "id": "738964000001682005",
    ;       "Data_Source": "Manual",
    ;       "$approved": true,
    ;       "Reporting_To": {
    ;         "name": "Boyle",
    ;         "id": "738964000001112068"
    ;       },
    ;       "$approval": {
    ;         "delegate": false,
    ;         "approve": false,
    ;         "reject": false,
    ;         "resubmit": false
    ;       },
    ;       "Other_City": null,
    ;       "$data_source_details": null,
    ;       "Created_Time": "2020-12-15T07:09:59+00:00",
    ;       "$editable": true,
    ;       "Home_Phone": null,
    ;       "Created_By": {
    ;         "name": "Patricia Boyle",
    ;         "id": "738964000000291009",
    ;         "email": "patricia@zylker.com"
    ;       },
    ;       "Secondary_Email": null,
    ;       "Description": null,
    ;       "Vendor_Name": null,
    ;       "Mailing_Zip": null,
    ;       "$review_process": {
    ;         "approve": false,
    ;         "reject": false,
    ;         "resubmit": false
    ;       },
    ;       "Twitter": null,
    ;       "Other_Zip": null,
    ;       "Mailing_Street": null,
    ;       "Salutation": "Ms.",
    ;       "First_Name": "Patricia",
    ;       "Full_Name": "Ms. Patricia Boyle",
    ;       "Asst_Phone": null,
    ;       "Record_Image": null,
    ;       "Modified_By": {
    ;         "name": "Patricia Boyle",
    ;         "id": "738964000000291009",
    ;         "email": "patricia@zylker.com"
    ;       },
    ;       "$review": null,
    ;       "Skype_ID": null,
    ;       "Phone": null,
    ;       "Account_Name": {
    ;         "name": "zylker",
    ;         "id": "738964000001112135"
    ;       },
    ;       "Email_Opt_Out": false,
    ;       "Modified_Time": "2020-12-15T07:09:59+00:00",
    ;       "Date_of_Birth": null,
    ;       "Mailing_City": null,
    ;       "Unsubscribed_Time": null,
    ;       "Title": null,
    ;       "Other_Street": null,
    ;       "Mobile": null,
    ;       "$orchestration": false,
    ;       "$stop_processing": false,
    ;       "Last_Name": "Boyle",
    ;       "$in_merge": false,
    ;       "Lead_Source": null,
    ;       "Tag": [
    ;       ],
    ;       "Fax": null,
    ;       "$approval_state": "approved"
    ;     },
    ;     {
    ;       "Owner": {
    ;         "name": "Patricia Boyle",
    ;         "id": "738964000000291009",
    ;         "email": "patricia@zylker.com"
    ;       },
    ;       "Email": null,
    ;       "$currency_symbol": "Af",
    ;       "Other_Phone": null,
    ;       "Mailing_State": null,
    ;       "Other_State": null,
    ;       "Other_Country": null,
    ;       "Last_Activity_Time": null,
    ;       "Department": null,
    ;       "Contact_Role": "738964000000007170",
    ;       "$state": "save",
    ;       "Unsubscribed_Mode": null,
    ;       "$process_flow": false,
    ;       "Assistant": null,
    ;       "Exchange_Rate": 1,
    ;       "Currency": "AFN",
    ;       "Mailing_Country": null,
    ;       "Data_Processing_Basis_Details": null,
    ;       "id": "738964000001919009",
    ;       "Data_Source": "API",
    ;       "$approved": true,
    ;       "Reporting_To": null,
    ;       "$approval": {
    ;         "delegate": false,
    ;         "approve": false,
    ;         "reject": false,
    ;         "resubmit": false
    ;       },
    ;       "Other_City": null,
    ;       "$data_source_details": {},
    ;       "Created_Time": "2021-03-02T09:18:59+00:00",
    ;       "$editable": true,
    ;       "Home_Phone": null,
    ;       "Created_By": {
    ;         "name": "Patricia Boyle",
    ;         "id": "738964000000291009",
    ;         "email": "patricia@zylker.com"
    ;       },
    ;       "Secondary_Email": null,
    ;       "Description": null,
    ;       "Vendor_Name": null,
    ;       "Mailing_Zip": null,
    ;       "$review_process": {
    ;         "approve": false,
    ;         "reject": false,
    ;         "resubmit": false
    ;       },
    ;       "Twitter": null,
    ;       "Other_Zip": null,
    ;       "Mailing_Street": null,
    ;       "Salutation": null,
    ;       "First_Name": null,
    ;       "Full_Name": "Patricia",
    ;       "Asst_Phone": null,
    ;       "Record_Image": null,
    ;       "Modified_By": {
    ;         "name": "Patricia Boyle",
    ;         "id": "738964000000291009",
    ;         "email": "patricia@zylker.com"
    ;       },
    ;       "$review": null,
    ;       "Skype_ID": null,
    ;       "Phone": null,
    ;       "Account_Name": null,
    ;       "Email_Opt_Out": false,
    ;       "Modified_Time": "2021-03-02T09:18:59+00:00",
    ;       "Date_of_Birth": null,
    ;       "Mailing_City": null,
    ;       "Unsubscribed_Time": null,
    ;       "Title": null,
    ;       "Other_Street": null,
    ;       "Mobile": null,
    ;       "$orchestration": false,
    ;       "$stop_processing": false,
    ;       "Last_Name": "Patricia",
    ;       "$in_merge": false,
    ;       "Lead_Source": null,
    ;       "Tag": [
    ;       ],
    ;       "Fax": null,
    ;       "$approval_state": "approved"
    ;     },
    ;     {
    ;       "Owner": {
    ;         "name": "Patricia Boyle",
    ;         "id": "738964000000291009",
    ;         "email": "patricia@zylker.com"
    ;       },
    ;       "Email": "contact_test@xyz.com",
    ;       "$currency_symbol": "Af",
    ;       "Other_Phone": null,
    ;       "Mailing_State": "Colorado",
    ;       "Other_State": null,
    ;       "Other_Country": null,
    ;       "Last_Activity_Time": "2021-06-02T15:46:37+00:00",
    ;       "Department": null,
    ;       "Contact_Role": null,
    ;       "$state": "save",
    ;       "Unsubscribed_Mode": null,
    ;       "$process_flow": false,
    ;       "Assistant": null,
    ;       "Exchange_Rate": 1,
    ;       "Currency": "AFN",
    ;       "Mailing_Country": null,
    ;       "Data_Processing_Basis_Details": null,
    ;       "id": "738964000002224050",
    ;       "Data_Source": "Converted",
    ;       "$approved": true,
    ;       "Reporting_To": null,
    ;       "$approval": {
    ;         "delegate": false,
    ;         "approve": false,
    ;         "reject": false,
    ;         "resubmit": false
    ;       },
    ;       "Other_City": null,
    ;       "$data_source_details": null,
    ;       "Created_Time": "2021-06-02T15:46:36+00:00",
    ;       "$editable": true,
    ;       "Home_Phone": null,
    ;       "Created_By": {
    ;         "name": "Patricia Boyle",
    ;         "id": "738964000000291009",
    ;         "email": "patricia@zylker.com"
    ;       },
    ;       "Secondary_Email": null,
    ;       "Description": null,
    ;       "Vendor_Name": null,
    ;       "Mailing_Zip": "1234",
    ;       "$review_process": {
    ;         "approve": false,
    ;         "reject": false,
    ;         "resubmit": false
    ;       },
    ;       "Twitter": null,
    ;       "Other_Zip": null,
    ;       "Mailing_Street": null,
    ;       "Salutation": null,
    ;       "First_Name": null,
    ;       "Full_Name": "Contact_test",
    ;       "Asst_Phone": null,
    ;       "Record_Image": null,
    ;       "Modified_By": {
    ;         "name": "Patricia Boyle",
    ;         "id": "738964000000291009",
    ;         "email": "patricia@zylker.com"
    ;       },
    ;       "$review": null,
    ;       "Skype_ID": null,
    ;       "Phone": null,
    ;       "Account_Name": null,
    ;       "Email_Opt_Out": false,
    ;       "Modified_Time": "2021-06-02T15:46:36+00:00",
    ;       "Date_of_Birth": null,
    ;       "Mailing_City": null,
    ;       "Unsubscribed_Time": null,
    ;       "Title": null,
    ;       "Other_Street": null,
    ;       "Mobile": null,
    ;       "$orchestration": false,
    ;       "$stop_processing": false,
    ;       "Last_Name": "Contact_test",
    ;       "$in_merge": false,
    ;       "Lead_Source": null,
    ;       "Tag": [
    ;       ],
    ;       "Fax": null,
    ;       "$approval_state": "approved"
    ;     }
    ;   ],
    ;   "info": {
    ;     "per_page": 200,
    ;     "count": 4,
    ;     "page": 1,
    ;     "more_records": false
    ;   }
    ; }

    ; Sample code for parsing the JSON response...
    ; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    Name.s
    Id.s
    v_Email.s
    Scurrency_symbol.s
    Other_Phone.s
    Mailing_State.s
    Other_State.s
    Other_Country.s
    Last_Activity_Time.s
    Department.s
    Contact_Role.s
    Sstate.s
    Unsubscribed_Mode.s
    Sprocess_flow.i
    Assistant.s
    Exchange_Rate.i
    v_Currency.s
    Mailing_Country.s
    Data_Processing_Basis_Details.s
    id.s
    Data_Source.s
    Sapproved.i
    Reporting_To.s
    Delegate.i
    Approve.i
    Reject.i
    Resubmit.i
    Other_City.s
    Sdata_source_details.s
    Created_Time.s
    Seditable.i
    Home_Phone.s
    Created_ByName.s
    Created_ById.s
    Created_ByEmail.s
    Secondary_Email.s
    Description.s
    Vendor_Name.s
    Mailing_Zip.s
    Sreview_processApprove.i
    Sreview_processReject.i
    Sreview_processResubmit.i
    Twitter.s
    Other_Zip.s
    Mailing_Street.s
    Salutation.s
    First_Name.s
    Full_Name.s
    Asst_Phone.s
    Record_Image.s
    Modified_ByName.s
    Modified_ById.s
    Modified_ByEmail.s
    Sreview.s
    Skype_ID.s
    Phone.s
    Account_NameName.s
    Account_NameId.s
    Email_Opt_Out.i
    Modified_Time.s
    Date_of_Birth.s
    Mailing_City.s
    Unsubscribed_Time.s
    Title.s
    Other_Street.s
    Mobile.s
    Sorchestration.i
    Sstop_processing.i
    Last_Name.s
    Sin_merge.i
    Lead_Source.s
    Fax.s
    Sapproval_state.s
    Reporting_ToName.s
    Reporting_ToId.s
    Account_Name.s
    j.i
    count_j.i

    Per_page.i = CkJsonObject::ckIntOf(jResp,"info.per_page")
    Count.i = CkJsonObject::ckIntOf(jResp,"info.count")
    Page.i = CkJsonObject::ckIntOf(jResp,"info.page")
    More_records.i = CkJsonObject::ckBoolOf(jResp,"info.more_records")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        Name = CkJsonObject::ckStringOf(jResp,"data[i].Owner.name")
        Id = CkJsonObject::ckStringOf(jResp,"data[i].Owner.id")
        v_Email = CkJsonObject::ckStringOf(jResp,"data[i].Owner.email")
        v_Email = CkJsonObject::ckStringOf(jResp,"data[i].Email")
        Scurrency_symbol = CkJsonObject::ckStringOf(jResp,"data[i].$currency_symbol")
        Other_Phone = CkJsonObject::ckStringOf(jResp,"data[i].Other_Phone")
        Mailing_State = CkJsonObject::ckStringOf(jResp,"data[i].Mailing_State")
        Other_State = CkJsonObject::ckStringOf(jResp,"data[i].Other_State")
        Other_Country = CkJsonObject::ckStringOf(jResp,"data[i].Other_Country")
        Last_Activity_Time = CkJsonObject::ckStringOf(jResp,"data[i].Last_Activity_Time")
        Department = CkJsonObject::ckStringOf(jResp,"data[i].Department")
        Contact_Role = CkJsonObject::ckStringOf(jResp,"data[i].Contact_Role")
        Sstate = CkJsonObject::ckStringOf(jResp,"data[i].$state")
        Unsubscribed_Mode = CkJsonObject::ckStringOf(jResp,"data[i].Unsubscribed_Mode")
        Sprocess_flow = CkJsonObject::ckBoolOf(jResp,"data[i].$process_flow")
        Assistant = CkJsonObject::ckStringOf(jResp,"data[i].Assistant")
        Exchange_Rate = CkJsonObject::ckIntOf(jResp,"data[i].Exchange_Rate")
        v_Currency = CkJsonObject::ckStringOf(jResp,"data[i].Currency")
        Mailing_Country = CkJsonObject::ckStringOf(jResp,"data[i].Mailing_Country")
        Data_Processing_Basis_Details = CkJsonObject::ckStringOf(jResp,"data[i].Data_Processing_Basis_Details")
        id = CkJsonObject::ckStringOf(jResp,"data[i].id")
        Data_Source = CkJsonObject::ckStringOf(jResp,"data[i].Data_Source")
        Sapproved = CkJsonObject::ckBoolOf(jResp,"data[i].$approved")
        Reporting_To = CkJsonObject::ckStringOf(jResp,"data[i].Reporting_To")
        Delegate = CkJsonObject::ckBoolOf(jResp,"data[i].$approval.delegate")
        Approve = CkJsonObject::ckBoolOf(jResp,"data[i].$approval.approve")
        Reject = CkJsonObject::ckBoolOf(jResp,"data[i].$approval.reject")
        Resubmit = CkJsonObject::ckBoolOf(jResp,"data[i].$approval.resubmit")
        Other_City = CkJsonObject::ckStringOf(jResp,"data[i].Other_City")
        Sdata_source_details = CkJsonObject::ckStringOf(jResp,"data[i].$data_source_details")
        Created_Time = CkJsonObject::ckStringOf(jResp,"data[i].Created_Time")
        Seditable = CkJsonObject::ckBoolOf(jResp,"data[i].$editable")
        Home_Phone = CkJsonObject::ckStringOf(jResp,"data[i].Home_Phone")
        Created_ByName = CkJsonObject::ckStringOf(jResp,"data[i].Created_By.name")
        Created_ById = CkJsonObject::ckStringOf(jResp,"data[i].Created_By.id")
        Created_ByEmail = CkJsonObject::ckStringOf(jResp,"data[i].Created_By.email")
        Secondary_Email = CkJsonObject::ckStringOf(jResp,"data[i].Secondary_Email")
        Description = CkJsonObject::ckStringOf(jResp,"data[i].Description")
        Vendor_Name = CkJsonObject::ckStringOf(jResp,"data[i].Vendor_Name")
        Mailing_Zip = CkJsonObject::ckStringOf(jResp,"data[i].Mailing_Zip")
        Sreview_processApprove = CkJsonObject::ckBoolOf(jResp,"data[i].$review_process.approve")
        Sreview_processReject = CkJsonObject::ckBoolOf(jResp,"data[i].$review_process.reject")
        Sreview_processResubmit = CkJsonObject::ckBoolOf(jResp,"data[i].$review_process.resubmit")
        Twitter = CkJsonObject::ckStringOf(jResp,"data[i].Twitter")
        Other_Zip = CkJsonObject::ckStringOf(jResp,"data[i].Other_Zip")
        Mailing_Street = CkJsonObject::ckStringOf(jResp,"data[i].Mailing_Street")
        Salutation = CkJsonObject::ckStringOf(jResp,"data[i].Salutation")
        First_Name = CkJsonObject::ckStringOf(jResp,"data[i].First_Name")
        Full_Name = CkJsonObject::ckStringOf(jResp,"data[i].Full_Name")
        Asst_Phone = CkJsonObject::ckStringOf(jResp,"data[i].Asst_Phone")
        Record_Image = CkJsonObject::ckStringOf(jResp,"data[i].Record_Image")
        Modified_ByName = CkJsonObject::ckStringOf(jResp,"data[i].Modified_By.name")
        Modified_ById = CkJsonObject::ckStringOf(jResp,"data[i].Modified_By.id")
        Modified_ByEmail = CkJsonObject::ckStringOf(jResp,"data[i].Modified_By.email")
        Sreview = CkJsonObject::ckStringOf(jResp,"data[i].$review")
        Skype_ID = CkJsonObject::ckStringOf(jResp,"data[i].Skype_ID")
        Phone = CkJsonObject::ckStringOf(jResp,"data[i].Phone")
        Account_NameName = CkJsonObject::ckStringOf(jResp,"data[i].Account_Name.name")
        Account_NameId = CkJsonObject::ckStringOf(jResp,"data[i].Account_Name.id")
        Email_Opt_Out = CkJsonObject::ckBoolOf(jResp,"data[i].Email_Opt_Out")
        Modified_Time = CkJsonObject::ckStringOf(jResp,"data[i].Modified_Time")
        Date_of_Birth = CkJsonObject::ckStringOf(jResp,"data[i].Date_of_Birth")
        Mailing_City = CkJsonObject::ckStringOf(jResp,"data[i].Mailing_City")
        Unsubscribed_Time = CkJsonObject::ckStringOf(jResp,"data[i].Unsubscribed_Time")
        Title = CkJsonObject::ckStringOf(jResp,"data[i].Title")
        Other_Street = CkJsonObject::ckStringOf(jResp,"data[i].Other_Street")
        Mobile = CkJsonObject::ckStringOf(jResp,"data[i].Mobile")
        Sorchestration = CkJsonObject::ckBoolOf(jResp,"data[i].$orchestration")
        Sstop_processing = CkJsonObject::ckBoolOf(jResp,"data[i].$stop_processing")
        Last_Name = CkJsonObject::ckStringOf(jResp,"data[i].Last_Name")
        Sin_merge = CkJsonObject::ckBoolOf(jResp,"data[i].$in_merge")
        Lead_Source = CkJsonObject::ckStringOf(jResp,"data[i].Lead_Source")
        Fax = CkJsonObject::ckStringOf(jResp,"data[i].Fax")
        Sapproval_state = CkJsonObject::ckStringOf(jResp,"data[i].$approval_state")
        Reporting_ToName = CkJsonObject::ckStringOf(jResp,"data[i].Reporting_To.name")
        Reporting_ToId = CkJsonObject::ckStringOf(jResp,"data[i].Reporting_To.id")
        Account_Name = CkJsonObject::ckStringOf(jResp,"data[i].Account_Name")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"data[i].Tag")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            j = j + 1
        Wend
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2/Deals/738964000002224056/Contact_Roles

Postman Collection Item JSON

{
  "name": "Contact Roles of a Specific Deal",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{api-domain}}/crm/v2/Deals/738964000002224056/Contact_Roles",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Deals",
        "738964000002224056",
        "Contact_Roles"
      ]
    }
  },
  "response": [
    {
      "name": "SUCCESS RESPONSE",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{api-domain}}/crm/v2/Deals/738964000002224056/Contact_Roles",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2",
            "Deals",
            "738964000002224056",
            "Contact_Roles"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Fri, 18 Jun 2021 13:12:08 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Referrer-Policy",
          "value": "strict-origin"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "Pragma",
          "value": "no-cache"
        },
        {
          "key": "Cache-Control",
          "value": "no-store, no-cache, must-revalidate, private"
        },
        {
          "key": "Expires",
          "value": "Thu, 01 Jan 1970 00:00:00 GMT"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-ACCESSTOKEN-RESET",
          "value": "2021-06-18T13:56:39+00:00"
        },
        {
          "key": "clientVersion",
          "value": "4126581"
        },
        {
          "key": "clientsubVersion",
          "value": "4db5c971143ce609008746cb1d40f588"
        },
        {
          "key": "Content-Disposition",
          "value": "attachment; filename=response.json"
        },
        {
          "key": "vary",
          "value": "accept-encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Content-Language",
          "value": "en-US"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"data\": [\n        {\n            \"Owner\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"738964000000291009\",\n                \"email\": \"patricia.b@zylker.com\"\n            },\n            \"Email\": null,\n            \"$currency_symbol\": \"Af\",\n            \"Other_Phone\": null,\n            \"Mailing_State\": null,\n            \"Other_State\": null,\n            \"Other_Country\": null,\n            \"Last_Activity_Time\": \"2021-03-02T08:06:35+00:00\",\n            \"Department\": null,\n            \"Contact_Role\": \"738964000000007170\",\n            \"$state\": \"save\",\n            \"Unsubscribed_Mode\": null,\n            \"$process_flow\": false,\n            \"Assistant\": null,\n            \"Exchange_Rate\": 1,\n            \"Currency\": \"AFN\",\n            \"Mailing_Country\": null,\n            \"Data_Processing_Basis_Details\": null,\n            \"id\": \"738964000001112068\",\n            \"Data_Source\": \"Manual\",\n            \"$approved\": true,\n            \"Reporting_To\": null,\n            \"$approval\": {\n                \"delegate\": false,\n                \"approve\": false,\n                \"reject\": false,\n                \"resubmit\": false\n            },\n            \"Other_City\": null,\n            \"$data_source_details\": null,\n            \"Created_Time\": \"2020-07-09T06:36:27+00:00\",\n            \"$editable\": true,\n            \"Home_Phone\": null,\n            \"Created_By\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"738964000000291009\",\n                \"email\": \"patricia@zylker.com\"\n            },\n            \"Secondary_Email\": null,\n            \"Description\": null,\n            \"Vendor_Name\": null,\n            \"Mailing_Zip\": null,\n            \"$review_process\": {\n                \"approve\": false,\n                \"reject\": false,\n                \"resubmit\": false\n            },\n            \"Twitter\": null,\n            \"Other_Zip\": null,\n            \"Mailing_Street\": null,\n            \"Salutation\": null,\n            \"First_Name\": null,\n            \"Full_Name\": \"Boyle\",\n            \"Asst_Phone\": null,\n            \"Record_Image\": null,\n            \"Modified_By\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"738964000000291009\",\n                \"email\": \"patricia@zylker.com\"\n            },\n            \"$review\": null,\n            \"Skype_ID\": null,\n            \"Phone\": null,\n            \"Account_Name\": {\n                \"name\": \"zylker\",\n                \"id\": \"738964000001112135\"\n            },\n            \"Email_Opt_Out\": false,\n            \"Modified_Time\": \"2020-10-22T14:46:41+00:00\",\n            \"Date_of_Birth\": null,\n            \"Mailing_City\": null,\n            \"Unsubscribed_Time\": null,\n            \"Title\": null,\n            \"Other_Street\": null,\n            \"Mobile\": null,\n            \"$orchestration\": false,\n            \"$stop_processing\": false,\n            \"Last_Name\": \"Boyle\",\n            \"$in_merge\": false,\n            \"Lead_Source\": null,\n            \"Tag\": [],\n            \"Fax\": null,\n            \"$approval_state\": \"approved\"\n        },\n        {\n            \"Owner\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"738964000000291009\",\n                \"email\": \"patricia@zylker.com\"\n            },\n            \"Email\": null,\n            \"$currency_symbol\": \"Af\",\n            \"Other_Phone\": null,\n            \"Mailing_State\": null,\n            \"Other_State\": null,\n            \"Other_Country\": null,\n            \"Last_Activity_Time\": null,\n            \"Department\": null,\n            \"Contact_Role\": \"738964000000007170\",\n            \"$state\": \"save\",\n            \"Unsubscribed_Mode\": null,\n            \"$process_flow\": false,\n            \"Assistant\": null,\n            \"Exchange_Rate\": 1,\n            \"Currency\": \"AFN\",\n            \"Mailing_Country\": null,\n            \"Data_Processing_Basis_Details\": null,\n            \"id\": \"738964000001682005\",\n            \"Data_Source\": \"Manual\",\n            \"$approved\": true,\n            \"Reporting_To\": {\n                \"name\": \"Boyle\",\n                \"id\": \"738964000001112068\"\n            },\n            \"$approval\": {\n                \"delegate\": false,\n                \"approve\": false,\n                \"reject\": false,\n                \"resubmit\": false\n            },\n            \"Other_City\": null,\n            \"$data_source_details\": null,\n            \"Created_Time\": \"2020-12-15T07:09:59+00:00\",\n            \"$editable\": true,\n            \"Home_Phone\": null,\n            \"Created_By\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"738964000000291009\",\n                \"email\": \"patricia@zylker.com\"\n            },\n            \"Secondary_Email\": null,\n            \"Description\": null,\n            \"Vendor_Name\": null,\n            \"Mailing_Zip\": null,\n            \"$review_process\": {\n                \"approve\": false,\n                \"reject\": false,\n                \"resubmit\": false\n            },\n            \"Twitter\": null,\n            \"Other_Zip\": null,\n            \"Mailing_Street\": null,\n            \"Salutation\": \"Ms.\",\n            \"First_Name\": \"Patricia\",\n            \"Full_Name\": \"Ms. Patricia Boyle\",\n            \"Asst_Phone\": null,\n            \"Record_Image\": null,\n            \"Modified_By\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"738964000000291009\",\n                \"email\": \"patricia@zylker.com\"\n            },\n            \"$review\": null,\n            \"Skype_ID\": null,\n            \"Phone\": null,\n            \"Account_Name\": {\n                \"name\": \"zylker\",\n                \"id\": \"738964000001112135\"\n            },\n            \"Email_Opt_Out\": false,\n            \"Modified_Time\": \"2020-12-15T07:09:59+00:00\",\n            \"Date_of_Birth\": null,\n            \"Mailing_City\": null,\n            \"Unsubscribed_Time\": null,\n            \"Title\": null,\n            \"Other_Street\": null,\n            \"Mobile\": null,\n            \"$orchestration\": false,\n            \"$stop_processing\": false,\n            \"Last_Name\": \"Boyle\",\n            \"$in_merge\": false,\n            \"Lead_Source\": null,\n            \"Tag\": [],\n            \"Fax\": null,\n            \"$approval_state\": \"approved\"\n        },\n        {\n            \"Owner\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"738964000000291009\",\n                \"email\": \"patricia@zylker.com\"\n            },\n            \"Email\": null,\n            \"$currency_symbol\": \"Af\",\n            \"Other_Phone\": null,\n            \"Mailing_State\": null,\n            \"Other_State\": null,\n            \"Other_Country\": null,\n            \"Last_Activity_Time\": null,\n            \"Department\": null,\n            \"Contact_Role\": \"738964000000007170\",\n            \"$state\": \"save\",\n            \"Unsubscribed_Mode\": null,\n            \"$process_flow\": false,\n            \"Assistant\": null,\n            \"Exchange_Rate\": 1,\n            \"Currency\": \"AFN\",\n            \"Mailing_Country\": null,\n            \"Data_Processing_Basis_Details\": null,\n            \"id\": \"738964000001919009\",\n            \"Data_Source\": \"API\",\n            \"$approved\": true,\n            \"Reporting_To\": null,\n            \"$approval\": {\n                \"delegate\": false,\n                \"approve\": false,\n                \"reject\": false,\n                \"resubmit\": false\n            },\n            \"Other_City\": null,\n            \"$data_source_details\": {},\n            \"Created_Time\": \"2021-03-02T09:18:59+00:00\",\n            \"$editable\": true,\n            \"Home_Phone\": null,\n            \"Created_By\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"738964000000291009\",\n                \"email\": \"patricia@zylker.com\"\n            },\n            \"Secondary_Email\": null,\n            \"Description\": null,\n            \"Vendor_Name\": null,\n            \"Mailing_Zip\": null,\n            \"$review_process\": {\n                \"approve\": false,\n                \"reject\": false,\n                \"resubmit\": false\n            },\n            \"Twitter\": null,\n            \"Other_Zip\": null,\n            \"Mailing_Street\": null,\n            \"Salutation\": null,\n            \"First_Name\": null,\n            \"Full_Name\": \"Patricia\",\n            \"Asst_Phone\": null,\n            \"Record_Image\": null,\n            \"Modified_By\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"738964000000291009\",\n                \"email\": \"patricia@zylker.com\"\n            },\n            \"$review\": null,\n            \"Skype_ID\": null,\n            \"Phone\": null,\n            \"Account_Name\": null,\n            \"Email_Opt_Out\": false,\n            \"Modified_Time\": \"2021-03-02T09:18:59+00:00\",\n            \"Date_of_Birth\": null,\n            \"Mailing_City\": null,\n            \"Unsubscribed_Time\": null,\n            \"Title\": null,\n            \"Other_Street\": null,\n            \"Mobile\": null,\n            \"$orchestration\": false,\n            \"$stop_processing\": false,\n            \"Last_Name\": \"Patricia\",\n            \"$in_merge\": false,\n            \"Lead_Source\": null,\n            \"Tag\": [],\n            \"Fax\": null,\n            \"$approval_state\": \"approved\"\n        },\n        {\n            \"Owner\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"738964000000291009\",\n                \"email\": \"patricia@zylker.com\"\n            },\n            \"Email\": \"contact_test@xyz.com\",\n            \"$currency_symbol\": \"Af\",\n            \"Other_Phone\": null,\n            \"Mailing_State\": \"Colorado\",\n            \"Other_State\": null,\n            \"Other_Country\": null,\n            \"Last_Activity_Time\": \"2021-06-02T15:46:37+00:00\",\n            \"Department\": null,\n            \"Contact_Role\": null,\n            \"$state\": \"save\",\n            \"Unsubscribed_Mode\": null,\n            \"$process_flow\": false,\n            \"Assistant\": null,\n            \"Exchange_Rate\": 1,\n            \"Currency\": \"AFN\",\n            \"Mailing_Country\": null,\n            \"Data_Processing_Basis_Details\": null,\n            \"id\": \"738964000002224050\",\n            \"Data_Source\": \"Converted\",\n            \"$approved\": true,\n            \"Reporting_To\": null,\n            \"$approval\": {\n                \"delegate\": false,\n                \"approve\": false,\n                \"reject\": false,\n                \"resubmit\": false\n            },\n            \"Other_City\": null,\n            \"$data_source_details\": null,\n            \"Created_Time\": \"2021-06-02T15:46:36+00:00\",\n            \"$editable\": true,\n            \"Home_Phone\": null,\n            \"Created_By\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"738964000000291009\",\n                \"email\": \"patricia@zylker.com\"\n            },\n            \"Secondary_Email\": null,\n            \"Description\": null,\n            \"Vendor_Name\": null,\n            \"Mailing_Zip\": \"1234\",\n            \"$review_process\": {\n                \"approve\": false,\n                \"reject\": false,\n                \"resubmit\": false\n            },\n            \"Twitter\": null,\n            \"Other_Zip\": null,\n            \"Mailing_Street\": null,\n            \"Salutation\": null,\n            \"First_Name\": null,\n            \"Full_Name\": \"Contact_test\",\n            \"Asst_Phone\": null,\n            \"Record_Image\": null,\n            \"Modified_By\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"738964000000291009\",\n                \"email\": \"patricia@zylker.com\"\n            },\n            \"$review\": null,\n            \"Skype_ID\": null,\n            \"Phone\": null,\n            \"Account_Name\": null,\n            \"Email_Opt_Out\": false,\n            \"Modified_Time\": \"2021-06-02T15:46:36+00:00\",\n            \"Date_of_Birth\": null,\n            \"Mailing_City\": null,\n            \"Unsubscribed_Time\": null,\n            \"Title\": null,\n            \"Other_Street\": null,\n            \"Mobile\": null,\n            \"$orchestration\": false,\n            \"$stop_processing\": false,\n            \"Last_Name\": \"Contact_test\",\n            \"$in_merge\": false,\n            \"Lead_Source\": null,\n            \"Tag\": [],\n            \"Fax\": null,\n            \"$approval_state\": \"approved\"\n        }\n    ],\n    \"info\": {\n        \"per_page\": 200,\n        \"count\": 4,\n        \"page\": 1,\n        \"more_records\": false\n    }\n}"
    },
    {
      "name": "INVALID_MODULE",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{api-domain}}/crm/v2/Deal/738964000002224056/Contact_Roles",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2",
            "Deal",
            "738964000002224056",
            "Contact_Roles"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Fri, 18 Jun 2021 13:16:04 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "110"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Referrer-Policy",
          "value": "strict-origin"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "Pragma",
          "value": "no-cache"
        },
        {
          "key": "Cache-Control",
          "value": "no-store, no-cache, must-revalidate, private"
        },
        {
          "key": "Expires",
          "value": "Thu, 01 Jan 1970 00:00:00 GMT"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-ACCESSTOKEN-RESET",
          "value": "2021-06-18T13:56:39+00:00"
        },
        {
          "key": "clientVersion",
          "value": "4126581"
        },
        {
          "key": "clientsubVersion",
          "value": "4db5c971143ce609008746cb1d40f588"
        },
        {
          "key": "Content-Disposition",
          "value": "attachment; filename=response.json"
        },
        {
          "key": "X-Download-Options",
          "value": "noopen"
        },
        {
          "key": "Content-Language",
          "value": "en-US"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"code\": \"INVALID_MODULE\",\n    \"details\": {},\n    \"message\": \"the module name given seems to be invalid\",\n    \"status\": \"error\"\n}"
    },
    {
      "name": "INVALID_REQUEST_METHOD",
      "originalRequest": {
        "method": "COPY",
        "header": [
        ],
        "url": {
          "raw": "{{api-domain}}/crm/v2/Deals/738964000002224056/Contact_Roles",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2",
            "Deals",
            "738964000002224056",
            "Contact_Roles"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Fri, 18 Jun 2021 13:16:31 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "124"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Frame-Options",
          "value": "deny"
        },
        {
          "key": "X-Download-Options",
          "value": "noopen"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"code\": \"INVALID_REQUEST_METHOD\",\n    \"details\": {},\n    \"message\": \"The http request method type is not a valid one\",\n    \"status\": \"error\"\n}"
    },
    {
      "name": "AUTHENTICATION_FAILURE",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{api-domain}}/crm/v2/Deals/738964000002224056/Contact_Roles",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2",
            "Deals",
            "738964000002224056",
            "Contact_Roles"
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Fri, 18 Jun 2021 13:16:48 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "98"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Referrer-Policy",
          "value": "strict-origin"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "Pragma",
          "value": "no-cache"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Expires",
          "value": "Thu, 01 Jan 1970 00:00:00 GMT"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-Download-Options",
          "value": "noopen"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"code\": \"AUTHENTICATION_FAILURE\",\n    \"details\": {},\n    \"message\": \"Authentication failed\",\n    \"status\": \"error\"\n}"
    },
    {
      "name": "INVALID_DATA",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{api-domain}}/crm/v2/Deals/73896400000222405/Contact_Roles",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2",
            "Deals",
            "73896400000222405",
            "Contact_Roles"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Fri, 18 Jun 2021 13:17:03 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "107"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Referrer-Policy",
          "value": "strict-origin"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "Pragma",
          "value": "no-cache"
        },
        {
          "key": "Cache-Control",
          "value": "no-store, no-cache, must-revalidate, private"
        },
        {
          "key": "Expires",
          "value": "Thu, 01 Jan 1970 00:00:00 GMT"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-ACCESSTOKEN-RESET",
          "value": "2021-06-18T13:56:39+00:00"
        },
        {
          "key": "clientVersion",
          "value": "4126581"
        },
        {
          "key": "clientsubVersion",
          "value": "4db5c971143ce609008746cb1d40f588"
        },
        {
          "key": "Content-Disposition",
          "value": "attachment; filename=response.json"
        },
        {
          "key": "X-Download-Options",
          "value": "noopen"
        },
        {
          "key": "Content-Language",
          "value": "en-US"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"code\": \"INVALID_DATA\",\n    \"details\": {},\n    \"message\": \"the related id given seems to be invalid\",\n    \"status\": \"error\"\n}"
    }
  ]
}