Fetch the corporate enrichment data
get
/service/v1/corporateinformation/enrichment
This API fetches the corporate enrichment data based on given parameters.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
adHoc(optional): string
delivery type for adhoc
-
corporateCode(optional): string
filter by corporate code/id
-
dayOfWeek(optional): string
day of week for pickup or delivery
-
filterType(optional): string
filter type for pickup, delivery or both
-
frequency(optional): string
frequency for pickup or delivery
-
levelOfEnrichment(optional): string
Level of Enrichment
-
pkpDlvryFor(optional): string
pickup or delivery for cheque, cash or both
-
pkpDlvryHldy(optional): string
pickup or delivery on holiday (Y or N)
-
pkpDlvryLocation(optional): string
location for pickup or delivery
-
pkpDlvryPoint(optional): string
pickup or delivery point code to filter
-
productCategory(optional): string
Product Category
-
productCode(optional): string
Product Code
-
timeSlot(optional): string
time slot for pickup or delivery
Header Parameters
-
appId: string
appId
-
branchCode: string
branchCode
-
userId: string
userId
Response
Supported Media Types
- application/json
- application/xml
200 Response
Returns message of succes or failure. If success, returns the enrichment data of the corporate.
Root Schema : ObcmTmCorpEnrchStupMstrWrapperDTO
Type:
object
Collection of Corporate Enrichment Setup master Data.
Show Source
-
corporateEnrichmentData(optional):
object ObcmTmCorpEnrchStupMstrDTO
-
errors(optional):
array errors
Error List Corporate Enrichment Setup master Data
-
responseCode(optional):
string
ResponseCode used for Corporate Enrichment Setup master Data
Nested Schema : GenericDto
Match All
Show Source
-
object
GenericDto-allOf[0]
Discriminator:
resource_type
Nested Schema : GenericDto-allOf[0]
Type:
object
Discriminator:
resource_type
Nested Schema : ObcmTmCorpEnrchStupMstrDTO-allOf[1]
Type:
Show Source
object
-
corporateCode(optional):
string
Corporate code used for corporate enrichmentData
-
corporateName(optional):
string
Corporate name used for corporate enrichmentData
-
counterPartyInfoManTxn(optional):
string
Counter party information used for corporate enrichmentData
-
courierSrvcType(optional):
string
Courier service type used for corporate enrichmentData
-
drawerInfoManTxn(optional):
string
Dwawer information used for corporate enrichmentData
-
ObcmTmCorpEnrchDlvryDetailsDTO(optional):
array ObcmTmCorpEnrchDlvryDetailsDTO
List of Corporate Enrichment delivery details
-
ObcmTmCorpEnrchInfoProdMasterDTO(optional):
array ObcmTmCorpEnrchInfoProdMasterDTO
List of Corporate Enrichment Information Product Master
-
ObcmTmCorpEnrchPckupDetailsDTO(optional):
array ObcmTmCorpEnrchPckupDetailsDTO
List of Corporate Enrichment pickup details
-
ObcmTmCorpEnrchPoolStupDetailsDTO(optional):
array ObcmTmCorpEnrchPoolStupDetailsDTO
List of Corporate Enrichment pool setup details
-
ObcmTmCorpEnrchProdEnrchDetailsDTO(optional):
array ObcmTmCorpEnrchProdEnrchDetailsDTO
List of Corporate Enrichment product details
Nested Schema : ObcmTmCorpEnrchDlvryDetailsDTO
Type:
array
List of Corporate Enrichment delivery details
Show Source
-
Array of:
object ObcmTmCorpEnrchDlvryDetailsDTO
Corporate Enrichment Delivery Details Data
Nested Schema : ObcmTmCorpEnrchInfoProdMasterDTO
Type:
array
List of Corporate Enrichment Information Product Master
Show Source
-
Array of:
object ObcmTmCorpEnrchInfoProdMasterDTO
Corporate Enrichment Information Product Master Data
Nested Schema : ObcmTmCorpEnrchPckupDetailsDTO
Type:
array
List of Corporate Enrichment pickup details
Show Source
-
Array of:
object ObcmTmCorpEnrchPckupDetailsDTO
Corporate Enrichment PickUp details Data
Nested Schema : ObcmTmCorpEnrchPoolStupDetailsDTO
Type:
array
List of Corporate Enrichment pool setup details
Show Source
-
Array of:
object ObcmTmCorpEnrchPoolStupDetailsDTO
Corporate Enrichment Pool Setup Details Data
Nested Schema : ObcmTmCorpEnrchProdEnrchDetailsDTO
Type:
array
List of Corporate Enrichment product details
Show Source
-
Array of:
object ObcmTmCorpEnrchProdEnrchDetailsDTO
Corporate Enrichment Information Product Details
Nested Schema : ObcmTmCorpEnrchDlvryDetailsDTO
Type:
object
Corporate Enrichment Delivery Details Data
Show Source
-
addln1(optional):
string
Address Line 1 used for corporate enrichment delivery details data
-
addln2(optional):
string
Address Line 2 used for corporate enrichment delivery details data
-
addln3(optional):
string
Address Line 3 used for corporate enrichment delivery details data
-
addln4(optional):
string
Address Line 4 used for corporate enrichment delivery details data
-
agrmntDate(optional):
string
Arragment used for corporate enrichment delivery details data
-
cntctPerson(optional):
string
Contact Person used for corporate enrichment delivery details data
-
cntryCode(optional):
string
Country Code used for corporate enrichment delivery details data
-
cntryName(optional):
string
Country name used for corporate enrichment delivery details data
-
courierCode(optional):
string
CourierCode used for corporate enrichment delivery details data
-
courierCodeDesc(optional):
string
CourierCodeDesc used for corporate enrichment delivery details data
-
dayOfWeek(optional):
string
DayOfWeek used for corporate enrichment delivery details data
-
dlvryCode(optional):
string
Delivery Code used for corporate enrichment delivery details data
-
dlvryDesc(optional):
string
Delivery Desc used for corporate enrichment delivery details data
-
dlvryOnHldys(optional):
string
DeliveryOnHldys used for corporate enrichment delivery details data
-
dlvrySlot(optional):
string
Delivery Slot used for corporate enrichment delivery details data
-
dlvryType(optional):
string
Delivery Type used for corporate enrichment delivery details data
-
fax(optional):
number
Faxx number used for corporate enrichment delivery details data
-
freq(optional):
string
Frequency used for corporate enrichment delivery details data
-
locationCode(optional):
string
LocationCode used for corporate enrichment delivery details data
-
locationDesc(optional):
string
LocationDesc used for corporate enrichment delivery details data
-
postalCode(optional):
number
PostalCode used for corporate enrichment delivery details data
-
prEmailId(optional):
string
Pre EmailId used for corporate enrichment delivery details data
-
prPhoneNo(optional):
number
Pre PhoneNo used for corporate enrichment delivery details data
-
scEmailId(optional):
string
Source EmailId used for corporate enrichment delivery details data
-
scPhoneNo(optional):
number
Source PhoneNo used for corporate enrichment delivery details data
Nested Schema : ObcmTmCorpEnrchInfoProdMasterDTO
Type:
object
Corporate Enrichment Information Product Master Data
Show Source
-
productCategory(optional):
string
Product category used for corporate enrichment information Product Details
-
productCode(optional):
string
Product code used for corporate enrichment information product master data
-
productDesc(optional):
string
Product description used for corporate enrichment information product master data
-
status(optional):
string
Status used for SUCCESS/FAILURE response
Nested Schema : ObcmTmCorpEnrchPckupDetailsDTO
Type:
object
Corporate Enrichment PickUp details Data
Show Source
-
addln1(optional):
string
Address line 1 used corporate enrichment pickUp details response
-
addln2(optional):
string
Address line 2 used corporate enrichment pickUp details response
-
addln3(optional):
string
Address line 3 used corporate enrichment pickUp details response
-
addln4(optional):
string
Address line 4 used corporate enrichment pickUp details response
-
agrmntDate(optional):
string
Arragment date used corporate enrichment pickUp details response
-
chqRtnAddln1(optional):
string
Cheque return Address line 1 used corporate enrichment pickUp details
-
chqRtnAddln2(optional):
string
Cheque return Address line 2 used corporate enrichment pickUp details
-
chqRtnAddln3(optional):
string
Cheque return Address line 3 used corporate enrichment pickUp details
-
chqRtnAddln4(optional):
string
Cheque return Address line 4 used corporate enrichment pickUp details
-
cntctPerson(optional):
string
Contact person used corporate enrichment pickUp details
-
cntryCode(optional):
string
Country code used corporate enrichment pickUp details response
-
cntryName(optional):
string
Country name used corporate enrichment pickUp details response
-
courierCode(optional):
string
Courier Code used corporate enrichment pickUp details response
-
courierCodeDesc(optional):
string
CourierCode Description used corporate enrichment pickUp details response
-
dayOfWeek(optional):
string
DayOfWeek used corporate enrichment pickUp details response
-
fax(optional):
number
Fax number used corporate enrichment pickUp details response
-
freq(optional):
string
Frequency used corporate enrichment pickUp details response
-
locationCode(optional):
string
LocationCode used corporate enrichment pickUp details response
-
locationDesc(optional):
string
LocationDesc used corporate enrichment pickUp details response
-
pickupCode(optional):
string
PickupCode used corporate enrichment pickUp details response
-
pickupFor(optional):
string
PickupFor used corporate enrichment pickUp details response
-
pickupOnHldys(optional):
string
PickupOnHldys used corporate enrichment pickUp details response
-
pickupPt(optional):
string
Pickup point used corporate enrichment pickUp details response
-
pickupSlot(optional):
string
PickupSlot used corporate enrichment pickUp details
-
pickupType(optional):
string
PickupType used corporate enrichment pickUp details
-
postalCode(optional):
number
PostalCode used corporate enrichment pickUp details
-
prEmailId(optional):
string
Pre EmailId used corporate enrichment pickUp details
-
prPhoneNo(optional):
number
Pre PhoneNo used corporate enrichment pickUp details
-
retrnDispatch(optional):
string
Return Dispatch used corporate enrichment pickUp details
-
scEmailId(optional):
string
Source EmailId used corporate enrichment pickUp details
-
scPhoneNo(optional):
number
Source PhoneNo used corporate enrichment pickUp details
Nested Schema : ObcmTmCorpEnrchPoolStupDetailsDTO
Type:
object
Corporate Enrichment Pool Setup Details Data
Show Source
-
cdtConsolidationLvl(optional):
string
Credit Consolidation Level 1 used for corporate enrichment pool setup details
-
divCode(optional):
string
Division Code used for corporate enrichment pool setup details
-
divDesc(optional):
string
Division description used for corporate enrichment pool setup details
-
locCode(optional):
string
Location code used for corporate enrichment pool setup details
-
locDesc(optional):
string
Location description used for corporate enrichment pool setup details
-
percentage(optional):
number
Percentage used for corporate enrichment pool setup details
-
percentagePooling(optional):
string
Percentage pooling used for corporate enrichment pool setup details
-
pooAccDesc(optional):
string
Pooling account description used for corporate enrichment pool setup details
-
pooAccNo(optional):
string
Pooling account number used for corporate enrichment pool setup details
-
poolingLvl(optional):
string
Pooling level used for corporate enrichment pool setup details
-
prodCategory(optional):
string
Product Category used for corporate enrichment pool setup details
Nested Schema : ObcmTmCorpEnrchProdEnrchDetailsDTO
Type:
object
Corporate Enrichment Information Product Details
Show Source
-
dataType(optional):
string
Data Type used for corporate enrichment information Product Details
-
enrchLabel(optional):
string
Enrich Label used for corporate enrichment information Product Details
-
fieldLength(optional):
string
Field length used for corporate enrichment information Product Details
-
lvlOfEnrch(optional):
string
Level of enrichment used for corporate enrichment information Product Details
-
minValue(optional):
integer
Minimum Of value used for used for corporate enrichment information Product Details
-
orderingNo(optional):
integer
Product's ordering number
-
productCategory(optional):
string
Product category used for corporate enrichment information Product Details
-
productCode(optional):
string
Product code used for corporate enrichment information Product Details
-
productDesc(optional):
string
Product description used for corporate enrichment information Product Details
-
validations(optional):
string
Validations used for corporate enrichment information Product Details
Nested Schema : ErrorDto
Type:
Show Source
object
-
errorCode(optional):
string
Error Code
-
errorDesc(optional):
string
Error Desc
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
405 Response
Invalid input
500 Response
Internal error