Detailed Description

Examples for customers obfuscate request status

Example 1 - Get status of CSV file customer obfuscate request

This example demonstrates the following:

Get the status of customer obfuscate request containing multiple customer ids.
Few customers are successfully obfuscated while others failed to obfuscate.

XML

Request

Method	URL
GET	`/ws/v1/core/bulk/3A619A9A-53EC-43EA-A62E-1D0437583189?$attribute=all`

Request headers

Name	Value
X-egain-session	Valid session ID
Accept	application/xml
Accept-Language	en-US

Response
HTTP/1.1 200 OK

Response headers

Name	Value
X-egain-session	current session ID
Content-Type	application/xml

Response body

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<customer xmlns="http://bindings.egain.com/ws/model/v12/gen/interaction/customer" 
		xmlns:ns2="http://bindings.egain.com/ws/model/v12/gen/platform"
		xmlns:ns3="http://bindings.egain.com/ws/model/v12/gen/common">
	<status>
		<value>successful</value>
		<displayValue>Successful</displayValue>
	</status>
	<successfulEntries>
		<entry>
			<element>
				<action>update</action>
				<id>1001</id>
				<rowNum>2</rowNum>
			</element>
			<element>
				<action>update</action>
				<id>1002</id>
				<rowNum>3</rowNum>
			</element>
		</entry>
	</successfulEntries>
	<failedEntries>
		<entry>
			<element>
				<error>
					<code>400-5021</code>
					<developerMessage>Could not process the request as no customer was found in the system with customer id 1000.</developerMessage>
				</error>
				<id>1000</id>
				<rowNum>1</rowNum>
			</element>
		</entry>
	</failedEntries>
	<id>3A619A9A-53EC-43EA-A62E-1D0437583189</id>
	<resource>customer</resource>
</customer>

JSON

Request

Method	URL
GET	`/ws/v1/core/bulk/3A619A9A-53EC-43EA-A62E-1D0437583189?$attribute=all`

Request headers

Name	Value
X-egain-session	Valid session ID
Accept	application/json
Accept-Language	en-US

Response
HTTP/1.1 200 OK

Response headers

Name	Value
X-egain-session	current session ID
Content-Type	application/json

Response body

{
   "status":{
      "value":"successful",
      "displayValue":"Successful"
   },
   "successfulEntries":{
      "entry":[
         {
            "action":"update",
            "rowNum":2,
            "id":1001
         },
         {
            "action":"update",
            "rowNum":3,
            "id":1002
         }
      ]
   },
   "failedEntries":{
      "entry":[
         {
            "error":{
               "code":"400-5021",
               "developerMessage":"Could not process the request as no customer was found in the system with customer id 1000."
            },
            "rowNum":1,
            "id":1000
         }
      ]
   },
   "id":"3A619A9A-53EC-43EA-A62E-1D0437583189",
   "resource":"customer"
}