Tip |
---|
Table of Contents | ||
---|---|---|
|
...
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:
| ||||||
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:
| ||||||
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 | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
- {
- "status":
- {
- "message": "",
- "description": "",
- "code": "OK"
- },
- "data":
- [
- {
- "value_option": "FIXED",
- "extra_added_value": 0,
- "udf_float_1": null,
- "udf_float_2": null,
- "products_set":
- [
- {
- "product_type": null,
- "id": "C064C8437E8C46A3B806026BA6839966",
- "product":
- {
- "product_type":
- {
- "service_type": "TERMED",
- "physical_good_type": null,
- "used_for_provisioning": true,
- "classification": "SERVICES",
- "composition_method": "FLAT",
- "id": "600438B64B0F05AB3D020C902674949F",
- "name": "Subscription services",
- "description": "Subscription services",
- "alternative_code": "SS"
- },
- "id": "5B3841D63F6CAE5973366EEAFF3444E3",
- "description": "Movies 1",
- "code": "Movies 1",
- "alternative_code": "M1"
- }
- }
- ],
- "udf_float_3": null,
- "udf_float_4": null,
- "name": "Movies 1 - 9",
- "udf_string_1": null,
- "udf_string_2": null,
- "secret_number_length": 5,
- "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": "8AD426C90CB540DFA3F5C5EBB147CE34",
- "udf_date_1": null,
- "udf_date_2": null,
- "udf_date_3": null,
- "udf_date_4": null,
- "log_information":
- {
- "updated_date": "2015-02-18T09:41:40",
- "created_date": "2015-02-18T09:40:55",
- "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": "p_xenopoulou",
- "username": "p_xenopoulou",
- "id": "159C17D9C4B1E48DC129FBC701D38438",
- "email": "p_xenopoulou@crm.com"
- },
- "updated_by_user":
- {
- "person_name": "p_xenopoulou",
- "username": "p_xenopoulou",
- "id": "159C17D9C4B1E48DC129FBC701D38438",
- "email": "p_xenopoulou@crm.com"
- }
- },
- "value": 9,
- "description": "Movies 1 - 3 day voucher 9 euro",
- "alternative_code": "M1-9"
- },
- {
- "value_option": "FIXED",
- "extra_added_value": 0,
- "udf_float_1": null,
- "udf_float_2": null,
- "products_set":
- [
- {
- "product_type": null,
- "id": "1BCE8F96FCA84E49BD323FA3F843BF26",
- "product":
- {
- "product_type":
- {
- "service_type": "TERMED",
- "physical_good_type": null,
- "used_for_provisioning": true,
- "classification": "SERVICES",
- "composition_method": "FLAT",
- "id": "600438B64B0F05AB3D020C902674949F",
- "name": "Subscription services",
- "description": "Subscription services",
- "alternative_code": "SS"
- },
- "id": "CA3ACA47666F6CB6EECB3C15D1F0221A",
- "description": "Cartoons 1",
- "code": "Cartoons 1 ",
- "alternative_code": "C1"
- }
- }
- ],
- "udf_float_3": null,
- "udf_float_4": null,
- "name": "Cartoons 1 - 6",
- "udf_string_1": null,
- "udf_string_2": null,
- "secret_number_length": 5,
- "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": "9256B69E59DF44DDA8661DF9623AA008",
- "udf_date_1": null,
- "udf_date_2": null,
- "udf_date_3": null,
- "udf_date_4": null,
- "log_information":
- {
- "updated_date": "2015-02-18T09:44:31",
- "created_date": "2015-02-18T09:41:41",
- "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": "p_xenopoulou",
- "username": "p_xenopoulou",
- "id": "159C17D9C4B1E48DC129FBC701D38438",
- "email": "p_xenopoulou@crm.com"
- },
- "updated_by_user":
- {
- "person_name": "p_xenopoulou",
- "username": "p_xenopoulou",
- "id": "159C17D9C4B1E48DC129FBC701D38438",
- "email": "p_xenopoulou@crm.com"
- }
- },
- "value": 6,
- "description": "Cartoons 1 - 3 day voucher",
- "alternative_code": "C1-6"
- },
- {
- "value_option": "FIXED",
- "extra_added_value": 0,
- "udf_float_1": null,
- "udf_float_2": null,
- "products_set":
- [
- {
- "product_type": null,
- "id": "BB9DBE201BCD4DD0BB3C08BBD3115E18",
- "product":
- {
- "product_type":
- {
- "service_type": "TERMED",
- "physical_good_type": null,
- "used_for_provisioning": true,
- "classification": "SERVICES",
- "composition_method": "FLAT",
- "id": "600438B64B0F05AB3D020C902674949F",
- "name": "Subscription services",
- "description": "Subscription services",
- "alternative_code": "SS"
- },
- "id": "EBAC84F9A0086191BD58B624D236D61D",
- "description": "Sports 1 1",
- "code": "Sports 1",
- "alternative_code": "S1"
- }
- },
- {
- "product_type": null,
- "id": "F09628EB174946E09B8D6D3FABE55C85",
- "product":
- {
- "product_type":
- {
- "service_type": "TERMED",
- "physical_good_type": null,
- "used_for_provisioning": true,
- "classification": "SERVICES",
- "composition_method": "FLAT",
- "id": "600438B64B0F05AB3D020C902674949F",
- "name": "Subscription services",
- "description": "Subscription services",
- "alternative_code": "SS"
- },
- "id": "CA3ACA47666F6CB6EECB3C15D1F0221A",
- "description": "Cartoons 1",
- "code": "Cartoons 1 ",
- "alternative_code": "C1"
- }
- },
- {
- "product_type": null,
- "id": "CA7C582F9A234174A0A4B0580811514A",
- "product":
- {
- "product_type":
- {
- "service_type": "TERMED",
- "physical_good_type": null,
- "used_for_provisioning": true,
- "classification": "SERVICES",
- "composition_method": "FLAT",
- "id": "600438B64B0F05AB3D020C902674949F",
- "name": "Subscription services",
- "description": "Subscription services",
- "alternative_code": "SS"
- },
- "id": "90578F46460B7C4530BE801CFE5CB9A1",
- "description": "Movies 2",
- "code": "Movies 2",
- "alternative_code": "m2"
- }
- },
- {
- "product_type": null,
- "id": "41EB88E76F9B408CAD36AF8673A24F20",
- "product":
- {
- "product_type":
- {
- "service_type": "TERMED",
- "physical_good_type": null,
- "used_for_provisioning": true,
- "classification": "SERVICES",
- "composition_method": "FLAT",
- "id": "600438B64B0F05AB3D020C902674949F",
- "name": "Subscription services",
- "description": "Subscription services",
- "alternative_code": "SS"
- },
- "id": "4D55A6EC2FF25A44B9945B88940AF1A0",
- "description": "Sports 2",
- "code": "Sports 2",
- "alternative_code": "S2"
- }
- },
- {
- "product_type": null,
- "id": "8FED1549134C4E0CB1C4B5C24408715C",
- "product":
- {
- "product_type":
- {
- "service_type": "TERMED",
- "physical_good_type": null,
- "used_for_provisioning": true,
- "classification": "SERVICES",
- "composition_method": "FLAT",
- "id": "600438B64B0F05AB3D020C902674949F",
- "name": "Subscription services",
- "description": "Subscription services",
- "alternative_code": "SS"
- },
- "id": "E3600383FF2650A594594F10BEB358D5",
- "description": "Cartoons 2",
- "code": "Cartoons 2",
- "alternative_code": "C2"
- }
- },
- {
- "product_type": null,
- "id": "61FB1C4767F54B02905A48CAF6E35D00",
- "product":
- {
- "product_type":
- {
- "service_type": "TERMED",
- "physical_good_type": null,
- "used_for_provisioning": true,
- "classification": "SERVICES",
- "composition_method": "FLAT",
- "id": "600438B64B0F05AB3D020C902674949F",
- "name": "Subscription services",
- "description": "Subscription services",
- "alternative_code": "SS"
- },
- "id": "5B3841D63F6CAE5973366EEAFF3444E3",
- "description": "Movies 1",
- "code": "Movies 1",
- "alternative_code": "M1"
- }
- }
- ],
- "udf_float_3": null,
- "udf_float_4": null,
- "name": "Subscription Services - 5",
- "udf_string_1": null,
- "udf_string_2": null,
- "secret_number_length": 5,
- "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": "A7B2ED47B3AC4DB7B63ACF491F337B04",
- "udf_date_1": null,
- "udf_date_2": null,
- "udf_date_3": null,
- "udf_date_4": null,
- "log_information":
- {
- "updated_date": "2015-02-18T09:43:31",
- "created_date": "2015-02-18T09:42:19",
- "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": "p_xenopoulou",
- "username": "p_xenopoulou",
- "id": "159C17D9C4B1E48DC129FBC701D38438",
- "email": "p_xenopoulou@crm.com"
- },
- "updated_by_user":
- {
- "person_name": "p_xenopoulou",
- "username": "p_xenopoulou",
- "id": "159C17D9C4B1E48DC129FBC701D38438",
- "email": "p_xenopoulou@crm.com"
- }
- },
- "value": 5,
- "description": "Subscription Services voucher - 5 euro",
- "alternative_code": "SS-5"
- },