Chilkat Online Tools

PureBasic / Support API / Create Organization

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "login")
    CkHttp::setCkPassword(http, "password")

    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    resp.i = CkHttp::ckQuickRequest(http,"POST","https://example.zendesk.com/api/v2/organizations")
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

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

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    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 = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

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

    CkHttpResponse::ckDispose(resp)

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

    ; {
    ;   "organization": {
    ;     "created_at": "<string>",
    ;     "details": "<string>",
    ;     "domain_names": [
    ;       "<string>",
    ;       "<string>"
    ;     ],
    ;     "external_id": "<string>",
    ;     "group_id": "<integer>",
    ;     "id": "<integer>",
    ;     "name": "<string>",
    ;     "notes": "<string>",
    ;     "organization_fields": {
    ;       "fugiat5_0": "<string>",
    ;       "exercitation_039": "<string>",
    ;       "laboris_60": "<string>"
    ;     },
    ;     "shared_comments": "<boolean>",
    ;     "shared_tickets": "<boolean>",
    ;     "tags": [
    ;       "<string>",
    ;       "<string>"
    ;     ],
    ;     "updated_at": "<string>",
    ;     "url": "<string>"
    ;   }
    ; }

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

    strVal.s

    Created_at.s = CkJsonObject::ckStringOf(jResp,"organization.created_at")
    Details.s = CkJsonObject::ckStringOf(jResp,"organization.details")
    External_id.s = CkJsonObject::ckStringOf(jResp,"organization.external_id")
    Group_id.s = CkJsonObject::ckStringOf(jResp,"organization.group_id")
    Id.s = CkJsonObject::ckStringOf(jResp,"organization.id")
    Name.s = CkJsonObject::ckStringOf(jResp,"organization.name")
    Notes.s = CkJsonObject::ckStringOf(jResp,"organization.notes")
    Fugiat5_0.s = CkJsonObject::ckStringOf(jResp,"organization.organization_fields.fugiat5_0")
    Exercitation_039.s = CkJsonObject::ckStringOf(jResp,"organization.organization_fields.exercitation_039")
    Laboris_60.s = CkJsonObject::ckStringOf(jResp,"organization.organization_fields.laboris_60")
    Shared_comments.s = CkJsonObject::ckStringOf(jResp,"organization.shared_comments")
    Shared_tickets.s = CkJsonObject::ckStringOf(jResp,"organization.shared_tickets")
    Updated_at.s = CkJsonObject::ckStringOf(jResp,"organization.updated_at")
    v_Url.s = CkJsonObject::ckStringOf(jResp,"organization.url")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"organization.domain_names")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        strVal = CkJsonObject::ckStringOf(jResp,"organization.domain_names[i]")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"organization.tags")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        strVal = CkJsonObject::ckStringOf(jResp,"organization.tags[i]")
        i = i + 1
    Wend


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


    ProcedureReturn
EndProcedure

Curl Command

curl  -u login:password -X POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/organizations

Postman Collection Item JSON

{
  "name": "Create Organization",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/organizations",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "organizations"
      ]
    },
    "description": "You must provide a unique `name` for each organization. Normally\nthe system doesn't allow records to be created with identical names.\nHowever, a race condition can occur if you make two or more identical\nPOSTs very close to each other, causing the records to have identical\norganization names.\n\n#### Allowed For\n\n* Admins\n* Agents assigned to a custom role with permissions to manage organizations (Enterprise only)\n"
  },
  "response": [
    {
      "name": "Created",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/organizations",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organizations"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"organization\": {\n    \"created_at\": \"<string>\",\n    \"details\": \"<string>\",\n    \"domain_names\": [\n      \"<string>\",\n      \"<string>\"\n    ],\n    \"external_id\": \"<string>\",\n    \"group_id\": \"<integer>\",\n    \"id\": \"<integer>\",\n    \"name\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"organization_fields\": {\n      \"fugiat5_0\": \"<string>\",\n      \"exercitation_039\": \"<string>\",\n      \"laboris_60\": \"<string>\"\n    },\n    \"shared_comments\": \"<boolean>\",\n    \"shared_tickets\": \"<boolean>\",\n    \"tags\": [\n      \"<string>\",\n      \"<string>\"\n    ],\n    \"updated_at\": \"<string>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}