Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Antonis Papageorgiou

Saved on

Key

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

...

...

...

...

...


Excerpt

This method returns a voucher's secret number. The secret number of a single voucher is returned by each call

Tip

Available from CRM.COM R5.0.0

Resource URL

http://host_name/crmapi/rest/$version/vouchers/retrieve_secret_number

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

voucher_identifier

(mandatory)

Voucher identifier

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

Include Page
V4:voucher_identifier
V4:voucher_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.

Response Data

Name

Type

Description

id

String

The ID of the retrieved voucher

secret_number

String

The secret_number of the retrieved voucher

Examples

Expand
titleExample 1

HTTP Method: GET


Request:

 Request:http://localhost:9080/crmapi/rest/v2/vouchers/retrieve_secret_number?token=&voucher_identifier=number=1211

Response:

Code Block
languagejs
themeConfluencelanguagejs
linenumberstrue
{
	"status":
	{
		"message": null,
		"description": null,
		"code": "OK"
	},
	"data":
	{
		"secret_number": "0977835",
		"id": "87DB0829834D1AC4B38B64616BF8855D"
	}
}


...