Get BP Record

GET /ws/rest/service/v1/bp/record/{project_number}

Purpose

Get a record in of a specific BP in a shell based on shell number or from Company level if project/shell number is not provided.

The input JSON shall provide various options to be considered for fetching the data

Input

All parameters should be URL encoded.

Path Parameter

project_num: Specify the Project number in which the records exists; if not provided, then records are considered to be fetched from Company Level.

GET URL Parameter

input =

{

"bpname" : "Vendors",

"record_no" : "VEN-0023",

"lineitem":"yes"

}

Here "record_no" and "bpname" are mandatory input parameter.

The "lineitem" is by default "yes", if not provided.

Output

JSON object containing 'status', 'data', 'message'

message will be present if status is not 200; otherwise, it will be "success".

Note: If Integration interface is defined for that BP. All fields defined in this interface will be sent in the response.

If Integration interface is not defined, then all Custom defined Fields will be sent in response.

Get BP Sample Response

{

"data":

[

{

"uuu_user_id":"a@abc.com",

"uuu_record_last_update_date":"2018/04/23 11:06",

"uveFaxTB16":null,

"uveCertificateNoTB64":null,

"uvePrimaryContactTB64":"a",

"title":"v-00101",

"uveLicenseNoTB16":null,

"uuu_contact_company":"v-00101",

"uveCOIAmoutCA":0.0,

"_bp_lineitems":

[

{

"uirCntctFstNmTB":"a",

"uuu_user_workphone":null,

"uuu_tab_id":"List of Contacts",

"title":"t",

"ugenAddress1TXT120":null,

"ugenAddress2TXT120":null,

"ugenCountryPD":null,

"ugenCityTXT50":null,

"short_desc":"Vendor Contact",

"li_num":1,

"uriCntctLstNmTB":"b",

"ugenStatePD":null,

"ugenZipCodeTXT16":null,

"uveEmailTB120":null,

"ugenAddress3TXT120":null

}

],

"uvePolicyNoTB32":null,

"record_no":"VEN-0023",

"uveVendorTypePD":"Architect",

"ugenCityTXT50":null,

"uveCoiExpDOP":null,

"uuu_dm_publish_path":"v_path",

"uuu_contact_last_name":"b",

"ugenZipCodeTXT16":null,

"uveEmailTB120":"a@abc.com",

"ugenAddress3TXT120":null,

"uveReferenceIdTB16":null,

"uuu_creation_date":"2018/04/12 09:01",

"ugenRemarksTB4000":null,

"uvePhoneTB64":null,

"uveTaxIDTB16":null,

"uveMinorityBusCB":0,

"uveInsuranceCoTB32":null,

"ugenExpirationDateDOP":null,

"uveWomanOwnedCB":0,

"uveVendorNameTB50":"v-00101",

"ugenAddress1TXT120":null,

"uveDisadvantagedBusCB":0,

"ugenDiscipline":null,

"creator_id":"Company Administrator",

"ugenAddress2TXT120":null,

"ugenCountryPD":null,

"uveVendorIDTB16":"v-00101",

"ugenStatePD":null,

"uuu_contact_first_name":"a",

"status":"Active"

}

],

"message":

[ "success"

],

"status":200

}

The following funding information for general spends, payment application, or generic cost BPs will be present in the response:

unassigned_amount
fund (JSON array containing below)
- code
- fund_balance
- assigned_amount

Purpose

Input

Output

Get BP Sample Response

Related Topics