References API

List references by type code

GET /rest/v1/references?ref_type_code=:ref_type_code&per_page=1&page=1

This method lists references of specified type code

Request

Headers

Accept: application/json
Content-Type: application/json

Route

GET /rest/v1/references?ref_type_code=REF_TYPE_Document_Type&per_page=1&page=1

Query Parameters

ref_type_code: REF_TYPE_Document_Type
per_page: 1
page: 1

Response

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 612

Status

200 OK

Body

{"references":[{"n_ref_id":1002,"n_par_ref_id":null,"n_ref_type_id":2,"n_ref_base_id":null,"n_firm_id":null,"vc_name":"\u0414\u043e\u0433\u043e\u0432\u043e\u0440 \u043d\u0430 \u043e\u043a\u0430\u0437\u0430\u043d\u0438\u0435 \u0443\u0441\u043b\u0443\u0433","vc_code":"DOC_TYPE_SubscriberContract","vc_value":null,"vc_value_2":null,"vc_value_3":null,"c_value":null,"c_value_2":null,"c_value_3":null,"d_value":null,"d_value_2":null,"d_value_3":null,"n_value":null,"n_value_2":null,"n_value_3":null,"c_fl_editable":"N","c_fl_manual":"N","n_lang_id":1131}],"actions":{"index":"http://example.org/rest/v1/references"}}