Update the pickup and delivery details for an existing corporate enrichment record
post
/service/v1/corporateinformation/enrichment
This API updates pickup and delivery details for an existing corporate enrichment record
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId: string
appId
-
branchCode: string
branchCode
-
userId: string
userId
Request Body that contains data required for updating an existing corporate Enrichment Data
Root Schema : ObcmTmCorpEnrchCourierDTO
Type:
object
Request DTO for Corporate Enrichment Pickup and Delivery Courier Service.
Show Source
-
corporateCode(optional):
string
Corporate Code
-
courierSrvcType(optional):
string
Courier service type used for corporate enrichmentData
-
ObcmTmCorpEnrchDeliveryDetailsDTO(optional):
array ObcmTmCorpEnrchDeliveryDetailsDTO
List of Corporate Enrichment delivery details
-
ObcmTmCorpEnrchPckupDetailsDTO(optional):
array ObcmTmCorpEnrchPckupDetailsDTO
List of Corporate Enrichment pickup details
Match All
Show Source
Nested Schema : ObcmTmCorpEnrchDeliveryDetailsDTO
Type:
array
List of Corporate Enrichment delivery details
Show Source
Nested Schema : ObcmTmCorpEnrchPckupDetailsDTO
Type:
array
List of Corporate Enrichment pickup details
Show Source
-
Array of:
object ObcmTmCorpEnrchPckupDetailsDTO
Corporate Enrichment PickUp details 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 : ObcmTmCorpEnrchDeliveryDetailsDTO
Type:
Show Source
object
-
status(optional):
string
Status Enum specifying the type of Request. ACTIVE - (CREATE/MODIFY) and DELETE
Match All
Show Source
-
object
ObcmTmCorpEnrchDlvryDetailsDTO
Corporate Enrichment Delivery Details Data
-
object
ObcmTmCorpEnrchDeliveryDetailsDTO-allOf[1]
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 : ObcmTmCorpEnrchDeliveryDetailsDTO-allOf[1]
Type:
object
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
Response
Supported Media Types
- application/json
- application/xml
200 Response
Returns message of succes or failure. If success, returns the updated data of the corporate.
Root Schema : CorpResponseDTO
Type:
object
Collection of Corporate Enrichment Courier Setup master Data.
Show Source
-
corporateEnrichmentData(optional):
object ObcmTmCorpEnrchCourierStupMstrDTO
Response DTO for Corporate Enrichment Pickup and Delivery.
-
errors(optional):
array errors
Error List for the Request Object.
-
responseCode(optional):
string
ResponseCode used for Corporate Enrichment Courier Setup master Data
Nested Schema : ObcmTmCorpEnrchCourierStupMstrDTO
Type:
object
Response DTO for Corporate Enrichment Pickup and Delivery.
Show Source
-
corporateCode(optional):
string
Corporate Code.
-
corporateName(optional):
string
Coporate Name.
-
courierSrvcType(optional):
string
Courier service type used for corporate enrichmentData
-
ObcmTmCorpEnrchDeliveryDetailsDTO(optional):
array ObcmTmCorpEnrchDeliveryDetailsDTO
List of Corporate Enrichment delivery details
-
ObcmTmCorpEnrchPickupDetailsDTO(optional):
array ObcmTmCorpEnrchPickupDetailsDTO
List of Corporate Enrichment pickup details
Match All
Show Source
Nested Schema : ObcmTmCorpEnrchDeliveryDetailsDTO
Type:
array
List of Corporate Enrichment delivery details
Show Source
Nested Schema : ObcmTmCorpEnrchPickupDetailsDTO
Type:
array
List of Corporate Enrichment pickup details
Show Source
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 : ObcmTmCorpEnrichDlvryDetailsDTO
Type:
object
Match All
Show Source
-
object
ObcmTmCorpEnrchDlvryDetailsDTO
Corporate Enrichment Delivery Details Data
-
object
ObcmTmCorpEnrichDlvryDetailsDTO-allOf[1]
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 : ObcmTmCorpEnrichDlvryDetailsDTO-allOf[1]
Type:
Show Source
object
-
errors(optional):
array errors
Error List for the Detail Object.
Nested Schema : ErrorDto
Type:
Show Source
object
-
errorCode(optional):
string
Error Code
-
errorDesc(optional):
string
Error Desc
Nested Schema : ObcmTmCorpEnrichPckupDetailsDTO
Type:
object
Match All
Show Source
-
object
ObcmTmCorpEnrchPckupDetailsDTO
Corporate Enrichment PickUp details Data
-
object
ObcmTmCorpEnrichPckupDetailsDTO-allOf[1]
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 : ObcmTmCorpEnrichPckupDetailsDTO-allOf[1]
Type:
Show Source
object
-
errors(optional):
array errors
Error List for the Detail Object.
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