Operation
post /esmService/customer/createCustomer
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Customer Data | Customer Data Holder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
CustomerDataRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<CustomerDataHolder> <reqId> <reqId/> <respBeanRef/> <clientName/> </reqId> <req> <customerName>Sushma</customerName> <phoneNumber>9742087700</phoneNumber> <emailId>xyz@gmail.com</emailId> <address>xyz</address> <descr>xyz</descr> </req> </CustomerDataHolder>
Produces
application/xml
Example Response Data
<CustomerDataRespHolder> <response> <customerName>Sushma</customerName> <phoneNumber>9742087700</phoneNumber> <emailId>xyz@gmail.com</emailId> <address>xyz</address> <descr>xyz</descr> <creationTime>0</creationTime> <lastUpdationTime>0</lastUpdationTime> </response> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>CUST_CREATE_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>Sushma</parameters> </responseId> </CustomerDataRespHolder>
External Docs
Operation
post /esmService/customer/deleteCustomer
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Customer Data | Customer Data ID Holder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
CustomerIdRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<CustomerIdHolder> <reqId> <reqId/> <respBeanRef/> <clientName/> </reqId> <req> <customerId/> <customerName>Sushma</customerName> </req> </CustomerIdHolder>
Produces
application/xml
Example Response Data
<CustomerIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>CUST_DEL_020</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>Sushma</parameters> </responseId> <rsp> <customerId>3</customerId> <customerName>Sushma</customerName> </rsp> </CustomerIdRespHolder>
External Docs
Operation
post /esmService/customer/modifyCustomer
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Customer Data | Customer Data Holder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
CustomerDataRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<CustomerDataHolder> <reqId> <reqId/> <respBeanRef/> <clientName/> </reqId> <req> <customerName>Sushma</customerName> <phoneNumber>9742087701</phoneNumber> <emailId>xyz@gmail.com</emailId> <address>xyz</address> <descr>xyz</descr> </req> </CustomerDataHolder>
Produces
application/xml
Example Response Data
<CustomerDataRespHolder> <response> <customerName>Sushma</customerName> <phoneNumber>9742087701</phoneNumber> <emailId>xyz@gmail.com</emailId> <address>xyz</address> <descr>xyz</descr> <creationTime>0</creationTime> <lastUpdationTime>0</lastUpdationTime> </response> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>CUST_MODIFY_010</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>Sushma</parameters> </responseId> </CustomerDataRespHolder>
External Docs
Customer Data Holder
Name |
Type |
Description |
Enum |
---|---|---|---|
sessionId | String string |
--- | --- |
requestURI | String string |
--- | --- |
logReqId | String string |
--- | --- |
operator | String string |
--- | --- |
client | String string |
--- | --- |
reqId | Request Header Request Header |
Request ID Mapper | --- |
req | CustomerData CustomerData |
Request Mapper | --- |
activate | Boolean boolean |
--- | --- |
Customer Data ID Holder
Name |
Type |
Description |
Enum |
---|---|---|---|
sessionId | String string |
--- | --- |
requestURI | String string |
--- | --- |
logReqId | String string |
--- | --- |
operator | String string |
--- | --- |
client | String string |
--- | --- |
reqId | Request Header Request Header |
Request ID Mapper | --- |
req | CustomerId CustomerId |
Request Mapper | --- |
activate | Boolean boolean |
--- | --- |
CustomerData
Name |
Type |
Description |
Enum |
---|---|---|---|
descr | String string |
Description | --- |
phoneNumber | String string |
Phone | --- |
address | String string |
Address | --- |
lastUpdationTime | Long long |
LastUpdationTime | --- |
creationTime | Long long |
CreationTime | --- |
additionalInfo | Object object |
AdditionalInfo | --- |
emailId | String string |
EmailId | --- |
customerName | String string |
CustomerName | --- |
CustomerDataRespHolder
Name |
Type |
Description |
Enum |
---|---|---|---|
responseId | Response Header Model Response Header Model |
response | --- |
response | CustomerData CustomerData |
CustomerData | --- |
CustomerIdRespHolder
Name |
Type |
Description |
Enum |
---|---|---|---|
responseId | Response Header Model Response Header Model |
response | --- |
rsp | CustomerId CustomerId |
CustomerData | --- |
Response Header Model
Name |
Type |
Description |
Enum |
---|---|---|---|
req | Request Header Request Header |
req | --- |
errorReason | String string |
errorReason | [Error reason] |
errorCode | String string |
--- | --- |
message | String string |
--- | --- |
cmdStatus | String string |
cmdStatus | [Success, Failure, Timed-Out, Unknown] |
opMsg | String string |
Operation message | --- |
msgCode | String string |
msgCode | [Message code] |
parameters | array[String] string |
--- | --- |
paramCount | Integer integer |
parameter count returned in the response | --- |
objectId | Integer integer |
Object Id | --- |
jobName | String string |
Job Name | --- |
objectType | Integer integer |
Job Object TYpe | --- |