Warranty API

Overview 

Use the Warranty API to create new warranty records within an Aimbase instance.   

Authentication

The Lead API requires authentication. The HTTP POST will require a valid Authenticate message header with an API token. See the Aimbase Authentication Web Service Specification for more details on how to retrieve a valid API token. 

Authenticate message header example:

Authenticate: Avala-Api {username}:{token}

Post Information

HTTP Endpoint

https://{baseaddress}.aimbase.com/csi/api/warranty 

Warranty Data Schema

Field 

Max Length 

Required

Description 

SrvyType 

Yes 

Survey Type. 

IsUsed 

Yes 

Bit value to determine if product is new or used.  A value of “1” indicates a used product.  A value of “0” indicates a new product 

SerialNumber 

100 

Yes 

Also referred to as HIN 

WorkOrder 

 

Yes 

Node containing work order specific information 

Product 

 

Yes 

Node containing product specific information 

Customer 

 

Yes 

Node containing customer specific information 

Customs 

 

No 

Node containing a list of Custom nodes. 

StockNbr 

200 

No 

Stock Number. 

PurchaseDt 

10 

No 

Purchase date. If no, purchase date remove field from XML or pass <PurchaseDate xsi:nil="true"/> 

RegistrationTypeCode 

20 

No 

Record level registration type designation. 

RegistrationSourceCode 

20 

No 

Record level registration source designation. 

Work Order Data Schema

Field 

Max Length 

Required

Description 

ClaimNumber 

20 

Yes 

Work order number 

DealerNumber 

20 

Yes 

Manufacturer dealer number.  Used to identify a dealer in the system. 

FailDt 

10 

Yes 

Work order date. 

WorkOrderType 

No 

Type of work order 

CompletedDt 

10 

No 

Completed date. If no, completed date remove field from XML or pass <CompletedDt xsi:nil="true"/> 

Customer Data Schema

Field 

Max Length 

Required 

Description 

CustNumber 

20 

Yes 

 

FirstName 

50 

Yes 

 

LastName 

50 

Yes 

 

Title 

50 

No 

 

Address1 

64 

Yes 

 

Address2 

64 

No 

 

City 

35 

Yes 

 

State 

Yes 

 

PostalCode 

10 

Yes 

 

CompanyYN 

No 

 

CompanyName 

50 

No 

 

CompanyTitle 

50 

No 

 

County 

50 

No 

 

CountryCode 

Yes 

 

HomePhone 

20 

No 

 

MobilePhone 

20 

No 

 

WorkPhone 

20 

No 

 

Fax 

20 

No 

 

Email 

80 

No 

 

LanguageCode 

Yes 

A language code will be flagged as invalid if no survey is setup for the given language code. 

Acceptable language codes: “DC”, “EN”, “FR”, “GR”, “IT”, “JP”, “PO”, “RK”, “SP”, “SW”. 

EmailRefused 

No 

Acceptable values are “True” or “False” 

ExternalId 

50 

No 

ExternalID for Owner 

Product Data Schema

Field 

Max Length 

Required 

Description 

Code 

50 

Yes 

 

ModelYear 

Yes 

 

ModelName 

80 

No 

Human readable product name.  If not supplied this field will be populated with the value of the Code field. 

PlantCode 

No 

 

Brand 

50 

Yes 

 Brand Code of the brand on the product. 

ProductType 

50

No 


Category 

No 

 

Segment 

No 

 

EngineMake1 

50 

No 

Brand of first engine 

EngineModel1 

50 

No 

Model of first engine 

EngineSerialNb1 

50 

No 

Serial Number of first engine 

EngineFuelSystem1 

50 

No 

Fuel system of first engine 

EngineMake2 

50 

No 

Brand of second engine 

EngineModel2 

50 

No 

Model of second engine 

EngineSerialNb2 

50 

No 

Serial Number of second engine 

EngineFuelSystem2 

50 

No 

Fuel system of second engine 

Custom Data Schema

Field 

Max Length 

Required

Description 

FieldName 

50 

Yes 

The field name of the custom field. 

FieldValue 

50 

Yes 

The field value of the custom field. 

Sample Post (XML)

<?xml version="1.0"?>  
<Warranties xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">  
  <Warranty>  
    <SrvyType>1</SrvyType>  
    <IsUsed>0</IsUsed>  
    <SerialNumber>1111111111</SerialNumber>  
    <StockNbr>1111111</StockNbr>  
    <PurchaseDt>2013-06-06</PurchaseDt>  
    <WorkOrder>  
      <ClaimNumber>111111</ClaimNumber>  
      <DealerNumber>RI2</DealerNumber>  
      <FailDt>2013-06-06</FailDt>  
      <WorkOrderType>N</WorkOrderType>  
  <CompletedDt>2013-06-06</CompletedDt>  
    </WorkOrder>  
    <Customer>  
      <CustNumber>1111111</CustNumber>  
      <FirstName>JOHN</FirstName>  
      <LastName>DOE</LastName>  
      <Title />  
      <Address1>123 MAIN STREET</Address1>  
      <Address2 />  
      <City>SAINT LOUIS</City>  
      <State>MO</State>  
      <PostalCode>63005</PostalCode>  
      <County />  
      <CountryCode>US</CountryCode>  
      <CompanyYN>false</CompanyYN>  
      <CompanyName />  
      <CompanyTitle />  
      <HomePhone />  
      <MobilePhone>111-111-1111</MobilePhone>  
      <WorkPhone />  
      <Fax />  
      <Email>JDOE@TEST.COM</Email>  
      <LanguageCode>EN</LanguageCode>  
    </Customer>  
    <Product> 
      <Code>1111111CODE</Code>  
      <ModelYear>2013</ModelYear>  
      <ModelName>1 CODE</ModelName>  
      <PlantCode>AAAA</PlantCode>  
      <Brand>BRAND1</Brand>
      <ProductType>Product Type 1</ProductType>  
      <Category />  
      <Segment />  
      <EngineMake1 />  
      <EngineModel1 />  
      <EngineSerialNbr1 />  
      <EngineFuelSystem1 />  
      <EngineMake2 />  
      <EngineModel2 />  
      <EngineSerialNbr2 />  
      <EngineFuelSystem2 />  
    </Product> 
</Warranty> 
</Warranties> 

Sample Post (JSON)

[
  {
  "SrvyType": "1",
  "IsUsed": "O",
  "SerialNumber": "12386954",
  "StockNbr": "11111",
  "PurchaseDt": "2020-02-22T08:38:54.5525933-05:00",
  "WorkOrder": 
      {
      "ClaimNumber":"11111",
      "DealerNumber":"Default",
      "failDt":"2020-02-23T08:38:54.5525933-05:00",
      "WorkOrderType": "N",
      "CompletedDate": "2020-02-24T08:38:54.5525933-05:00"
    },
  "Customer":
      {
      "CustNumber":"111111",
      "FirstName":"Charlie",
      "LastName":"Foxtrot",
      "Address1":"123 Bravo Street",
      "City": "Fenton",
      "State": "MO",
      "PostalCode": "63126",
      "CountryCode":"US",
      "CompanyYN": 0,
      "MobilePhone":"123-123-1234",
      "Email":"cfoxtrot@test.com",
      "LanguageCode":"EN"
    },
  "Product": 
    {
      "Code":"Product1",
      "ModelYear":"2020",
      "ModelName":"Product1",
      "Brand":"Brand1",
      "ProductType":"ProductType1"
    }
}
]