1. REST API for Oracle Digital Experience for Communications Industry Fabric
  2. Tasks
  3. TMF 632 Party Management
  4. Notification Listeners

Sample listener for Create Organization event

post

/party/v4/listener/organizationCreateEvent

This method is a sample client listener for receiving notifications when a Create Organization (OrganizationCreateEvent) event is triggered.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json;charset=utf-8 ()
Root Schema : schema
Type: object
The notification data structure
Show Source
Nested Schema : OrganizationCreateEventPayload
Type: object
The event data structure
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "Organization":"#/components/schemas/Organization", "OrganizationOracle":"#/components/schemas/OrganizationOracle" } }
    Organization represents a group of people identified by shared interests or purpose. Examples include business, department and enterprise. Because of the complex nature of many businesses, both organizations and organization units are represented by the same data.
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Organization represents a group of people identified by shared interests or purpose. Examples include business, department and enterprise. Because of the complex nature of many businesses, both organizations and organization units are represented by the same data.
Show Source
Nested Schema : contactMedium
Type: array
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "ContactMedium":"#/components/schemas/ContactMedium", "ContactMediumOracle":"#/components/schemas/ContactMediumOracle" } }
    Indicates the contact medium that could be used to contact the party.
Nested Schema : creditRating
Type: array
Show Source
Nested Schema : TimePeriod
Type: object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
Show Source
Nested Schema : externalReference
Type: array
Show Source
Nested Schema : organizationChildRelationship
Type: array
Show Source
Nested Schema : organizationIdentification
Type: array
Show Source
Nested Schema : OrganizationParentRelationship
Type: object
Parent references of an organization in a structure of organizations.
Show Source
Nested Schema : otherName
Type: array
Show Source
Nested Schema : partyCharacteristic
Type: array
Show Source
Nested Schema : relatedParty
Type: array
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "RelatedParty":"#/components/schemas/RelatedParty", "RelatedPartyOracle":"#/components/schemas/RelatedPartyOracle" } }
    Related Entity reference. A related party defines party or party role linked to a specific entity.
Nested Schema : taxExemptionCertificate
Type: array
Show Source
  • TaxExemptionCertificate
    A tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Indicates the contact medium that could be used to contact the party.
Show Source
  • When sub-classing, this defines the super-class
  • A URI to a JSON-Schema file that defines additional attributes and relationships
  • Default Value: ContactMediumOracle
    When sub-classing, this defines the sub-class entity name
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "MediumCharacteristic":"#/components/schemas/MediumCharacteristic", "MediumCharacteristicOracle":"#/components/schemas/MediumCharacteristicOracle" } }
    Describes the contact medium characteristics that could be used to contact a party (an individual or an organization)
  • Allowed Values: [ "postalAddress", "emailAddress", "socialNetwork", "phoneNumber" ]
    Type of the contact medium, such as: email address, telephone number, postal address
  • If true, indicates that is the preferred contact medium
  • TimePeriod
    A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Describes the contact medium characteristics that could be used to contact a party (an individual or an organization)
Show Source
Nested Schema : PartyCreditProfile
Type: object
An individual might be evaluated for its worthiness and this evaluation might be based on a credit rating given by a credit agency.
Show Source
Nested Schema : ExternalReference
Type: object
External reference of the individual or reference in other system
Show Source
Nested Schema : OrganizationChildRelationship
Type: object
Child references of an organization in a structure of organizations.
Show Source
Nested Schema : OrganizationRef
Type: object
Show Source
Nested Schema : OrganizationIdentification
Type: object
Represents our registration of information used as proof of identity by an organization
Show Source
Nested Schema : AttachmentRefOrValue
Type: object
An attachment by value or by reference. An attachment complements the description of an element, for example through a document, a video, a picture.
Show Source
Nested Schema : Quantity
Type: object
An amount in a given unit
Show Source
Nested Schema : OtherNameOrganization
Type: object
Keeps track of other names, for example the old name of an organization.
Show Source
Nested Schema : Characteristic
Type: object
Describes a given characteristic of an object or entity through a name/value pair.
Show Source
Nested Schema : Any
Type: object
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Related Entity reference. A related party defines party or party role linked to a specific entity.
Show Source
Nested Schema : TaxExemptionCertificate
Type: object
A tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.
Show Source
Nested Schema : taxDefinition
Type: array
Show Source
  • TaxDefinition
    Reference of a tax definition. A tax is levied by an authorized tax jurisdiction. There are many different types of tax (Federal Tax levied by the US Government, State Tax levied by the State of California,???).
Nested Schema : TaxDefinition
Type: object
Reference of a tax definition. A tax is levied by an authorized tax jurisdiction. There are many different types of tax (Federal Tax levied by the US Government, State Tax levied by the State of California,???).
Show Source
Back to Top

Response

Supported Media Types

201 Response

Notified
Body ()
Root Schema : EventSubscription
Type: object
Sets the communication endpoint address the service instance must use to deliver notification information
Show Source

400 Response

Bad Request
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source

401 Response

Unauthorized
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source

403 Response

Forbidden
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source

404 Response

Not Found
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source

405 Response

Method Not allowed
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source

409 Response

Conflict
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
Back to Top

Examples

The following example shows how to create sample listener for create organization event by submitting a POST request on the REST resource using cURL. You need to create an organization first for this action.

cURL Command

curl -H 'Authorization: Bearer <Token>' -X POST https://{FABRIC_HOST}/party/v4/listener/organizationCreateEvent -H "Content-Type: application/json" -D @create_organizationcreateevent.json | json_pp

Example of Request Body

{
  "correlationId": "FAB-7b0c6bde-4c33-4195-96a0-b57cd4e07067",
  "eventId": "OrganizationCreateEvent_2022-07-25T07:37:40.435950100Z",
  "eventTime": "2022-07-25T07:37:40.435950100Z",
  "eventType": "OrganizationCreateEvent",
  "event": {
    "organization": {
      "partyId": "300100550342781",
      "lastUpdateDate": "2022-07-25T07:37:37.226Z",
      "creationDate": "2022-07-25T07:37:34.002Z",
      "createdBy": "comms_care",
      "lastUpdatedBy": "comms_care",
      "partyNumber": "CDRM_953432",
      "type": "ZCA_PROSPECT",
      "id": "CDRM_953432",
      "href": "/party/v4/organization/CDRM_953432",
      "organizationType": "TEMP",
      "tradingName": "test7",
      "contactMedium": [
        {
          "id": "CDRM_854510",
          "lastUpdateDate": "2022-07-25T07:37:34.978Z",
          "addressId": "300100550342784",
          "mediumType": "postalAddress",
          "preferred": true,
          "characteristic": {
            "address1": "DO NOT USE THIS CUSTOMER",
            "formattedAddress": "DO NOT USE THIS CUSTOMER,123 CUSTOME6,GERMANY",
            "doNotMailFlag": false,
            "city": "CUSTOME6",
            "country": "DE",
            "postCode": "123",
            "@type": "MediumCharacteristicOracle"
          },
          "@type": "ContactMediumOracle"
        },
        {
          "id": "300100550342788",
          "lastUpdateDate": "2022-07-25T07:37:36.656Z",
          "mediumType": "phoneNumber",
          "preferred": true,
          "characteristic": {
            "formattedPhoneNumber": "+1 35314623771",
            "phoneCountryCode": "1",
            "doNotCallFlag": false,
            "contactType": "workPhoneNumber",
            "phoneNumber": "(353)(1)4623771  ",
            "@type": "MediumCharacteristicOracle"
          },
          "@type": "ContactMediumOracle"
        }
      ],
      "organizationIdentification": [
        {
          "id": "300100550342783",
          "identificationId": "ORCL_IDC_001",
          "identificationType": "UNIQUE_SUPERANNUATION_ID",
          "issuingAuthority": "Registrar of Companies, India",
          "issuingDate": "2022-05-19T12:00:00Z",
          "attachment": {
            "id": "00020000000EACED00057708000110F09AB338830000000EACED00057708000110F09AB33882",
            "href": "/documentManagement/v4/attachment/00020000000EACED00057708000110F09AB338830000000EACED00057708000110F09AB33882",
            "content": "VGhpcyBpcyB0aGUgZHJpdmVycyBsaWNlbnNlIGNvbnRlbnQu",
            "description": "Organization Id Doc file content",
            "mimeType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
            "name": "Organization_ID.docx",
            "size": {
              "amount": 48,
              "units": "bytes"
            },
            "validFor": {
              "endDateTime": "2026-05-19T03:40:14.003Z"
            }
          },
          "validFor": {
            "endDateTime": "2032-05-19T12:00:00Z"
          },
          "@baseType": "OrganizationIdentification",
          "@type": "OrganizationIdentificationOracle"
        }
      ],
      "relatedParty": [],
      "status": "initialized",
      "@type": "OrganizationOracle"
    }
  }
}

Example of Response Body

You will get a 201 Created status if your payload is successful. If there are no records, then you will get a message as follows: 

No ListenerRegistration Found for  http: //127.0.0.1:8086/01/party/v4/listener/organizationCreateEvent.
Back to Top