version 8.3.8

Back | 

WsLiveNote

URL

de.piksel.tech/services/index.php?&mode=json
Use "request" param as post variable for submitting json/xml request payload for all POST requests.

Request Headers

Name

Parameters

  • liveEventUuid => Live Project UUID for the note ot be added to

    type => type of note pre or post live event.

    status => Status of the check: PASS or FAIL

    notes => Any notes associated with the check

Request

Adds a new live note to a live project

Request format

{
  "request": {
    "authentication": {
      "app_token": "7cd207c2-6808-11e3-b865-22000a8a28ea",
      "client_token": "d4c1b92c0acb102ba3e10015c5f061d1",
      "user_token": "f277cb9d46e45f67f44de949cdde110f"
    },
    "header": {
      "header_version": 1,
      "api_version": "5",
      "no_cache": true
    },
    "Ws_Live_Note": {
      "liveEventUuid": "abcd1243",
      "type": "pre",
      "status": "PASS",
      "notes": "All was good prior to event."
    }
  }
}

Test Example

{ "request": { "authentication": { "app_token": "#app_token#", "client_token": "#client_token#", "user_token": "#user_token#" }, "header": { "header_version": 1, "api_version": "5", "no_cache": true }, "Ws_Live_Note": { "liveEventUuid": "abcd1243", "type": "pre", "status": "good", "notes": "All was good prior to event." } } }

Response

Response format

{
  "response": {
    "success": {
      "code": 227,
      "message": "Live note created",
      "details": ""
    },
    "WsLiveNote": {
      "liveNote": {
        "id": 3,
        "liveEventId": 1,
        "userId": 3333,
        "dateAdded": "2014-07-23T17:58:50Z",
        "type": "pre",
        "status": "good",
        "notes": "All was good prior to event"
      }
    }
  }
}