Jump to

• Request
• Response

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

Body ()

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

{
    "type":"object",
    "description":"Request DTO for Corporate Enrichment Pickup and Delivery Courier Service.",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        }
    ],
    "properties":{
        "corporateCode":{
            "type":"string",
            "description":"Corporate Code"
        },
        "courierSrvcType":{
            "type":"string",
            "description":"Courier service type used for corporate enrichmentData"
        },
        "ObcmTmCorpEnrchPckupDetailsDTO":{
            "type":"array",
            "description":"List of Corporate Enrichment pickup details",
            "items":{
                "$ref":"#/definitions/ObcmTmCorpEnrchPckupDetailsDTO"
            }
        },
        "ObcmTmCorpEnrchDeliveryDetailsDTO":{
            "type":"array",
            "description":"List of Corporate Enrichment delivery details",
            "items":{
                "$ref":"#/definitions/ObcmTmCorpEnrchDeliveryDetailsDTO"
            }
        }
    }
}

Match All

Show Source

• allOf GenericDto

{
    "type":"object",
    "description":"Request DTO for Corporate Enrichment Pickup and Delivery Courier Service.",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        }
    ],
    "properties":{
        "corporateCode":{
            "type":"string",
            "description":"Corporate Code"
        },
        "courierSrvcType":{
            "type":"string",
            "description":"Courier service type used for corporate enrichmentData"
        },
        "ObcmTmCorpEnrchPckupDetailsDTO":{
            "type":"array",
            "description":"List of Corporate Enrichment pickup details",
            "items":{
                "$ref":"#/definitions/ObcmTmCorpEnrchPckupDetailsDTO"
            }
        },
        "ObcmTmCorpEnrchDeliveryDetailsDTO":{
            "type":"array",
            "description":"List of Corporate Enrichment delivery details",
            "items":{
                "$ref":"#/definitions/ObcmTmCorpEnrchDeliveryDetailsDTO"
            }
        }
    }
}

Nested Schema : ObcmTmCorpEnrchDeliveryDetailsDTO

Type: array

List of Corporate Enrichment delivery details

Show Source

• Array of: object ObcmTmCorpEnrchDeliveryDetailsDTO

{
    "type":"array",
    "description":"List of Corporate Enrichment delivery details",
    "items":{
        "$ref":"#/definitions/ObcmTmCorpEnrchDeliveryDetailsDTO"
    }
}

Nested Schema : ObcmTmCorpEnrchPckupDetailsDTO

Type: array

List of Corporate Enrichment pickup details

Show Source

• Array of: object ObcmTmCorpEnrchPckupDetailsDTO
  Corporate Enrichment PickUp details Data

{
    "type":"array",
    "description":"List of Corporate Enrichment pickup details",
    "items":{
        "$ref":"#/definitions/ObcmTmCorpEnrchPckupDetailsDTO"
    }
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : ObcmTmCorpEnrchDeliveryDetailsDTO

Type: object

Show Source

• status(optional): string
  Status Enum specifying the type of Request. ACTIVE - (CREATE/MODIFY) and DELETE

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/ObcmTmCorpEnrchDlvryDetailsDTO"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "status":{
            "$ref":"#/definitions/status"
        }
    }
}

Match All

Show Source

• object ObcmTmCorpEnrchDlvryDetailsDTO
  Corporate Enrichment Delivery Details Data
• object ObcmTmCorpEnrchDeliveryDetailsDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/ObcmTmCorpEnrchDlvryDetailsDTO"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "status":{
            "$ref":"#/definitions/status"
        }
    }
}

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

{
    "type":"object",
    "description":"Corporate Enrichment Delivery Details Data",
    "properties":{
        "addln1":{
            "type":"string",
            "description":"Address Line 1 used for corporate enrichment delivery details data"
        },
        "addln2":{
            "type":"string",
            "description":"Address Line 2 used for corporate enrichment delivery details data"
        },
        "addln3":{
            "type":"string",
            "description":"Address Line 3 used for corporate enrichment delivery details data"
        },
        "addln4":{
            "type":"string",
            "description":"Address Line 4 used for corporate enrichment delivery details data"
        },
        "agrmntDate":{
            "type":"string",
            "description":"Arragment used for corporate enrichment delivery details data"
        },
        "cntctPerson":{
            "type":"string",
            "description":"Contact Person used for corporate enrichment delivery details data"
        },
        "cntryCode":{
            "type":"string",
            "description":"Country Code used for corporate enrichment delivery details data"
        },
        "cntryName":{
            "type":"string",
            "description":"Country name used for corporate enrichment delivery details data"
        },
        "courierCode":{
            "type":"string",
            "description":"CourierCode used for corporate enrichment delivery details data"
        },
        "courierCodeDesc":{
            "type":"string",
            "description":"CourierCodeDesc used for corporate enrichment delivery details data"
        },
        "dayOfWeek":{
            "type":"string",
            "description":"DayOfWeek used for corporate enrichment delivery details data"
        },
        "dlvryCode":{
            "type":"string",
            "description":"Delivery Code used for corporate enrichment delivery details data"
        },
        "dlvryDesc":{
            "type":"string",
            "description":"Delivery Desc used for corporate enrichment delivery details data"
        },
        "dlvryOnHldys":{
            "type":"string",
            "description":"DeliveryOnHldys used for corporate enrichment delivery details data"
        },
        "dlvrySlot":{
            "type":"string",
            "description":"Delivery Slot used for corporate enrichment delivery details data"
        },
        "dlvryType":{
            "type":"string",
            "description":"Delivery Type used for corporate enrichment delivery details data"
        },
        "fax":{
            "type":"number",
            "description":"Faxx number used for corporate enrichment delivery details data"
        },
        "freq":{
            "type":"string",
            "description":"Frequency used for corporate enrichment delivery details data"
        },
        "locationCode":{
            "type":"string",
            "description":"LocationCode used for corporate enrichment delivery details data"
        },
        "locationDesc":{
            "type":"string",
            "description":"LocationDesc used for corporate enrichment delivery details data"
        },
        "postalCode":{
            "type":"number",
            "description":"PostalCode used for corporate enrichment delivery details data"
        },
        "prEmailId":{
            "type":"string",
            "description":"Pre EmailId used for corporate enrichment delivery details data"
        },
        "prPhoneNo":{
            "type":"number",
            "description":"Pre PhoneNo used for corporate enrichment delivery details data"
        },
        "scEmailId":{
            "type":"string",
            "description":"Source EmailId used for corporate enrichment delivery details data"
        },
        "scPhoneNo":{
            "type":"number",
            "description":"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

{
    "type":"object",
    "description":"Corporate Enrichment PickUp details Data",
    "properties":{
        "addln1":{
            "type":"string",
            "description":"Address line 1 used corporate enrichment pickUp details response"
        },
        "addln2":{
            "type":"string",
            "description":"Address line 2 used corporate enrichment pickUp details response"
        },
        "addln3":{
            "type":"string",
            "description":"Address line 3 used corporate enrichment pickUp details response"
        },
        "addln4":{
            "type":"string",
            "description":"Address line 4 used corporate enrichment pickUp details response"
        },
        "agrmntDate":{
            "type":"string",
            "description":"Arragment date used corporate enrichment pickUp details response"
        },
        "cntctPerson":{
            "type":"string",
            "description":"Contact person used corporate enrichment pickUp details"
        },
        "cntryCode":{
            "type":"string",
            "description":"Country code used corporate enrichment pickUp details response"
        },
        "cntryName":{
            "type":"string",
            "description":"Country name used corporate enrichment pickUp details response"
        },
        "courierCode":{
            "type":"string",
            "description":"Courier Code used corporate enrichment pickUp details response"
        },
        "courierCodeDesc":{
            "type":"string",
            "description":"CourierCode Description used corporate enrichment pickUp details response"
        },
        "dayOfWeek":{
            "type":"string",
            "description":"DayOfWeek used corporate enrichment pickUp details response"
        },
        "fax":{
            "type":"number",
            "description":"Fax number used corporate enrichment pickUp details response"
        },
        "freq":{
            "type":"string",
            "description":"Frequency used corporate enrichment pickUp details response"
        },
        "locationCode":{
            "type":"string",
            "description":"LocationCode used corporate enrichment pickUp details response"
        },
        "locationDesc":{
            "type":"string",
            "description":"LocationDesc used corporate enrichment pickUp details response"
        },
        "pickupCode":{
            "type":"string",
            "description":"PickupCode used corporate enrichment pickUp details response"
        },
        "pickupFor":{
            "type":"string",
            "description":"PickupFor used corporate enrichment pickUp details response"
        },
        "pickupOnHldys":{
            "type":"string",
            "description":"PickupOnHldys used corporate enrichment pickUp details response"
        },
        "pickupPt":{
            "type":"string",
            "description":"Pickup point used corporate enrichment pickUp details response"
        },
        "pickupSlot":{
            "type":"string",
            "description":"PickupSlot used corporate enrichment pickUp details"
        },
        "pickupType":{
            "type":"string",
            "description":"PickupType used corporate enrichment pickUp details"
        },
        "postalCode":{
            "type":"number",
            "description":"PostalCode used corporate enrichment pickUp details"
        },
        "prEmailId":{
            "type":"string",
            "description":"Pre EmailId used corporate enrichment pickUp details"
        },
        "prPhoneNo":{
            "type":"number",
            "description":"Pre PhoneNo used corporate enrichment pickUp details"
        },
        "retrnDispatch":{
            "type":"string",
            "description":"Return Dispatch used corporate enrichment pickUp details"
        },
        "scEmailId":{
            "type":"string",
            "description":"Source EmailId used corporate enrichment pickUp details"
        },
        "scPhoneNo":{
            "type":"number",
            "description":"Source PhoneNo used corporate enrichment pickUp details"
        },
        "chqRtnAddln1":{
            "type":"string",
            "description":"Cheque return Address line 1 used corporate enrichment pickUp details"
        },
        "chqRtnAddln2":{
            "type":"string",
            "description":"Cheque return Address line 2 used corporate enrichment pickUp details"
        },
        "chqRtnAddln3":{
            "type":"string",
            "description":"Cheque return Address line 3 used corporate enrichment pickUp details"
        },
        "chqRtnAddln4":{
            "type":"string",
            "description":"Cheque return Address line 4 used corporate enrichment pickUp details"
        }
    }
}

Back to Top

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.

Body ()

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

{
    "type":"object",
    "description":"Collection of Corporate Enrichment Courier Setup master Data.",
    "properties":{
        "responseCode":{
            "type":"string",
            "description":"ResponseCode used for Corporate Enrichment Courier Setup master Data"
        },
        "corporateEnrichmentData":{
            "description":"Corporate Enrichment Data for Pickup and Delivery.",
            "$ref":"#/definitions/ObcmTmCorpEnrchCourierStupMstrDTO"
        },
        "errors":{
            "type":"array",
            "description":"Error List for the Request Object.",
            "items":{
                "$ref":"#/definitions/ErrorDto"
            }
        }
    }
}

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

{
    "type":"object",
    "description":"Response DTO for Corporate Enrichment Pickup and Delivery.",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        }
    ],
    "properties":{
        "corporateCode":{
            "type":"string",
            "description":"Corporate Code."
        },
        "corporateName":{
            "type":"string",
            "description":"Coporate Name."
        },
        "courierSrvcType":{
            "type":"string",
            "description":"Courier service type used for corporate enrichmentData"
        },
        "ObcmTmCorpEnrchPickupDetailsDTO":{
            "type":"array",
            "description":"List of Corporate Enrichment pickup details",
            "items":{
                "$ref":"#/definitions/ObcmTmCorpEnrichPckupDetailsDTO"
            }
        },
        "ObcmTmCorpEnrchDeliveryDetailsDTO":{
            "type":"array",
            "description":"List of Corporate Enrichment delivery details",
            "items":{
                "$ref":"#/definitions/ObcmTmCorpEnrichDlvryDetailsDTO"
            }
        }
    }
}

Match All

Show Source

• allOf GenericDto

{
    "type":"object",
    "description":"Response DTO for Corporate Enrichment Pickup and Delivery.",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        }
    ],
    "properties":{
        "corporateCode":{
            "type":"string",
            "description":"Corporate Code."
        },
        "corporateName":{
            "type":"string",
            "description":"Coporate Name."
        },
        "courierSrvcType":{
            "type":"string",
            "description":"Courier service type used for corporate enrichmentData"
        },
        "ObcmTmCorpEnrchPickupDetailsDTO":{
            "type":"array",
            "description":"List of Corporate Enrichment pickup details",
            "items":{
                "$ref":"#/definitions/ObcmTmCorpEnrichPckupDetailsDTO"
            }
        },
        "ObcmTmCorpEnrchDeliveryDetailsDTO":{
            "type":"array",
            "description":"List of Corporate Enrichment delivery details",
            "items":{
                "$ref":"#/definitions/ObcmTmCorpEnrichDlvryDetailsDTO"
            }
        }
    }
}

Nested Schema : errors

Type: array

Error List for the Request Object.

Show Source

• Array of: object ErrorDto

{
    "type":"array",
    "description":"Error List for the Request Object.",
    "items":{
        "$ref":"#/definitions/ErrorDto"
    }
}

Nested Schema : ObcmTmCorpEnrchDeliveryDetailsDTO

Type: array

List of Corporate Enrichment delivery details

Show Source

• Array of: object ObcmTmCorpEnrichDlvryDetailsDTO

{
    "type":"array",
    "description":"List of Corporate Enrichment delivery details",
    "items":{
        "$ref":"#/definitions/ObcmTmCorpEnrichDlvryDetailsDTO"
    }
}

Nested Schema : ObcmTmCorpEnrchPickupDetailsDTO

Type: array

List of Corporate Enrichment pickup details

Show Source

• Array of: object ObcmTmCorpEnrichPckupDetailsDTO

{
    "type":"array",
    "description":"List of Corporate Enrichment pickup details",
    "items":{
        "$ref":"#/definitions/ObcmTmCorpEnrichPckupDetailsDTO"
    }
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "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]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/ObcmTmCorpEnrchDlvryDetailsDTO"
        },
        {
            "type":"object",
            "properties":{
                "errors":{
                    "type":"array",
                    "description":"Error List for the Detail Object.",
                    "items":{
                        "$ref":"#/definitions/ErrorDto"
                    }
                }
            }
        }
    ]
}

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

{
    "type":"object",
    "description":"Corporate Enrichment Delivery Details Data",
    "properties":{
        "addln1":{
            "type":"string",
            "description":"Address Line 1 used for corporate enrichment delivery details data"
        },
        "addln2":{
            "type":"string",
            "description":"Address Line 2 used for corporate enrichment delivery details data"
        },
        "addln3":{
            "type":"string",
            "description":"Address Line 3 used for corporate enrichment delivery details data"
        },
        "addln4":{
            "type":"string",
            "description":"Address Line 4 used for corporate enrichment delivery details data"
        },
        "agrmntDate":{
            "type":"string",
            "description":"Arragment used for corporate enrichment delivery details data"
        },
        "cntctPerson":{
            "type":"string",
            "description":"Contact Person used for corporate enrichment delivery details data"
        },
        "cntryCode":{
            "type":"string",
            "description":"Country Code used for corporate enrichment delivery details data"
        },
        "cntryName":{
            "type":"string",
            "description":"Country name used for corporate enrichment delivery details data"
        },
        "courierCode":{
            "type":"string",
            "description":"CourierCode used for corporate enrichment delivery details data"
        },
        "courierCodeDesc":{
            "type":"string",
            "description":"CourierCodeDesc used for corporate enrichment delivery details data"
        },
        "dayOfWeek":{
            "type":"string",
            "description":"DayOfWeek used for corporate enrichment delivery details data"
        },
        "dlvryCode":{
            "type":"string",
            "description":"Delivery Code used for corporate enrichment delivery details data"
        },
        "dlvryDesc":{
            "type":"string",
            "description":"Delivery Desc used for corporate enrichment delivery details data"
        },
        "dlvryOnHldys":{
            "type":"string",
            "description":"DeliveryOnHldys used for corporate enrichment delivery details data"
        },
        "dlvrySlot":{
            "type":"string",
            "description":"Delivery Slot used for corporate enrichment delivery details data"
        },
        "dlvryType":{
            "type":"string",
            "description":"Delivery Type used for corporate enrichment delivery details data"
        },
        "fax":{
            "type":"number",
            "description":"Faxx number used for corporate enrichment delivery details data"
        },
        "freq":{
            "type":"string",
            "description":"Frequency used for corporate enrichment delivery details data"
        },
        "locationCode":{
            "type":"string",
            "description":"LocationCode used for corporate enrichment delivery details data"
        },
        "locationDesc":{
            "type":"string",
            "description":"LocationDesc used for corporate enrichment delivery details data"
        },
        "postalCode":{
            "type":"number",
            "description":"PostalCode used for corporate enrichment delivery details data"
        },
        "prEmailId":{
            "type":"string",
            "description":"Pre EmailId used for corporate enrichment delivery details data"
        },
        "prPhoneNo":{
            "type":"number",
            "description":"Pre PhoneNo used for corporate enrichment delivery details data"
        },
        "scEmailId":{
            "type":"string",
            "description":"Source EmailId used for corporate enrichment delivery details data"
        },
        "scPhoneNo":{
            "type":"number",
            "description":"Source PhoneNo used for corporate enrichment delivery details data"
        }
    }
}

Nested Schema : ObcmTmCorpEnrichDlvryDetailsDTO-allOf[1]

Type: object

Show Source

• errors(optional): array errors
  Error List for the Detail Object.

{
    "type":"object",
    "properties":{
        "errors":{
            "type":"array",
            "description":"Error List for the Detail Object.",
            "items":{
                "$ref":"#/definitions/ErrorDto"
            }
        }
    }
}

Nested Schema : errors

Type: array

Error List for the Detail Object.

Show Source

• Array of: object ErrorDto

{
    "type":"array",
    "description":"Error List for the Detail Object.",
    "items":{
        "$ref":"#/definitions/ErrorDto"
    }
}

Nested Schema : ErrorDto

Type: object

Show Source

• errorCode(optional): string
  Error Codes Displaying
• errorDesc(optional): string
  Error Description displaying based on error codes

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Codes Displaying"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Description displaying based on error codes"
        }
    }
}

Nested Schema : ObcmTmCorpEnrichPckupDetailsDTO

Type: object

Match All

Show Source

• object ObcmTmCorpEnrchPckupDetailsDTO
  Corporate Enrichment PickUp details Data
• object ObcmTmCorpEnrichPckupDetailsDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/ObcmTmCorpEnrchPckupDetailsDTO"
        },
        {
            "type":"object",
            "properties":{
                "errors":{
                    "type":"array",
                    "description":"Error List for the Detail Object.",
                    "items":{
                        "$ref":"#/definitions/ErrorDto"
                    }
                }
            }
        }
    ]
}

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

{
    "type":"object",
    "description":"Corporate Enrichment PickUp details Data",
    "properties":{
        "addln1":{
            "type":"string",
            "description":"Address line 1 used corporate enrichment pickUp details response"
        },
        "addln2":{
            "type":"string",
            "description":"Address line 2 used corporate enrichment pickUp details response"
        },
        "addln3":{
            "type":"string",
            "description":"Address line 3 used corporate enrichment pickUp details response"
        },
        "addln4":{
            "type":"string",
            "description":"Address line 4 used corporate enrichment pickUp details response"
        },
        "agrmntDate":{
            "type":"string",
            "description":"Arragment date used corporate enrichment pickUp details response"
        },
        "cntctPerson":{
            "type":"string",
            "description":"Contact person used corporate enrichment pickUp details"
        },
        "cntryCode":{
            "type":"string",
            "description":"Country code used corporate enrichment pickUp details response"
        },
        "cntryName":{
            "type":"string",
            "description":"Country name used corporate enrichment pickUp details response"
        },
        "courierCode":{
            "type":"string",
            "description":"Courier Code used corporate enrichment pickUp details response"
        },
        "courierCodeDesc":{
            "type":"string",
            "description":"CourierCode Description used corporate enrichment pickUp details response"
        },
        "dayOfWeek":{
            "type":"string",
            "description":"DayOfWeek used corporate enrichment pickUp details response"
        },
        "fax":{
            "type":"number",
            "description":"Fax number used corporate enrichment pickUp details response"
        },
        "freq":{
            "type":"string",
            "description":"Frequency used corporate enrichment pickUp details response"
        },
        "locationCode":{
            "type":"string",
            "description":"LocationCode used corporate enrichment pickUp details response"
        },
        "locationDesc":{
            "type":"string",
            "description":"LocationDesc used corporate enrichment pickUp details response"
        },
        "pickupCode":{
            "type":"string",
            "description":"PickupCode used corporate enrichment pickUp details response"
        },
        "pickupFor":{
            "type":"string",
            "description":"PickupFor used corporate enrichment pickUp details response"
        },
        "pickupOnHldys":{
            "type":"string",
            "description":"PickupOnHldys used corporate enrichment pickUp details response"
        },
        "pickupPt":{
            "type":"string",
            "description":"Pickup point used corporate enrichment pickUp details response"
        },
        "pickupSlot":{
            "type":"string",
            "description":"PickupSlot used corporate enrichment pickUp details"
        },
        "pickupType":{
            "type":"string",
            "description":"PickupType used corporate enrichment pickUp details"
        },
        "postalCode":{
            "type":"number",
            "description":"PostalCode used corporate enrichment pickUp details"
        },
        "prEmailId":{
            "type":"string",
            "description":"Pre EmailId used corporate enrichment pickUp details"
        },
        "prPhoneNo":{
            "type":"number",
            "description":"Pre PhoneNo used corporate enrichment pickUp details"
        },
        "retrnDispatch":{
            "type":"string",
            "description":"Return Dispatch used corporate enrichment pickUp details"
        },
        "scEmailId":{
            "type":"string",
            "description":"Source EmailId used corporate enrichment pickUp details"
        },
        "scPhoneNo":{
            "type":"number",
            "description":"Source PhoneNo used corporate enrichment pickUp details"
        },
        "chqRtnAddln1":{
            "type":"string",
            "description":"Cheque return Address line 1 used corporate enrichment pickUp details"
        },
        "chqRtnAddln2":{
            "type":"string",
            "description":"Cheque return Address line 2 used corporate enrichment pickUp details"
        },
        "chqRtnAddln3":{
            "type":"string",
            "description":"Cheque return Address line 3 used corporate enrichment pickUp details"
        },
        "chqRtnAddln4":{
            "type":"string",
            "description":"Cheque return Address line 4 used corporate enrichment pickUp details"
        }
    }
}

Nested Schema : ObcmTmCorpEnrichPckupDetailsDTO-allOf[1]

Type: object

Show Source

• errors(optional): array errors
  Error List for the Detail Object.

{
    "type":"object",
    "properties":{
        "errors":{
            "type":"array",
            "description":"Error List for the Detail Object.",
            "items":{
                "$ref":"#/definitions/ErrorDto"
            }
        }
    }
}

Nested Schema : errors

Type: array

Error List for the Detail Object.

Show Source

• Array of: object ErrorDto

{
    "type":"array",
    "description":"Error List for the Detail Object.",
    "items":{
        "$ref":"#/definitions/ErrorDto"
    }
}

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

Back to Top