Draft Claim Upload API (1.0)

Download OpenAPI specification:Download

The Draft Claims - DMS API allows you to draft warranty claims from your Dealer Management System.

Once authenticated, response to every request will be sent in XML format.

URL is: . PROD: https://warranty.doosanpassport.com/b2bi . QA: https://diitwmsuat.tavant.com/b2bi

Upload Draft Claim

Request Fields:

Serial No	Field Name	Description	Business rules	Data Type
1	PartyId	Party Id. Reach out to bobcat IT team to get actual credentials.	Required	STRING
2	PartyPassword	Party Password. Reach out to bobcat IT team to get actual credentials.	Required	STRING
3	PartyNetwork	Party Network. Example : dealers.bobcat.com	Required	STRING
4	DealerNumber	The customer number this should be AR Number of the Dealer.	Required	STRING maxlength:255
5	BusinessUnitName	Business Unit Example : Bobcat-US	Required	STRING
6	SerialNo	Serial Number of the machine. This field will not be populated in case of parts claim without host machine i.e if the part is not installed on any machine	Optional	STRING maxlength:255
7	ModelNumber	Model number of the machine in case the claim is to be filed on non-serialized item.	Optional	STRING maxlength:255
8	ItemNumber	Item number. This will be item number of machine in case of machine claim, item number of attachment in case of attachment claim and item number of host machine in case of parts claim.	Required	STRING maxlength:255
9	PartItemNumber	Item number. This field will be populated only in case of parts claim.	Optional	STRING maxlength:255
10	ClaimType	Claim type could be “MACHINE”, “ATTCHMENT”, “PARTS” or “FIELDMODIFICATION”	Required	STRING
11	DealerUserLoginId	Dealer User on whose behalf the claims will be uploaded as Draft. This User will be able to see the uploaded claims in his Drafts Inbox. This should be the login of the user in IRW	Required	STRING maxlength:255
12	SourceSystem	Unique String identifying the source system. Should be ‘PFW’, ‘NDS’, ‘NAVISION’, ‘IRES’	Optional	STRING
13	UniqueIdentifier	Unique identifier to uniquely identify an uploaded draft claim. Combination of dealer number and the claim number should be good	Optional	STRING
14	HoursInService	Number of hours the machine has been in service	Required	NUMBER
18	WorkOrderNumber	Work Order Number for the service performed appended with the Repair Number. In case multiple repairs are done under a single work order we will need the repair number appended to work order number.	Required	STRING maxlength:255
19	ConditionsFound	Conditions found comments for the repair	Optional	STRING maxlength:10000
20	WorkPerformed	Work performed comments	Optional	STRING maxlength:10000
21	ProbableCause	Probable Cause comments	Optional	STRING maxlength:10000
22	GeneralComments	Any other general comments regarding the repair	Optional	STRING maxlength:10000
23	CausalPart	Part number of the causal part	Optional	STRING maxlength:255
24	LaborHours	Labor hours.	Optional	NUMBER
25	ReplacedParts	Item replaced or added.	Optional	STRING
26	Item	Part Number of the item replaced or added.	Optional	STRING
27	IsIRPart	Flag to indicate if part is Bobcat part or non-Bobcat part. this field will be required only in case of PARTS line item. It could be either 'Y' or 'N'	Optional	CHAR(1)
28	Description	Description of the Non-Bobcat part. This field will be populated only in case of non-Bobcat part. It could have the Non-Bobcat part number in case the description is not available.	Optional	STRING maxlength:255
29	Quantity	This field will be required only in case of PARTS line item	Optional	NUMBER
30	Price	Only if the replaced part is non-Bobcat.	Optional	NUMBER
31	CampaignCode	Campaign Code required in case of Field Modification claims	Optional	STRING maxlength:255

Error Codes:

S. No	Error Code	Type of Validation	Description
1	E040005	Primary	Invalid PartyId Field
2	E040005	Primary	Invalid PartyPassword Field
3	E040005	Primary	Invalid PartyNetwork Field
4	E040005	Primary	Invalid PartyId or PartyPassword in element “{0}”
5	E019999	Unexpected Error	Unexpected system error: "{0}"

Request

Request Body schema: application/xml
required

required

object (Draft Claim Upload XML)

Responses

200

Received the claim information and processed. Errors if any are sent back in response.

post/b2bi

Request samples

Payload
curl
Node.js
Java
C#

application/xml

<?xml version="1.0" encoding="UTF-8"?>
<Message Version="1.0">
    <RequestHeader>
        <Manifest>
            <DocumentLabel>DraftClaimUpload</DocumentLabel>
        </Manifest>

        <From>
            <PartyId Context="Bobcat MFG System">000000</PartyId>
        </From>

        <To>
            <PartyId ContextSystem="Tavant">Tavant Technologies</PartyId>
        </To>
        <Sender>
            <PartyId Context="BobcatXML">XXXX</PartyId> 
            <PartyPassword>XXXX</PartyPassword>
            <PartyNetwork>dealers.bobcat.com</PartyNetwork>
        </Sender>
        <MessageData>
            <MessageId>440219512</MessageId>
            <TimeStamp>20230815T115758</TimeStamp>
        </MessageData>
    </RequestHeader>
    <Payload>
        <DraftClaimRequest>
            <BusinessUnitName>Bobcat-US</BusinessUnitName>
            <SourceSystem>PFW</SourceSystem>
            <UniqueIdentifier>03304.W112662</UniqueIdentifier>
            <DealerNumber>000000</DealerNumber>
            <DealerUserLoginId>0000@testmail.com</DealerUserLoginId>
            <ClaimType>FIELDMODIFICATION</ClaimType>
            <SerialNo>B4TEST9466</SerialNo>
            <ModelNo>T66 T</ModelNo>
            <ItemNumber>M0349</ItemNumber>
            <PartItemNumber/>
            <HoursInService>5</HoursInService>
            <RepairDate>09/10/2022</RepairDate>
            <FailureDate>09/10/2022</FailureDate>
            <InstallationDate>09/10/2022</InstallationDate>
            <WorkOrderNumber>1037-4</WorkOrderNumber>
            <LaborHours>1.5</LaborHours>
            <CampaignCode>02R335</CampaignCode>
            <CausalPart/>
            <ConditionsFound>THE COOLANT TUBE IS LEAKING COOLANT ON TOP OF THE ENGINE  </ConditionsFound>
            <WorkPerformed>WE INSTALLED THE NEW COOLANT TUBE,HOSE AND REPLACED THE LOST COOLANT </WorkPerformed>
            <ProbableCause>FIELD MOD 5547   </ProbableCause>
            <GeneralComments></GeneralComments>
            <ReplacedParts>
                <Item>
                    <PartNumber IsIRPart="Y">6983128</PartNumber>
                    <Quantity>1</Quantity>
                    <Description/>
                    <Price/>
                </Item>
                <Item>
                    <PartNumber IsIRPart="Y">7445878</PartNumber>
                    <Quantity>1</Quantity>
                    <Description/>
                    <Price/>
                </Item>
                <Item>
                    <PartNumber IsIRPart="Y">7448676</PartNumber>
                    <Quantity>1</Quantity>
                    <Description/>
                    <Price/>
                </Item>
                <Item>
                    <PartNumber IsIRPart="Y">6565977</PartNumber>
                    <Quantity>1</Quantity>
                    <Description/>
                    <Price/>
                </Item>
            </ReplacedParts>
        </DraftClaimRequest>
    </Payload>
    <ClaimCount>1</ClaimCount>
</Message>

Response samples

application/xml

<?xml version="1.0"?>
<Message Version="1.0">
	<ResponseHeader>
		<Manifest />
		<From>
		<PartyId ContextSystem="TavantLogin">Tavant</PartyId>
		</From>
		<To>
		<PartyId ContextSystem="TavantLogin">Bobcat</PartyId>
		</To>
		<Sender>
		<PartyId ContextSystem="TavantLogin">Tavant</PartyId>
		</Sender>
		<MessageData>
			<MessageId>5857095760369992483</MessageId>
			<TimeStamp>20230815T125943.371Z</TimeStamp>
			<RefMessageId>954309517</RefMessageId>
		</MessageData>
	</ResponseHeader>
	<Payload>
		<DraftClaimResponse ActionStatus="Success " UniqueIdentifier="110008566722900"/>
	</Payload>
</Message>

Draft Claim Upload API (1.0)

Upload Draft Claim

Request Body schema: application/xmlrequired

Request Body schema: application/xml
required