Versions Compared

Old Version 13

changes.mady.by.user Seth Petry-Johnson

Saved on

compared with

New Version 14

changes.mady.by.user Justin Brown

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": {
      "SOME_CATEGORY": {
        "action": "import",
        "label": "ACME Course",
        "importProcessId": {WIQ Process Id},
        "batchRowTemplate": "{handlebars template}"
      }
    }    
  },
  ...
]

...

GET /api/programs/{programId}/eventSubs/{

...

publisherProgramId}
Handy status macro
set36399
isLabeledfalse
historySnapshotId7cfb151d-d309-448c-9e11-ef4dcd1953cc
status185953
historyChainId995d84a4-485f-470b-9882-e5f4d573912a

Info

Returns the details about {programId}'s subscription to {publisherIdpublisherProgramId}'s Events.

Responses

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 }  
}

...

Code Block
{
  "PublisherProgramId": "PublisherIdPublisherProgramId",
  "SyncEnabled": true,
  "LbApiPayloadTemplate": {
    "SOME_CATEGORY": {
      "action": "import",
      "label": "ACME Course",
      "importProcessId": {WIQ Process Id},
      "batchRowTemplate": "{handlebars template}"
    }
  }    
}

...

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}

...

PATCH /api/programs/{programId}/eventSubs/{

...

publisherProgramId}
Handy status macro
set36399
isLabeledfalse
historySnapshotId7cfb151d-d309-448c-9e11-ef4dcd1953cc
status185953
historyChainId995d84a4-485f-470b-9882-e5f4d573912a

Info

Updates an existing Event Subscription.

...

Response Code

Headers and Body

204 (No Content)

Update was performed successfully. No body is returned.

...

DELETE /api/programs/{programId}/eventSubs/{

...

publisherProgramId}
Handy status macro
set36399
isLabeledfalse
historySnapshotId7cfb151d-d309-448c-9e11-ef4dcd1953cc
status185953
historyChainId995d84a4-485f-470b-9882-e5f4d573912a

Info

Deletes an existing Event Subscription.

...