You are on page 1of 18

Cat Inspect

Interface

Last Updated: April 17, 2015


*Last Reviewed: April 17, 2015

This document contains confidential and trade secret information of CATERPILLAR, and
may not be copied or used except under license from CATERPILLAR. The inclusion of a
copyright notice hereon is precautionary only, and does not imply publication or disclosure.

Copyright 2006 Caterpillar Inc., 100 N.E. Adams, Peoria IL 61629

Cat and Caterpillar are trademarks of Caterpillar, Inc.


All other trademarks and registered trademarks are the property of their respective holders.
Table of Contents .................................................................. Error! Bookmark not defined.
Modification History ........................................................................................................... 3
Glossary .............................................................................................................................. 4
Process Overview ................................................................................................................ 5
Caterpillar Preferred Option .............................................................................................. 5
Related Interfaces............................................................................................................. 5
Field Types and Definitions .............................................................................................. 5
CAT Inspection Web Service .......................................................................................... 5
General Comments & Definitions...................................................................................... 6
Error Architecture, Error Codes, and Error Messages ....................................................7
Elements, Characteristics, Operator Symbols ................................................................7
Array Sizes .....................................................................................................................7
Currency Considerations .................................................................................................. 7
Regional Considerations................................................................................................... 7
Layouts ............................................................................................................................. 8
Layout Comments ..........................................................................................................8
Layout Types..................................................................................................................8
Request XML query parameters ............................................................................ 8
Response XML ........................................................................................................ 8
Sample Data ................................................................................................................ 11
XML version of sample data................................................................................. 11
json version of sample data ................................................................................. 13
Transmission/Media Type ............................................................................................... 15
Testing Procedures......................................................................................................... 16
Testing Coordination .................................................................................................... 16
Testing Comments ....................................................................................................... 16
Web Service Access .................................................................................................... 16
Follow the below steps to request an Inspection Web Service Application ID ......... 16
Who To Contact ........................................................................................................... 16
Test Configuration ........................................................................................................ 16
Sample Data ................................................................................................................ 16
Production Information.................................................................................................... 17
Production Comments .................................................................................................. 17
Production Configuration .............................................................................................. 17
Retrieving Image Data .................................................................................................... 17
Background .................................................................................................................. 17
Using the Correct Link .................................................................................................. 17
Getting the necessary security parameters to access Salesforce ................................ 18
Pre-requisites ............................................................................................................... 18
Execute the program to retrieve images ...................................................................... 18

Caterpillar: Confidential Green 2


Modification History
Date Author Description of Change
23 Aug 2013 Lori Denton/ New documentation.
Steve Lu
27 Jun 2014 Steve Lu Updated for a newer version and added documentation on how to retrieve
image data.
17 Oct 2014 Prafull G Updated documentation on how to retrieve image using API
21 Oct 2014 Prafull G Update document to add additional response fields and example xml and json
8 April 2015 M Raghunathan Updates include information on how to retrieve images using the API and also
documents additional fields available in the response.
17 April 2015 Lori Denton Updated the CAT Inspect contact and support email address to
CatInspect@catsupport.com.

Please Note: All interface modifications noted above (with the exception of corrections of
typographical errors) should be accompanied by a change communication notice as a result of the
Dealer Facing Interface Documentation CITA Standard. The date the above changes are
implemented, as well as the retirement of any previous formats, is noted within that communication.
Each Caterpillar application owner reserves the right to determine the dates(s) in which an interface
change is implemented as well as when previous versions of interfaces are retired, as long as the
advance notification of these changes is provided in accordance with this standard.

Below is a link to where all interface change communications are posted for review:
https://dealer.cat.com/cda/alias/dealerITServices

Link to Dealer-Facing Interface Documentation Standard


https://gis.cat.com/cda/files/3428040/7/Dealer-Facing%20Interface%20Standard%20v3.0.doc
Caterpillar: Confidential Green 3
Glossary
Cat Inspect tool

Cat Inspect tool is a mobile and web inspection application. This application contains several
inspection types including: Certified Rebuild inspection forms, Technical Analysis inspection forms
(TA-1), Preventive Maintenance Checklists (PM), and select Mining checklists. This easy-to-use
application will allow you to download and complete inspections as well as add pictures, comments,
and ratings. The PM checklists are serial number-specific to perform PM Service intervals as
recommended in the Caterpillar Operation and Maintenance Manual. Currently, Cat Inspect will be
available in English, Chinese (Simplified), French, German, Indonesian, Italian, Portuguese
(Brazilian), and Spanish (Latin American). The administration console is in English only.

Corporate CWS
Corporate Web Security. CWS is a standards-based site-independent set of infrastructure
components that web masters and web application developers can use to easily control access to
some or all of their web content.

Dealer Management System. A bundled management information system containing software that
supports all aspects of running a dealership.

Element
Specifies the kind of information in the XSD Schema.

REST
REpresentational State Transfer. REST describes an architectural pattern and is not a specific
technology implementation. The model for RESTful web services is based on sending XML data
defined by an XML Schema definition (XSD) via HTTP(s) using the standard HTTP protocol
operations such as GET, PUT, DELETE and POST. The service is Resource Oriented, a resource
e.g. a document, an image, an equipment is addressable via the addressability semantic built into
HTTP the URI (Uniform Resource Identifier).

URI
Uniform Resource Identifier. A string of characters used to identify a name or a resource on the
Internet. Such identification enables interaction with representations of the resource over a network
(typically the World Wide Web) using specific protocols. Schemes specifying a concrete syntax and
associated protocols define each URI.

XML
eXtensible Markup Language. XML is an open standard language that allows information to be
encoded with meaningful structure for exchanging over the Internet.

XML Attribute
Provides additional information about an element.

XSD

Caterpillar: Confidential Green 4


XML Schema Definition. Provides the syntax and defines a way in which elements and attributes can
be represented in an XML document.

Process Overview
Cat Inspect tool is a mobile application that dealers can utilize to complete inspections electronically.
Inspections completed by the mobile application are stored in the Inspection database at Caterpillar.

This interface document describes a service that allows dealers to pull completed inspections from
the Inspection database via a RESTful Web Service. Basic authentication is required and it uses an
application logon id to get the dealer code so that only your dealer data is returned. The web service
is invoked with parameters including start date, end date and optionally serial number and inspector
id. A maximum of ten inspections at a time are returned in the response XML that can be used to
populate a dealer management system.

Caterpillar Preferred Option


N/A

Related Interfaces
N/A

Field Types and Definitions


The following list provides the references to field types that will be used in this document.

Reference Description Example


string String of alphanumeric characters something
int Any numeric value not containing decimals 123
double Represents double-precision 64-bit floating 10,2 (10 positions total, with 2 decimal places)
point number.
0123456789.99
Up to 10 digits before the decimal and up to 2
after the decimal.
dateTime Composed of date + time + Time Zone 1964-11-19T00:23:56.900Z

CAT Inspection Web Service


Owner Go to https://dealer.cat.com/DealerITServices then click on the link
Caterpillar Application Interface Contact List under the Related Links in the
right column.
Author Lori Denton

Caterpillar: Confidential Green 5


For an e-mail address or phone number of the appropriate DICE Team Contact for this interface,
please click on their name to receive current contact information.

https://dealer.cat.com/cda/files/2789564/7/DICE+Team+Contats.xls

General Comments & Definitions

Comments
This solution provides a simple REST Web service that enables inspection information to be pulled
from a Caterpillar hosted database. Since we are using a pull service, the client will invoke the
service as needed to retrieve inspection information from the correct URI. The inspection data is
returned in UTF-8 encoding.

https://dataserve.cat.com (Production URI)

Invoking the Service

The inspection web service is designed to be a program-to-program integration technology.


Programmatic access to the service can be broken into three steps:

Opening a connection
Providing authentication
Executing the get operation

Opening a Connection
Most, if not all, modern programming languages provide API's that allow for opening an HTTP
connection. In order that the HTTPS connection can be opened, the client program must have
access to the public SSL certificate available at the appropriate equipment service address.

Providing Authentication
The equipment service is secured via HTTP Basic Authentication. Access to the service can be
accomplished utilizing a Caterpillar non-expiring application id/password.
When accessing the production service, the application id/password must be present in the
Production Caterpillar Global Directory.

Example:

Java
url = new URL(targetURL);
connection = (HttpURLConnection)url.openConnection();
BASE64Encoder enc = new sun.misc.BASE64Encoder();
String userpassword = username + ":" + password;
String encodedAuthorization = enc.encode(userpassword.getBytes() );
connection.setRequestProperty("Authorization", "Basic "+ encodedAuthorization);

Executing the Get


The inspection service supports only the HTTP GET operation. The GET can be executed as follows.

Caterpillar: Confidential Green 6


Java
connection.setRequestMethod("GET");
connection.setDoOutput(true);
connection.connect();
BufferedReader reader = new BufferedReader(new InputStreamReader(urlConnection.getInputStream()));

An HTTP 200 is sent to the client when the batch has been successfully pulled from the inspection
database for processing. The connection is released.

Accept header
The Rest service can provide either XML or Json. This is triggered by adding, in the HTTP Accept
header, either application/inspections-v1+xml or application/inspections-v1+json.

Note The service is versioned in this way as well. If the Accept header is not set with one of these
values version 1 of the XML will be returned even though new versions may exist. It is best practice
to set the Accept header in order to ensure the most current version is returned.

Error Architecture, Error Codes, and Error Messages


200 - Success! Data returned.
400 Bad Request. Request parameters were missing or had bad characters in them.
401 - Unauthorized. Basic Auth is required. Contact support for credentials.
403 - Forbidden. You have logged in, but we do not have your Dealer Code set up. Contact support
for help.
404 Not Found. No data found.
406 - Not Acceptable. You have used the incorrect Accept header.
415 - Unsupported media type. An incorrect content type was sent.
500 Internal Server Error There was a problem on the CAT side. You can retry, if error reoccurs
contact support.

Elements, Characteristics, Operator Symbols


N/A

Array Sizes

Inspection An array of unique inspections. This array is unbounded meaning it can be as many
occurrences however the web service is designed to return a maximum of 10 inspections at a time.

Currency Considerations
N/A

Regional Considerations

Caterpillar: Confidential Green 7


Layouts

Layout Comments

Layout Types

Request XML query parameters


CONTENT-TYPE

None. There is no payload for this request.

GET cds/rest/inspect/inspection

Examples:
/cds/rest/inspect/inspection?startDate=19Nov2012&endDate=18Jul2013
/cds/rest/inspect/inspection?startDate=19Nov2012&endDate=18Jul2013&sn=2WS23456&page=2
/cds/rest/inspect/inspection?startDate=19Nov2012&endDate=18Jul2013inspector=lewisJ&sn=2WS23456&page=2

Parameter Type Length Description Required Sample


(Y/N/C)
startDate String 9 Start date of the search. Y 11Nov1964
endDate String 9 End date of the search. Y 12Nov1964

sn string 50 Serial number for the equipment. N 2WS23456

Do not include characters <, > or ,


in the serial number. If any of these
values are found, the process will fail.
An error message (400 Bad Request)
will be returned and the search will
not be executed.
inspector string 40 CWS id of the inspector. N lewisJ

This parameter is case sensitive.


page string 1 Defines the page of data returned. N 0

Zero based. Will default to zero.

Response XML
The inspection service returns inspections 10 at a time. There is a nextUrl element provides the url
to get the next set of inspection data. When nextUrl is null, all inspections have been accessed.

NOTE Inspections are not deleted from the database when they are pulled. You may pull an
inspection an unlimited number of times.

Caterpillar: Confidential Green 8


See sample return XML and json data below.

Parameter Type Max Description Required Sample


Length (Y/N/C)
<inspectionId> string 20 Unique id for this inspection. Y

This is a unique value assigned at the


database level when the inspection is
created. You will never have a
duplicate Inspection Id.
<inspectionName> string 80 The name of the inspection form N Hydraulic Excavator
(HEX) TA1
<assignmentId> string 80 The identifier to use to look up the N 2014-01-5925
inspection in the host system.
Example Salesforce
<family> string 255 The family to which the machine N EXCAVATOR
being inspected belongs
<customerEquipNu string 255 The internal ID that the customer N
m> uses to refer to the machine.
Different than the machine serial
number.
<customerName> string 255 The name of the customer that owns N
the machine.
<customerNumber> string 255 The number used by the dealer to N
reference the customer in their
system.
<inspectionAssigne string 255 The person who assigned the N
dBy> inspection to be done. This can be
different than the person actually
performing the inspection.
<customerPhone> string 40 The contact phone number of the N
customer.
<customerEmail> string 80 The contact of the customer. N
<location> string 255 The location on which the machine N
resides. Could be GPS codes or the
name of the site.
<industry> string 255 The industry in which the machine N
operates. Examples Mining, Global
Petroleum, Marine
<mfrSerialNumber> string 20 The serial number for the equipment. Y 2WS23456

Number assigned to a prime product


by the manufacturer to uniquely
identify the product.
<inspectionDate> dateTime 24 Date of the inspection. Y 1964-11-
19T00:23:56.900Z
<mfrCode> string 4 A unique code the dealership has N CAT
assigned to the equipment
manufacturer.
<mfrModel> string 10 A code assigned to the equipment. N D7

Assigned by manufacturer to facilitate


communications with organizations
outside the company in referencing
company products.
<inspTypName> string 50 A code assigned to the type of N TA-9
inspection.

Caterpillar: Confidential Green 9


<inspectorName> string 40 Name of the inspector. N Jim Lewis
<userId> string 30 The CWS Id of the employee who N jlewis
performed the inspection.
<dlrCode> string 6 Dealer Code N N050

<workOrderNumber string 20 Dealer assigned number used to N 1234567


> control work units in a dealership.
<smu> double 12,2 Service Meter units of the machine N 14567
when the Inspection was performed.
<SMUUnitMeasure string 2 Code indicating the service meter unit N HR
of the machine used for the machine
inspected.

Possible values are:


HR =Hours
MI = Miles
KM = Kilometers
<genlCmnt> string 900 Comments for the overall inspection. N Some wear showing
<siteCd> string 25 Site Code N
<status> string 25 The status of this Inspection - EX: Y Completed
Completed, Revised
<lastModifyDate> dateTime 24 The date time of the last time the Y 1964-11-
inspection changed before 19T00:23:56.900Z
sumbitting it in Salesforce.
<assignmentDate> dateTime 24 The timestamp that this inspection Y 1964-11-
was assigned to the inspector. 19T00:23:56.900Z
<safetyAcceptedDat dateTime 24 The timestamp that this Safety
e> Caution was accepted to the
inspector.
<lang> string 20 FUTURE USE. The language the
inspection was written in.
<sys> string 50 System being inspected Y Lower-Level
Inspection
<itmDesc> string 100 Description of the item inspected. Y Rear Axle Housing
Support
<stat> string 20 Status of the inspection. Y Monitor
<color> string 20 The color displayed on the screen for Y Green
the response button clicked. The
response button clicked is stored in
the stat xml tag.
<comment> string 250 Comments for the inspection detail N Right side showing
line. wear.
<rprRcmnd> string 250 Repair Recommendation N None at this time
<code1> string 4 A code that is intended to identify the N 7000
inspection point. Typically this is the
SMCS component code.
<code2> String 4 A code that further identifies the N LR
inspection point. Typically this is the
primary location.
<code3> String 4 A code that further identifies the N AN
inspection point. Typically this is the
secondary location.
<obsv> Double 12,2 The measured value. Example - The N Examples:
tire pressure recorded using a 9
pressure gauge. 2012
66
0.28
<spfy> Double 12,2 The target value for this N Examples:

Caterpillar: Confidential Green 10


measurement. 34, 12.5, 0.06

Example The target for tires on this


machine is 35 psi.
<pstvTol> Double 12,2 This is upper acceptable range value N Examples:
for this measurement. 34, 12.5, 0.06

Example - Any Tire pressure between


30 and 38 is acceptable. The value
38 would be in this field.
<negTol> Double 12,2 This is lower acceptable range value N Examples:
for this measurement. Example - Any 34, 12.5, 0.06
Tire pressure between 30 and 38 is
acceptable. The value 30 would be in
this field.
<unit> String 4 The Unit Of Measure for these N A few examples:
elements. NA
<obsv> h
<spfy> %
<pstvTol>
<negTol>
<answerDate> dateTime 24 The timestamp that this question was Y 1964-11-
answered. 19T00:23:56.900Z
<fileType> Int 1 The type of attachment. Possible Y 1 or 2
values are:

1 = thumb
2 = full size
<dtaTyp> String 20 Type of file extension. Some possible Y JPG
values are:

JPG
GIF
PDF
<link> String 150 The URL of the attached image. Y http://www.cat.com/c
at/images/Cat_logo.gi
f
<isSignature> string Y/N Is this image a signature N Y

Sample Data

XML version of sample data


<?xml version="1.0" encoding="UTF-8"?>
<ns2:TheInspection xmlns:ns2="http://www.cat.com/Inspection">
<inspectionName>inspection name</inspectionName>
<assignmentId>SalesForce</assignmentId>
<family>fam</family>
<customerEquipNum>abc1234</customerEquipNum>
<customerName>cust name</customerName>
<customerNumber>cust nbr</customerNumber>
<inspectionAssignedBy>insp asgn by</inspectionAssignedBy>
<customerPhone>309-555-1212</customerPhone>
<customerEmail>joe@email.com</customerEmail>

Caterpillar: Confidential Green 11


<location>loc</location>
<industry>indst</industry>
<mfrSerialNumber>2WS23456</mfrSerialNumber>
<inspectionDate>1964-11-19T06:23:56.900+06:00</inspectionDate>
<mfrCode>CAT</mfrCode>
<mfrModel>793D</mfrModel>
<inspTypName>TA1</inspTypName>
<inspectorName>Jerry Lewis</inspectorName>
<userId>LEWISJ</userId>
<dlrCode>TD00</dlrCode>
<workOrderNumber>123456</workOrderNumber>
<smu>123.45</smu>
<SMUUnitMeasure>HR</SMUUnitMeasure>
<genlCmnt>genComment</genlCmnt>
<siteCd>siteCd</siteCd>
<status>new</status>
<lastModifyDate>1964-11-19T06:23:56.900+06:00</lastModifyDate>
<assignmentDate>1964-11-19T06:23:56.900+06:00</assignmentDate>
<safetyAcceptedDate>1964-11-19T06:23:56.900+06:00</safetyAcceptedDate>
<lang>EN</lang>
<headerAttachments>
<dtaTyp>JPG</dtaTyp>
<link>https://cateca.my.salesforce.com/servlet/servlet.FileDownload?file=00Pd0000008nPKlEAI </link>
<isSignature>Y</isSignature>
<creationDate>1964-11-19T06:23:56.900+06:00</creationDate>
</headerAttachments>
<details>
<questionNumber>1.0101</questionNumber>
<sys>sys1</sys>
<itmDesc>desc</itmDesc>
<stat>status</stat>
<color>green</color>
<comment>comment</comment>
<rprRcmnd>fix it.</rprRcmnd>
<code1>code</code1>
<code2>code</code2>
<code3>code</code3>
<obsv>1.2</obsv>
<spfy>1.2</spfy>
<pstvTol>1.2</pstvTol>
<negTol>1.2</negTol>
<unit>PSI</unit>
<inspectorName>Jerry Lewis</inspectorName>
<answerDate>1964-11-19T06:23:56.900+06:00</answerDate>
<attachments>
<fileType>1</fileType>
<dtaTyp>JPG</dtaTyp>
<link>https://cateca.my.salesforce.com/servlet/servlet.FileDownload?file=00Pd0000008jpKlEAI </link>
</attachments>
<attachments>
<fileType>1</fileType>
<dtaTyp>JPG</dtaTyp>
<link> https://cateca.my.salesforce.com/servlet/servlet.FileDownload?file=00Pd0000008jrKlEAI </link>
</attachments>
</details>
<details>
<questionNumber>2.0101</questionNumber>

Caterpillar: Confidential Green 12


<sys>sys2</sys>
<itmDesc>desc</itmDesc>
<stat>status</stat>
<color>green</color>
<comment>comment</comment>
<rprRcmnd>fix it.</rprRcmnd>
<code1>code</code1>
<code2>code</code2>
<code3>code</code3>
<obsv>1.2</obsv>
<spfy>1.2</spfy>
<pstvTol>1.2</pstvTol>
<negTol>1.2</negTol>
<unit>PSI</unit>
<inspectorName>John Doe</inspectorName>
<answerDate>1964-11-19T06:23:56.900+06:00</answerDate>
</details>
<details>
<questionNumber>2.0201</questionNumber>
<sys>sys2</sys>
<itmDesc>desc</itmDesc>
<stat>status</stat>
<color>green</color>
<comment>comment</comment>
<rprRcmnd>fix it.</rprRcmnd>
<code1>code</code1>
<code2>code</code2>
<code3>code</code3>
<obsv>1.2</obsv>
<spfy>1.2</spfy>
<pstvTol>1.2</pstvTol>
<negTol>1.2</negTol>
<unit>PSI</unit>
<inspectorName>John Doe</inspectorName>
<answerDate>1964-11-19T06:23:56.900+06:00</answerDate>
</details>
</ns2:TheInspection>

json version of sample data


{
"inspectionName": "inspection name",
"assignmentId": "SalesForce",
"family": "fam",
"customerEquipNum": "abc1234",
"customerName": "cust name",
"customerNumber": "cust nbr",
"inspectionAssignedBy": "insp asgn by",
"customerPhone": "309-555-1212",
"customerEmail": "joe@email.com",
"location": "loc",
"industry": "indst",
"mfrSerialNumber": "2WS23456",
"inspectionDate": "1964-11-19T06:23:56.900+06:00",
"mfrCode": "CAT",

Caterpillar: Confidential Green 13


"mfrModel": "793D",
"inspTypName": "TA1",
"inspectorName": "Jerry Lewis",
"userId": "LEWISJ",
"dlrCode": "TD00",
"workOrderNumber": "123456",
"smu": "123.45",
"SMUUnitMeasure": "HR",
"genlCmnt": "genComment",
"siteCd": "siteCd",
"status": "new",
"lastModifyDate": "1964-11-19T06:23:56.900+06:00",
"assignmentDate": "1964-11-19T06:23:56.900+06:00",
"safetyAcceptedDate": "1964-11-19T06:23:56.900+06:00",
"lang": "EN",
"headerAttachments": {
"dtaTyp": "JPG",
"link": "https://cateca.my.salesforce.com/servlet/servlet.FileDownload?file=00Pd0000008nPKlEAI",
"isSignature": "Y",
"creationDate": "1964-11-19T06:23:56.900+06:00"
},
"details": [
{
"questionNumber": "1.0101",
"sys": "sys1",
"itmDesc": "desc",
"stat": "status",
"color": "green",
"comment": "comment",
"rprRcmnd": "fix it.",
"code1": "code",
"code2": "code",
"code3": "code",
"obsv": "1.2",
"spfy": "1.2",
"pstvTol": "1.2",
"negTol": "1.2",
"unit": "PSI",
"inspectorName": "Jerry Lewis",
"answerDate": "1964-11-19T06:23:56.900+06:00",
"attachments": [
{
"fileType": "1",
"dtaTyp": "JPG",
"link": "https://cateca.my.salesforce.com/servlet/servlet.FileDownload?file=00Pd0000008jpKlEAI"
},
{
"fileType": "1",
"dtaTyp": "JPG",
"link": "https://cateca.my.salesforce.com/servlet/servlet.FileDownload?file=00Pd0000008jrKlEAI"
}
]
},
{
"questionNumber": "2.0101",
"sys": "sys2",
"itmDesc": "desc",

Caterpillar: Confidential Green 14


"stat": "status",
"color": "green",
"comment": "comment",
"rprRcmnd": "fix it.",
"code1": "code",
"code2": "code",
"code3": "code",
"obsv": "1.2",
"spfy": "1.2",
"pstvTol": "1.2",
"negTol": "1.2",
"unit": "PSI",
"inspectorName": "John Doe",
"answerDate": "1964-11-19T06:23:56.900+06:00"
},
{
"questionNumber": "2.0201",
"sys": "sys2",
"itmDesc": "desc",
"stat": "status",
"color": "green",
"comment": "comment",
"rprRcmnd": "fix it.",
"code1": "code",
"code2": "code",
"code3": "code",
"obsv": "1.2",
"spfy": "1.2",
"pstvTol": "1.2",
"negTol": "1.2",
"unit": "PSI",
"inspectorName": "John Doe",
"answerDate": "1964-11-19T06:23:56.900+06:00"
}
]
}

Transmission/Media Type
RESTful Web service

Caterpillar: Confidential Green 15


Testing Procedures

Testing Coordination
Testing requires coordination with the Caterpillar DICE team
Testing can be performed without Caterpillar DICE Team assistance

Testing Comments

Web Service Access


This service requires a single non-expiring application ID to connect to the web service.

Follow the below steps to request an Inspection Web Service Application ID

Dealer sends an email to CatInspect@catsupport.com. You will need to supply the following items in
your email.
a) Subject should be Dealer Request for CAT Inspect Interface application Id
b) Main Store Dealer Code
c) Requester name
d) Requester CWS Id

Typically next steps will be completed within 48 hours.


The CAT inspect team will create an Application ID.
The CAT inspect team will grant access for the Application ID to call the CAT Inspect web
service.
You will receive a response via e-mail that the dealer request was completed.

Who To Contact
For the scheduling of your testing needs, please contact your local dealer IT Representative to
coordinate the needed testing with the DICE Team.

If you are not sure who your IT Representative is, visit the Caterpillar website listed below for this
information:

https://dealer.cat.com/cda/alias/DealerITServices

Test Configuration
No test environment is available for this interface.

Sample Data
N/A
Caterpillar: Confidential Green 16
Production Information

Production Comments

Generic ID and Password

A generic application Id and password are available for testing in the production environment. These
credentials are tied to dealer TD00 and will pull back some test data if searched between
19Nov2012 and 18Jul2013.

Logon: CatInspect_Test
Password: Q7N7D6-s6b8p5

Production Configuration

URI
URI to pull Web Service https://dataserve.cat.com

Retrieving Image Data

Background

Inspections can contain image data including pictures taken of the equipment, signatures of one or
more individuals responsible for the inspection, and initials entered with answers to specific
questions.

This section explains how a dealers IT resource can set up a program to retrieve the images from
Salesforce using the technology of their choosing. (A working Java program is provided as an
example but the necessary steps can be performed using other languages and tools).

Using the Correct Link

As shown in the examples, the images themselves are not available in the XML or JSON. Rather, a
link is provided that realistically looks more like:

https://cateca.my.salesforce.com/servlet/servlet.FileDownload?file=00Pd0000006e5zkEAI

Dealers already have downloaded inspection data with the first link.

To extend the image download feature to use API (using code) take the image ID from the end of the first link
(every character after the equal sign, =).
00Pd0000006e5zkEAI

Caterpillar: Confidential Green 17


Prepend

/services/data/v20.0/sobjects/Attachment/

to get

/services/data/v20.0/sobjects/Attachment/00Pd0000006e5zkEAI

and append

/body

to get the second link:

/services/data/v20.0/sobjects/Attachment/00Pd0000006e5zkEAI/body

Getting the necessary security parameters to access Salesforce

Pre-requisites
Before the corrected links can be used, Salesforce security parameters need to be set up including a
special dealer user account. To get these, contact CatInspect@catsupport.com with an email. In the
subject line Please enter:

Cat Inspection Image Retrieval Setup Request

Within the email, please provide the following:

1. Dealer code.
2. Name of the technical contact at the dealer responsible for the image retrieval user account.
3. Email of the technical contact at the dealer responsible for the image retrieval user account.

Execute the program to retrieve images

As mentioned in previous steps, once the Image Retrieval Setup Request has been processed,
CatInspect@catsupport.com team will provide following information-

1. User details to retrieve image [Technical Contact person will receive necessary information to
set new password from Salesforce.com]
2. As per provided working java program, use above details to retrieve images.

Caterpillar: Confidential Green 18