Versions Compared

Old Version 3

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user p_demou

Saved on

Key

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

...

...

...

...

...

...


Excerpt

This method returns information related with a notification. A single notification is returned by each call


Tip

Deprecated from R17.0.0

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

notifications_identifier

(semi-optional)

Notification identifier

The identifier of the notification that should be returned as a result. The allowed notification identifier fields are the following:

Include Page
V4:notification_identifier
V4:notification_identifier

communication_identifier

(semi-optional)

Communication identifier

The identifier of the communication that was created for the notification that should be returned as a result. The allowed communication identifier fields are the following:

Include Page
V4:communication_identifier
V4:communication_identifier

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

...

Expand
titleExample 1

HTTP Method: GET 


Request:

Response:

Code Block
language
languagejs
themeConfluence
jslinenumberstrue
{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "udf_float_1": null,
        "udf_float_2": null,
        "udf_float_3": null,
        "number": "51",
        "udf_float_4": null,
        "udf_string_1": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "contact_information":
        {
            "last_name": "Litt",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "company_profile": null,
            "title": "Mr",
            "type": "PERSON",
            "first_name": "Mathew",
            "name": "Mathew Litt",
            "id": "921C66776CBFEC5D839CA0DBFA1A1B76",
            "company_name": null,
            "demographics":
            {
                "gender": "MALE",
                "passport_issued_by_country": null,
                "passport_number": "111",
                "social_security_number": "111",
                "country_of_residence":
                {
                    "name": "JAPAN",
                    "id": "237"
                },
                "industry_sector": null,
                "date_of_birth":
                {
                    "month": null,
                    "day": null,
                    "year": null
                },
                "name_day":
                {
                    "month": null,
                    "day": null
                },
                "id_number": "111",
                "id_issued_by_country": null,
                "industry": null
            }
        },
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "accounts_receivable":
        {
            "account_owner":
            {
                "last_name": "Litt",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "company_profile": null,
                "title": "Mr",
                "type": "PERSON",
                "first_name": "Mathew",
                "name": "Mathew Litt",
                "id": "921C66776CBFEC5D839CA0DBFA1A1B76",
                "company_name": null,
                "demographics":
                {
                    "gender": "MALE",
                    "passport_issued_by_country": null,
                    "passport_number": "111",
                    "social_security_number": "111",
                    "country_of_residence":
                    {
                        "name": "JAPAN",
                        "id": "237"
                    },
                    "industry_sector": null,
                    "date_of_birth":
                    {
                        "month": null,
                        "day": null,
                        "year": null
                    },
                    "name_day":
                    {
                        "month": null,
                        "day": null
                    },
                    "id_number": "111",
                    "id_issued_by_country": null,
                    "industry": null
                }
            },
            "life_cycle_state": "ACTIVE",
            "number": "165",
            "name": "Mathew Litt",
            "id": "63755A788E078C16D506AD5CD1AB3E03"
        },
        "id": "49B37FA3E001C43F28CFEAFEB3E451D5",
        "items_set":
        [
            {
                "estimated_consumption_date": null,
                "entity_value": "102410D8E524A59109A440C3027E4595",
                "unsettled_amount": 69.74,
                "entity_name": "BILLS",
                "id": "F0F7D7E12DB7783323640ACF69AB51D7",
                "outstanding_amount": 69.74,
                "estimated_consumption_days": null,
                "notified_amount": 133.73999999999998
            }
        ],
        "total_notified_amount": 133.73999999999998,
        "udf_date_1": null,
        "communication_queue":
        {
            "external_system": null,
            "life_cycle_state": "COMPLETED",
            "communication":
            {
                "life_cycle_state": "COMPLETED",
                "number": "110",
                "id": "764AF4FCC072E1C6A2AD3A40E08A05C0",
                "contact_information":
                {
                    "last_name": "Litt",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": "Mr",
                    "type": "PERSON",
                    "first_name": "Mathew",
                    "name": null,
                    "id": "921C66776CBFEC5D839CA0DBFA1A1B76",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "MALE",
                        "passport_issued_by_country": null,
                        "passport_number": "111",
                        "social_security_number": "111",
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": "111",
                        "id_issued_by_country": null,
                        "industry": null
                    }
                }
            },
            "number": "37",
            "id": "9FAF189919D671E1AF50CE20890F53CD"
        },
        "udf_date_2": null,
        "udf_date_3": null,
        "udf_date_4": null,
        "log_information":
        {
            "updated_date": "2014-10-10T17:56:43",
            "created_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_date": "2014-10-10T17:56:43",
            "updated_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "mp@ministrator.com"
            },
            "updated_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "mp@ministrator.com"
            }
        },
        "life_cycle_state": "COMPLETED",
        "unsettled_amount": 69.74,
        "notification_run":
        {
            "end_date": "2014-10-10T17:56:44",
            "life_cycle_state": "COMPLETED",
            "number": "222",
            "start_date": "2014-10-10T17:56:30",
            "id": "96361A44AC30FDFE38A6D1A58C2A1821"
        },
        "total_outstanding_amount": 69.74,
        "type":
        {
            "classification": "FINANCIAL",
            "name": "Notification Bill",
            "id": "C52A0BFC52ED720CC4EA34B8E599CE1A",
            "description": null,
            "alternative_code": "NB"
        }
    }
}


...

Expand
titleExample 2

HTTP Method: GET

 


Request:

Response:

Code Block
languagejs
themeConfluencelanguagejs
linenumberstrue
{
  "data": {
    "log_information": {
      "created_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "updated_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "created_date": "2016-02-12T17:03:38",
      "updated_date": "2016-02-12T17:03:38",
      "updated_by_user": {
        "person_name": "MPAdministrator",
        "id": "1",
        "email": "dev@crm.com",
        "username": "MPAdministrator"
      },
      "created_by_user": {
        "person_name": "MPAdministrator",
        "id": "1",
        "email": "dev@crm.com",
        "username": "MPAdministrator"
      }
    },
    "contact_information": {
      "company_profile": null,
      "company_name": null,
      "name": "Mary Keller",
      "last_name": "Keller",
      "id": "64F72AE24DF644E6A9C2C21A3E397B67",
      "life_cycle_state": "FINANCIAL",
      "middle_name": null,
      "title": "346346",
      "type": "PERSON",
      "first_name": "Mary",
      "demographics": {
        "name_day": {
          "month": null,
          "day": null
        },
        "id_number": "252365221",
        "gender": null,
        "country_of_residence": {
          "alternative_code": "IRN",
          "three_character_code": null,
          "name": "IRAN (ISLAMIC REPUBLIC OF)",
          "id": "231",
          "two_character_code": null
        },
        "date_of_birth": {
          "month": null,
          "year": null,
          "day": null
        },
        "industry_sector": null,
        "passport_number": null,
        "industry": null,
        "social_security_number": null,
        "id_issued_by_country": null,
        "passport_issued_by_country": null
      }
    },
    "currency_rate_period": {
      "from_date": "C7D7ED57F21B47028144967E015DCBE5",
      "to_date": 2.3,
      "rate": 2.3,
      "inverse_rate": 0.23000000417232513,
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "£",
        "decimal_part_name": null,
        "code": "GBP",
        "integer_part_name": null,
        "id": "9"
      },
      "id": "C7D7ED57F21B47028144967E015DCBE5"
    },
    "udf_date_2": null,
    "type": {
      "alternative_code": "WWDA",
      "name": "Wallet with debited amount",
      "description": null,
      "id": "928A6098889A416391F61D418D041B72",
      "classification": "FINANCIAL"
    },
    "udf_date_1": null,
    "udf_date_4": null,
    "udf_date_3": null,
    "number": "20",
    "udf_float_3": null,
    "udf_float_4": null,
    "total_outstanding_amount": 0,
    "items_set": [
      {
        "entity_value": "E9BB0852A05C486B8CEB61C2343CBB22",
        "estimated_consumption_days": 0,
        "notified_amount": -85,
        "entity_name": "WALLETS",
        "unsettled_amount": 0,
        "estimated_consumption_date": "2016-02-10T15:38:22",
        "id": "E41568E2D1564ABA94873AE6DF37744B",
        "outstanding_amount": 0
      }
    ],
    "id": "80734C507CF6486A96F6FBD2594D38B5",
    "udf_float_1": null,
    "communication_queue": {
      "number": "36",
      "id": "5341CA35CDB74A9B96D1B98CAE3102C7",
      "life_cycle_state": "COMPLETED",
      "communication": {
        "number": "43",
        "subject": "Your wallet is below zero",
        "contact_information": {
          "company_profile": null,
          "company_name": null,
          "name": null,
          "last_name": "Keller",
          "id": "64F72AE24DF644E6A9C2C21A3E397B67",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "title": "346346",
          "type": "PERSON",
          "first_name": "Mary",
          "demographics": {
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": "252365221",
            "gender": null,
            "date_of_birth": {
              "month": null,
              "year": null,
              "day": null
            },
            "industry_sector": null,
            "passport_number": null,
            "industry": null,
            "social_security_number": null,
            "id_issued_by_country": null,
            "passport_issued_by_country": null
          }
        },
        "id": "E8255CFFE2B941CA8EA5ABA273C68FC4",
        "life_cycle_state": "COMPLETED"
      },
      "external_system": null
    },
    "udf_float_2": null,
    "udf_string_2": null,
    "udf_string_3": null,
    "udf_string_4": null,
    "udf_string_5": null,
    "notification_run": {
      "end_date": "2016-02-12T17:03:38",
      "number": "42",
      "id": "1F873834E3CF4F8EA1AD516DFB6F38A8",
      "life_cycle_state": "COMPLETED",
      "start_date": "2016-02-12T17:03:35"
    },
    "udf_string_1": null,
    "total_notified_amount": -85,
    "accounts_receivable": {
      "number": "ACR0000000020",
      "name": "ACR0000000020 Mary Keller",
      "id": "7BE0FFF150C5438BA48F3153E9EF75D7",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": "Mary Keller",
        "last_name": "Keller",
        "id": "64F72AE24DF644E6A9C2C21A3E397B67",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": "346346",
        "type": "PERSON",
        "first_name": "Mary",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": "252365221",
          "gender": null,
          "country_of_residence": {
            "alternative_code": "IRN",
            "three_character_code": null,
            "name": "IRAN (ISLAMIC REPUBLIC OF)",
            "id": "231",
            "two_character_code": null
          },
          "date_of_birth": {
            "month": null,
            "year": null,
            "day": null
          },
          "industry_sector": null,
          "passport_number": null,
          "industry": null,
          "social_security_number": null,
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      }
    },
    "life_cycle_state": "COMPLETED",
    "unsettled_amount": 0,
    "udf_string_6": null,
    "udf_string_7": null,
    "udf_string_8": null
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}


...