Versions Compared

Old Version 8

changes.mady.by.user Marios Michael

Saved on

compared with

New Version 9

changes.mady.by.user Marios Michael

Saved on

Key

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

Available from CRM.COM R6.0.0

Table of Contents
maxLevel2

...

Name

Type

Description

token

String

The token retrieved from the login method

group_identifier

(optional)

Group Identifier

The identifier of the group that will be providing vouchers of this type. The group is filtered against the voucher types' allowed organisational units. The allowed group identifier fields are the following:

Include Page
V4:group_identifier
V4:group_identifier

unit_identifier

(optional)

Unit Identifier

The identifier of the unit that will be providing vouchers of this type. The unit is filtered against the voucher types' allowed organisational units. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_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

...

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
   "status":
   {
       "message": "",
       "description": "",
       "code": "OK"
   },
   "data":
   [
		{
            "value_option": "VARIABLE",
            "udf_float_1": null,
            "products_set":
            [
                {
                    "product_type": null,
                    "id": "C5EB02BBCE814A028E277D96D1C63D72",
                    "product":
                    {
                        "product_type":
                        {
                            "service_type": null,
                            "physical_good_type": "NONTRACEABLE",
                            "used_for_provisioning": false,
                            "classification": "PHYSICALGOODS",
                            "composition_method": "FLAT",
                            "id": "1FFC6C62DABA4C7BAA3536C24104E58A",
                            "name": "Software Product",
                            "description": null,
                            "alternative_code": "SP_1"
                        },
                        "id": "6F5CCD94E04D1CCBF8F2A090588280C9",
                        "description": "Basic: Local + Documentaries

Used for API unit testing, please do not modify.",
                        "code": "Product A",
                        "alternative_code": "P"
                    }
                },
                {
                    "product_type": null,
                    "id": "2D5A040AE4C84222B3777D92974F4872",
                    "product":
                    {
                        "product_type":
                        {
                            "service_type": null,
                            "physical_good_type": "TRACEABLE",
                            "used_for_provisioning": false,
                            "classification": "PHYSICALGOODS",
                            "composition_method": "FLAT",
                            "id": "6173FC99331504AD1ACB5D697D54DA8C",
                            "name": "Smartcards",
                            "description": "Smartcards",
                            "alternative_code": "SC"
                        },
                        "id": "EAC7A30429364176616CFEF5DF709941",
                        "description": "Smartcard 1",
                        "code": "Smartcard 1",
                        "alternative_code": "SC1"
                    }
                },
                {
                    "product_type":
                    {
                        "service_type": null,
                        "physical_good_type": "NONTRACEABLE",
                        "used_for_provisioning": false,
                        "classification": "PHYSICALGOODS",
                        "composition_method": "FLAT",
                        "id": "0F94B51F175F06A475EB2948B4030074",
                        "name": "Accessories",
                        "description": "A type which is used for accessories physical goods",
                        "alternative_code": "005"
                    },
                    "id": "9C23746C254E440E821D884606FCB743",
                    "product": null
                },
                {
                    "product_type":
                    {
                        "service_type": "TERMED",
                        "physical_good_type": null,
                        "used_for_provisioning": true,
                        "classification": "SERVICES",
                        "composition_method": "FLAT",
                        "id": "87CCEDE0A717DC5863EAA01625BD8727",
                        "name": "Add-ons",
                        "description": "Additional products",
                        "alternative_code": "AO"
                    },
                    "id": "82BD772C589348B6A2C2ED2392E11FD6",
                    "product": null
                }
            ],
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "name": "All Services - No Value",
            "udf_string_1": null,
            "udf_string_2": null,
            "secret_number_length": 7,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "default_payment_type":
            {
                "classification": "PAYMENT",
                "id": "44ABF2836545EF23A4AB30CF7A5F3784",
                "name": "Voucher Payment",
                "description": "Payments with the use of Vouchers",
                "alternative_code": "VP"
            },
            "udf_string_8": null,
            "id": "03624A0BF6FEFA560C8886B8A429D316",
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "log_information":
            {
                "updated_date": "2015-09-23T10:02:12",
                "created_date": "2014-08-25T15:03:54",
                "created_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "g_neocleous",
                    "username": "g_neocleous",
                    "id": "80D37EB91123AE12EEABA6232ADA654F",
                    "email": "g_neocleous@crm.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                }
            },
            "description": null,
            "alternative_code": "ASNV"
        },
        {
            "value_option": null,
            "udf_float_1": null,
            "products_set":
            [
            ],
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "name": "test",
            "udf_string_1": null,
            "udf_string_2": null,
            "secret_number_length": 52,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "default_payment_type": null,
            "udf_string_8": null,
            "id": "491095E1C6C9D6BF37ED798CBA7B268D",
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "log_information":
            {
                "updated_date": "2013-06-19T12:44:35",
                "created_date": "2013-06-19T12:41:50",
                "created_by_unit": null,
                "updated_by_unit": null,
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                }
            },
            "description": null,
            "alternative_code": null
        },
....
	]
}