Events Notifications

Overview

Each notification generated through the Events API has an associated Topic ID and Template ID. The Topic uniquely identifies the purpose of the notification (i.e. what event it represents) whereas the Template identifies the format of the information presented within the notification (i.e. what data properties will be included). 

Primary Templates

TID-002 (generic notification)

{
  "MessageId":"d6c94090-97b4-ea11-845d-20677cddb4f2",
  "LockId":"d9c94090-97b4-ea11-845d-20677cddb4f2",
  "Topic":"2-nnn",
  "CompanyCode":"GF",
  "MessageType":"{ITASMessage}",
  "MessageBody":
  {
    "TID":"TID-002",
    "InnerBody":
    {
      "TradingEntity":"qa",
      "Title":"Message Title",
      "Message":"Message Content",
      "SubmittedBy":"Domain\Username",
​      "AdditionalParameters":
      [
        {
          "Key":"parameter1",
          "Value":"ONE"
        },
        {
          "Key":"parameter2",
          "Value":"TWO"
        }
      ],
    }
  },
  "EnqueueTime":"yyyy-mm-ddThh:nn:ss.mm",
  "ServiceResult":null
}

TID-010 (entity-specific notification)

{
  "MessageId":"d6c94090-97b4-ea11-845d-20677cddb4f2",
  "LockId":"d9c94090-97b4-ea11-845d-20677cddb4f2",
  "Topic":"2-nnn",
  "CompanyCode":"GF",
  "MessageType":"{ITASMessage}",
  "MessageBody":
  {
    "TID":"TID-010",
    "InnerBody":
    {
      "TradingEntity":"qa",
      "EntityID":"identity of contract, future etc",
      "EntityType":"contract|client|wip|docref|...",
      "AdditionalParameters":
      [
        {
          "Key":"parameter1",
          "Value":"ONE"
        },
        {
          "Key":"parameter2",
          "Value":"TWO"
        }
      ],
    }
  },
  "EnqueueTime":"yyyy-mm-ddThh:nn:ss.mm",
  "ServiceResult":null
}

TID-013 (accounting document notification)

{
  "MessageId":"d6c94090-97b4-ea11-845d-20677cddb4f2",
  "LockId":"d9c94090-97b4-ea11-845d-20677cddb4f2",
  "Topic":"3-8",
  "CompanyCode":"GF",
  "MessageType":"{ITASMessage}",
  "MessageBody":
  {
    "TID":"TID-013",
    "InnerBody":
    {
      "TradingEntity":"qa",
      "DocumentReference":"itas docref",
      "DocumentDate":"yyyymmnn",
      "DocumentType":"mapping code",
      "Style":"purchase|sales|payable|receivable|buy|sell|temporaryadjustment|journal",
    }
  },
  "EnqueueTime":"yyyy-mm-ddThh:nn:ss.mm",
  "ServiceResult":null
}

TID-014 (operational/functional notification)

{
  "MessageId":"d6c94090-97b4-ea11-845d-20677cddb4f2",
  "LockId":"d9c94090-97b4-ea11-845d-20677cddb4f2",
  "Topic":"3-10",
  "CompanyCode":"GF",
  "MessageType":"{ITASMessage}",
  "MessageBody":
  {
    "TID":"TID-014",
    "InnerBody":
    {
      "TradingEntity":"qa",
      "EntityID":"identity of contract, future etc",
      "EntityType":"contract|client|wip|docref|...",
      "EventType":"mapping code",
      "AdditionalParameters":
      [
        {
          "Key":"parameter1",
          "Value":"ONE"
        },
        {
          "Key":"parameter2",
          "Value":"TWO"
        }
      ],
    }
  },
  "EnqueueTime":"yyyy-mm-ddThh:nn:ss.mm",
  "ServiceResult":null
}

TID-018 (workflow/process request)

{
  "MessageId":"d6c94090-97b4-ea11-845d-20677cddb4f2",
  "LockId":"d9c94090-97b4-ea11-845d-20677cddb4f2",
  "Topic":"3-nnn",
  "CompanyCode":"GF",
  "MessageType":"{ITASMessage}",
  "MessageBody":
  {
    "TID":"TID-018",
    "InnerBody":
    {
      "TradingEntity":"qa",
      "AdditionalParameters":
      [
        {
          "Key":"parameter1",
          "Value":"ONE"
        },
        {
          "Key":"parameter2",
          "Value":"TWO"
        }
      ],
    }
  },
  "EnqueueTime":"yyyy-mm-ddThh:nn:ss.mm",
  "ServiceResult":null
}

 

AdditionalParameters

When information specific to the Topic needs to be included, the AdditionalParameters section is used.
The list below identifies Topics that contain AdditionalParameters.

Topic 2-13 / 6-3 (redirected to 3-10) 

1 Key  freezedate
Value  yyyymmdd OR yyyymm32 for month freeze

Topic 2-266 (redirected to 3-10)

1 Key  docname
Value  name of the document 
2 Key  doctype
Value  type of document ('WI')
3 Key  docdescription
Value  description of type of document  ('Warehouse Instruction')
4 Key  contractlist
Value  contract collection

Topic 6-20 (redirected to 3-10) 

1 Key  submittedby
Value  username

Topic 6-21

1 Key  docname
Value  name of the document
2 Key  doctype
Value  document classification
3 Key  docindexid  
Value  document ID as required when using GET /Documents/{id} (for index details) and GET /Documents{id}/download (for retrieving the document) 
4 Key  action 
Value  Added ¦ Updated ¦ Deleted  
5 Key  actionstatus
Value  OK ¦ Aborted ¦ Failed
6  Key  actionresponse
Value  message presented to user

Topic 3-300

1 Key  DATE
Value  yyyymmdd OR yyyymm32 for month freeze
2 Key  KEEPDAYS
Value  n = number of days to keep
3 Key  KEEPFRIDAYS
Value  n = number of friday freezes to keep  

NOTE: Notifications available through Topic 6-21 for processes that use Document Services API