Versions Compared

Old Version 8

changes.mady.by.user Seth Petry-Johnson

Saved on

compared with

New Version 9

changes.mady.by.user Seth Petry-Johnson

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Response Code

Headers and Body

200 (Ok)

Code Block
languagejson
[
  { 
    "ProgramId": "subscriber_program_id", 
    "PublisherProgramId": "publisher_program_id", 
    "CreatedUtc": "UTC date/time",
    "LastSyncUtc": "UTC date/time",
    "SynEnabled": true,
    "LbApiPayloadTemplate": "... (see docs above) ..."
  }{
      "SOME_CATEGORY": {
        "action": "import",
        "label": "ACME Course",
        "importProcessId": {WIQ Process Id},
        "batchRowTemplate": "{handlebars template}"
      }
    }    
  },
  ...
]

...

GET /api/programs/{programId}/eventSubs/{publisherId}
Handy status macro
set36399
isLabeledfalse
historySnapshotId7cfb151d-d309-448c-9e11-ef4dcd1953cc
status185953
historyChainId995d84a4-485f-470b-9882-e5f4d573912a

...

Response Code

Headers and Body

200 (Ok)

Code Block
languagejson
{ 
  "ProgramId": "foo", 
  "PublisherProgramId": "bar", 
  "CreatedUtc": "UTC date/time",
  "LastSyncUtc": "UTC date/time",
  "SynEnabled": true,
  "LbApiPayloadTemplate": "...{ (see docs above) ..."}  
}

...

POST /api/programs/{programId}/eventSubs
Handy status macro
set36399
isLabeledfalse
historySnapshotId7cfb151d-d309-448c-9e11-ef4dcd1953cc
status185953
historyChainId995d84a4-485f-470b-9882-e5f4d573912a

Info

Creates a new Event Subscription. Returns an error if it already exists.

Audit fields such as CreatedUtc are assigned during creation.

JSON Payload

Code Block
{
 
  "PublisherProgramId": "PublisherId",
  "SyncEnabled": true,
  "LbApiPayloadTemplate": {
    "SyncEnabled"SOME_CATEGORY": {
      "action": true"import",
      "LbApiPayloadTemplatelabel": "ACME Course",
      "... (see docs above) ..."    
}"importProcessId": {WIQ Process Id},
      "batchRowTemplate": "{handlebars template}"
    }
  }    
}

Responses

Response Code

Headers and Body

201 (Created)

A new Event Subscription was created. No body is returned.

HTTP headers:

Location: /API/programs/{programId}/eventSubs/{pubProgId}

...

Code Block
{
    "LastSyncUtc": "date",
    "SyncEnabled": true,
    "LbApiPayloadTemplate": "...{ (see docs above) ..." }  
}

Responses

Response Code

Headers and Body

204 (No Content)

Update was performed successfully. No body is returned.

...