Statement Forwarding

Details of a statement forwarding configuration.

It is accessible through the following HTTP interfaces:

• REST HTTP Interface via http://www.example.org/api/v2/statementforwarding.

Get all the Learning Locker® statement forwarding.

LearningLocker::statementForwarding()->get();

Get a single Learning Locker® statement forwarding with a statement forwarding's $id.

LearningLocker::statementForwarding($id)->get();

Delete a single Learning Locker® statement forwarding with a statement forwarding's $id.

LearningLocker::statementForwarding($id)->delete();

Create a single Learning Locker® statement forwarding with an array of $data.

LearningLocker::statementForwarding()->create($data);

Update a single Learning Locker® statement forwarding with statement forwarding's $id and an array of $data.

LearningLocker::statementForwarding($id)->update($data);

Data Structure

Learning Locker® Statement Forwarding Documentation

You can use an array when updating or creating a Learning Locker® Statement Forwarding

Statement Forwarding Example

[
  "createdAt" => "2017-09-25T09:50:03.880Z",
  "updatedAt" => "2017-11-06T14:07:27.212Z",
  "owner" => "59198183d8ea540933227030",
  "query" => "{}",
  "organisation" => "59c209c4ad95fd50960c0362",
  "isPublic" => false,
  "configuration" => [
    "authType" => "no auth",
    "protocol" => "https",
    "url" => "example.org/endpoint",
    "maxRetries" => 10,
    "headers" => "{\"Test-Header-Key\":\"Test-Header-Value\"}",
    "secret" => "Dave"
  ],
  "__v" => 0,
  "active" => true,
  "description" => "Updated Statement forwarder"
]

Statement Forwarding Model

{
  "_id" : "59c8d14b0d82b3864a450604",
  "createdAt" : "2017-09-25T09:50:03.880Z",
  "updatedAt" : "2017-11-06T14:07:27.212Z",
  "owner" : "59198183d8ea540933227030",
  "query" : "{}",
  "organisation" : "59c209c4ad95fd50960c0362",
  "isPublic" : false,
  "configuration" : {
      "authType" : "no auth",
      "protocol" : "https",
      "url" : "example.org/endpoint",
      "maxRetries" : 10,
      "headers" : "{\"Test-Header-Key\":\"Test-Header-Value\"}",
      "secret" : "Dave"
  },
  "__v" : 0,
  "active" : true,
  "description" : "Statement forwarder"
}