Visual FoxPro

SharePoint -- Create List

See more SharePoint Examples

This example shows how to create a new SharePoint list. Visual FoxPro

LOCAL lnSuccess
LOCAL loHttp
LOCAL loReq
LOCAL loJson
LOCAL lnBUseTls
LOCAL loResp

lnSuccess = 0

* This requires the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

loHttp = CreateObject('Chilkat.Http')

* If SharePoint Windows classic authentication is used, then set the 
* Login, Password, LoginDomain, and NtlmAuth properties.
loHttp.Login = "SHAREPOINT_USERNAME"
loHttp.Password = "SHAREPOINT_PASSWORD"
loHttp.LoginDomain = "SHAREPOINT_NTLM_DOMAIN"
loHttp.NtlmAuth = 1

* The more common case is to use SharePoint Online authentication (via the SPOIDCRL cookie).
* If so, do not set Login, Password, LoginDomain, and NtlmAuth, and instead
* establish the cookie as shown at SharePoint Online Authentication

* To create a list, we're going to POST to
* https://SHAREPOINT_HTTPS_DOMAIN/_api/web/lists
* with a request body containing the following JSON:
* 
* {
*   "__metadata": {
*     "type": "SP.List"
*   },
*   "AllowContentTypes": true,
*   "BaseTemplate": 100,
*  "ContentTypesEnabled": true,
*  "Description": "My list description",
*  "Title": "Test"
* }

* This example will create a folder named ChilkatTest in /Documents

loReq = CreateObject('Chilkat.HttpRequest')
loReq.HttpVerb = "POST"
loReq.Path = "/_api/web/lists"

* We need to add a form digest value in the X-RequestDigest header field.
* See this example for details on
* how to get (and cache) a form digest value
loReq.AddHeader("X-RequestDigest","SHAREPOINT_FORM_DIGEST")

* Set the Content-Type, and indicate that a JSON response is desired.
loReq.ContentType = "application/json;odata=verbose"
loReq.AddHeader("Accept","application/json;odata=verbose")

* Create and add the JSON body.
* Use this online tool to generate code from sample JSON: 
* Generate Code to Create JSON
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("__metadata.type","SP.List")
loJson.UpdateBool("AllowContentTypes",1)
loJson.UpdateInt("BaseTemplate",100)
loJson.UpdateBool("ContentTypesEnabled",1)
loJson.UpdateString("Description","My list description")
loJson.UpdateString("Title","Test")

* Send the POST using HTTPS (TLS). Port 443 is the default port for https.
lnBUseTls = 1
loResp = CreateObject('Chilkat.HttpResponse')
lnSuccess = loHttp.HttpSReq("SHAREPOINT_HTTPS_DOMAIN",443,lnBUseTls,loReq,loResp)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loReq
    RELEASE loJson
    RELEASE loResp
    CANCEL
ENDIF

* The response body contains JSON.
loJson.Load(loResp.BodyStr)
loJson.EmitCompact = 0

* The expected success response code is 201.
* (Let's also check for 200, just in case things change..)
IF ((loResp.StatusCode <> 200) AND (loResp.StatusCode <> 201)) THEN
    ? "Response status code = " + STR(loResp.StatusCode)
    ? loJson.Emit()
    ? "Failed"
    RELEASE loHttp
    RELEASE loReq
    RELEASE loJson
    RELEASE loResp
    CANCEL
ENDIF

* Show the successful JSON response.
? loJson.Emit()
? "Success."

* Use this online tool to generate parsing code from sample JSON: 
* Generate Parsing Code from JSON

RELEASE loHttp
RELEASE loReq
RELEASE loJson
RELEASE loResp