Swift Dynamics CRM: Get Accounts

Back to Index

This example queries the accounts entity set and uses the $select system query option to return the name property for each account.

Documentation: https://msdn.microsoft.com/en-us/library/gg334767.aspx#Basic query example

CURL Command

curl -X GET https://my-dynamics-domain.api.crm.dynamics.com/api/data/v9.0/accounts?$select=name \
  -H "Accept: application/json" \
  -H "OData-MaxVersion: 4.0"  \
  -H "OData-Version: 4.0" \
  -H "Authorization: Bearer DYNAMICS_CRM_ACCESS_TOKEN"

Swift Example


func chilkatTest() {
    let rest = CkoRest()
    var success: Bool

    //  URL: https://my-dynamics-domain.api.crm.dynamics.com/api/data/v9.0/accounts?$select=name
    var bTls: Bool = true
    var port: Int = 443
    var bAutoReconnect: Bool = true
    success = rest.Connect("my-dynamics-domain.api.crm.dynamics.com", port: port, tls: bTls, autoReconnect: bAutoReconnect)
    if success != true {
        print("ConnectFailReason: \(rest.ConnectFailReason.intValue)")
        print("\(rest.LastErrorText)")
        return
    }

    rest.AddHeader("OData-MaxVersion", value: "4.0")
    rest.AddHeader("Accept", value: "application/json")
    rest.AddHeader("OData-Version", value: "4.0")
    rest.AddHeader("Authorization", value: "Bearer DYNAMICS_CRM_ACCESS_TOKEN")

    let sbResponseBody = CkoStringBuilder()
    success = rest.FullRequestNoBodySb("GET", uriPath: "/api/data/v9.0/accounts?$select=name", sb: sbResponseBody)
    if success != true {
        print("\(rest.LastErrorText)")
        return
    }

    var respStatusCode: Int = rest.ResponseStatusCode.intValue
    if respStatusCode >= 400 {
        print("Response Status Code = \(respStatusCode)")
        print("Response Header:")
        print("\(rest.ResponseHeader)")
        print("Response Body:")
        print("\(sbResponseBody.GetAsString())")
        return
    }

    let jsonResponse = CkoJsonObject()
    jsonResponse.LoadSb(sbResponseBody)

    var i: Int
    var count_i: Int

    var odataContext: String? = jsonResponse.StringOf("\"@odata.context\"")
    i = 0
    count_i = jsonResponse.SizeOfArray("value").intValue
    while i < count_i {
        jsonResponse.I = i
        var odataEtag: String? = jsonResponse.StringOf("value[i].\"@odata.etag\"")
        var name: String? = jsonResponse.StringOf("value[i].name")
        var accountid: String? = jsonResponse.StringOf("value[i].accountid")
        i = i + 1
    }


}

Sample JSON Response Body

{
  "@odata.context": "https://mydomain.api.crm.dynamics.com/api/data/v8.2/$metadata#accounts(name)",
  "value": [
    {
      "@odata.etag": "W/\"1817213\"",
      "name": "A. Datum",
      "accountid": "475b158c-541c-e511-80d3-3863bb347ba8"
    },
    {
      "@odata.etag": "W/\"1817214\"",
      "name": "Adventure Works",
      "accountid": "a8a19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817215\"",
      "name": "Alpine Ski House",
      "accountid": "aaa19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817216\"",
      "name": "Blue Yonder Airlines",
      "accountid": "aca19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817217\"",
      "name": "City Power & Light",
      "accountid": "aea19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817218\"",
      "name": "Coho Winery",
      "accountid": "b0a19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817219\"",
      "name": "Consolidated Messenger",
      "accountid": "b2a19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817220\"",
      "name": "Fabrikam, Inc.",
      "accountid": "b4a19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817221\"",
      "name": "Fourth Coffee",
      "accountid": "b6a19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817222\"",
      "name": "Graphic Design Institute",
      "accountid": "b8a19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817223\"",
      "name": "Humongous Insurance",
      "accountid": "baa19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817224\"",
      "name": "Litware",
      "accountid": "bca19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817225\"",
      "name": "Lucerne Publishing",
      "accountid": "bea19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817226\"",
      "name": "Margie's Travel",
      "accountid": "c0a19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817227\"",
      "name": "Northwind Traders",
      "accountid": "c2a19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817228\"",
      "name": "Proseware, Inc.",
      "accountid": "c4a19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817229\"",
      "name": "School of Fine Art",
      "accountid": "c6a19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817230\"",
      "name": "Southridge Video",
      "accountid": "c8a19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817231\"",
      "name": "Tailspin Toys",
      "accountid": "caa19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817232\"",
      "name": "The Phone Company",
      "accountid": "cca19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817233\"",
      "name": "Trey Research",
      "accountid": "cea19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817234\"",
      "name": "Wide World Importers",
      "accountid": "d0a19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817235\"",
      "name": "Wingtip Toys",
      "accountid": "d2a19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817236\"",
      "name": "Woodgrove Bank",
      "accountid": "d4a19cdd-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1817237\"",
      "name": "Best o' Sales",
      "accountid": "2123455d-be62-e411-80d6-b4b52f567ec8"
    },
    {
      "@odata.etag": "W/\"1817238\"",
      "name": "Microsoft",
      "accountid": "d3ae1b3a-8bd2-e411-80ef-c4346bac7be8"
    }
  ]
}