--- swagger: "2.0" info: x-ibm-name: get-warranty-claim-cps-api title: Get Warranty Claim CPS API version: 1.0.0 description: Get Warranty Claim API is required to build a collaborative system to manage repair authorizations, featuring a mobile iPhone / IPad application for DSPM users that fully integrates with CEC/LCS systems and CPS. The main capabilities of the target system include Creation of a request for Repair Authorization, Review of the Repair Authorization request, Submission of Claims, referencing the authorization, Approval of Claims. termsOfService: Toyota Terms of Service - Legal name: "" schemes: - https basePath: /Warranty/v/warrantyclaim/lookup consumes: - application/json produces: - application/json securityDefinitions: api-key-1: type: apiKey description: "" in: header name: X-IBM-Client-Secret clientIdHeader: type: apiKey in: header name: X-IBM-Client-Id security: - clientIdHeader: [] api-key-1: [] x-ibm-configuration: testable: true enforced: true phase: realized paths: /GetWarrantyClaimDetail: post: responses: 200: description: 200 OK schema: $ref: '#/definitions/GetWarrantyClaimDetailJSONResponse' 401: description: UnAuthorized schema: $ref: '#/definitions/error401' 404: description: No resources Found schema: $ref: '#/definitions/error404' parameters: - name: jsonRequest required: false in: body schema: $ref: '#/definitions/GetWarrantyClaimDetailJSONRequest' /GetWarrantyClaimSummary: post: responses: 200: description: 200 OK schema: $ref: '#/definitions/GetWarrantyClaimSummaryJSONResponse' 401: description: UnAuthorized schema: $ref: '#/definitions/error401' 404: description: No resources Found schema: $ref: '#/definitions/error404' parameters: - name: jsonRequest required: false in: body schema: $ref: '#/definitions/GetWarrantyClaimSummaryJSONRequest' definitions: GetWarrantyClaimDetailJSONRequest: properties: GetWarrantyClaimDetail: type: object properties: WarrantyClaimBOD: type: object properties: ApplicationArea: type: object properties: CreationDateTime: type: string BODID: type: string Sender: type: object properties: UserID: type: string CreatorNameCode: type: string SendorNameCode: type: string Destination: type: object properties: DestinationNameCode: type: string WarrantyClaimDataArea: type: object properties: BusinessContext: type: object properties: TransactionType: type: string Action: type: string WarrantyClaimPayload: type: object properties: WarrantyClaimList: type: object properties: WarrantyClaim: type: array items: type: object properties: CPSClaimNumber: type: string ServicingDealer: type: object properties: PartnerCode: type: string RepairInfo: type: string LastUpdatedDateTime: type: string example: GetWarrantyClaimDetail: WarrantyClaimBOD: ApplicationArea: CreationDateTime: "2001-12-17T09:30:47Z" BODID: be45d42b-a4f9-357e-9a88-fcc11c0c88c8 Sender: UserID: "12315" CreatorNameCode: "12315" SendorNameCode: DSPMMobile Destination: DestinationNameCode: CPS WarrantyClaimDataArea: BusinessContext: TransactionType: SYNC Action: GetWarrantyClaimDetail WarrantyClaimPayload: WarrantyClaimList: WarrantyClaim: - CPSClaimNumber: aaaaaaaaaa ServicingDealer: PartnerCode: "12345" RepairInfo: "" LastUpdatedDateTime: "2013-04-12T04:24:56Z" - CPSClaimNumber: aaaaaaaaaa ServicingDealer: PartnerCode: "12345" RepairInfo: "" LastUpdatedDateTime: "2013-04-12T04:24:56Z" GetWarrantyClaimSummaryJSONRequest: properties: GetWarrantyClaimSummary: type: object properties: WarrantyClaimBOD: type: object properties: ApplicationArea: type: object properties: CreationDateTime: type: string BODID: type: string Sender: type: object properties: UserID: type: string CreatorNameCode: type: string SendorNameCode: type: string Destination: type: object properties: DestinationNameCode: type: string WarrantyClaimDataArea: type: object properties: BusinessContext: type: object properties: TransactionType: type: string Action: type: string WarrantyClaimPayload: type: object properties: WarrantyClaimLookup: type: object properties: SearchCriteria: type: array items: type: object properties: CriteriaName: type: string CriteriaValue: type: string example: GetWarrantyClaimSummary: WarrantyClaimBOD: ApplicationArea: CreationDateTime: "2001-12-17T09:30:47Z" BODID: be45d42b-a4f9-357e-9a88-fcc11c0c88c8 Sender: UserID: "12315" CreatorNameCode: "12315" SendorNameCode: DSPMMobile Destination: DestinationNameCode: CPS WarrantyClaimDataArea: BusinessContext: TransactionType: SYNC Action: GetRepairAuthorizationSummary WarrantyClaimPayload: WarrantyClaimLookup: SearchCriteria: - CriteriaName: VIN CriteriaValue: 4T1BD1FK4DU082644 - CriteriaName: ClaimStatus CriteriaValue: Pending GetWarrantyClaimDetailJSONResponse: properties: ShowWarrantyClaimDetail: type: object properties: WarrantyClaimBOD: type: object properties: ApplicationArea: type: object properties: CreationDateTime: type: string BODID: type: string Sender: type: object properties: ReferenceID: type: string UserID: type: string CreatorNameCode: type: string SendorNameCode: type: string Destination: type: object properties: DestinationNameCode: type: string WarrantyClaimDataArea: type: object properties: BusinessContext: type: object properties: TransactionType: type: string Action: type: string ExtendedStatus: type: object properties: StatusCode: type: string WarrantyClaimPayload: type: object properties: WarrantyClaimList: type: object properties: WarrantyClaim: type: array items: type: object properties: TransactionId: type: string ClaimType: type: string CPSClaimNumber: type: string Claimant: type: object properties: PartnerCode: type: string PartnerName: type: string ServicingDealer: type: object properties: PartnerCode: type: string PartnerName: type: string ExternalReferenceNumber: type: string SubmittedBy: type: string SubmitDate: type: string CustomerName: type: string TechNumber: type: string ServiceAdvisorNumber: type: string Preferences: type: object properties: Currency: type: string LanguagePreference: type: string RepairInfo: type: object properties: BasicRepairInfo: type: object properties: VIN: type: string DOFU: type: string DOFUMiles: type: string RepairOrderNum: type: string RepairDate: type: string RepairMiles: type: string OriginalFailedPartNum: type: string ServicePartIndicator: type: string T1Code: type: string T2Code: type: string Condition: type: string Cause: type: string Remedy: type: string OdometerUnits: type: string MonthsInUse: type: string MilesInUse: type: string OriginalRONum: type: string OriginalRepairDate: type: string OriginalRepairMiles: type: string ModelYear: type: string ModelName: type: string AdditonalRepairInfo: type: object properties: PartBackOrder: type: object properties: BackOrderDate: type: string BackOrderMiles: type: string BackOrderNum: type: string Transmission: type: object properties: SerialNumber: type: string EngineIdlingInDrivePosition: type: string EngineIdlingInReversePosition: type: string StallInDrivePosition: type: string StallInReversePosition: type: string ACCompressorSerialNum: type: string RepairAuthNum: type: string CellPhoneExchangeElectronicSerialNum: type: string BatteryTesterCode: type: string NonWarrantyLeaseRepairIndicator: type: string DiagnosticLaborTroubleCodes: type: object properties: DiagnosticLaborTroubleCode: type: array items: type: string EmployeeInformation: type: object properties: LastName: type: string FirstName: type: string Company: type: string Division: type: string OTCRepairInfo: type: object properties: Invoice: type: object properties: InvoiceNumber: type: string InvoiceDate: type: string OriginalInvoice: type: object properties: InvoiceNumber: type: string InvoiceDate: type: string RepairProgramInfo: type: object properties: RepairProgramNum: type: string RepairProgramType: type: string ServiceProgramInfo: type: object properties: SalvageReason: type: string TireInfo: type: array items: type: object properties: TirePosition: type: string DOTSerialNum: type: string Brand: type: string TreadDepthOutside: type: string TreadDepthCenter: type: string TreadDepthInside: type: string ConditionCode: type: string ReplacedTireBrand: type: string ReplacedTireSerialNum: type: string T3Codes: type: object properties: PositionCode: type: array items: type: string Labor: type: object properties: MainOperation: type: object properties: Opcode: type: string OperationDescription: type: string VariedWorkCode: type: string LaborHours: type: string LaborAmount: type: string ComboCodes: type: array items: type: object properties: ComboCode: type: string LaborHrs: type: string SubOperations: type: array items: type: object properties: Opcode: type: string OperationDescription: type: string VariedWorkCode: type: string LaborHours: type: string LaborAmount: type: string ComboCodes: type: array items: type: object properties: ComboCode: type: string LaborHrs: type: string Zhrs: type: string TotalLaborHours: type: string LaborRate: type: string TotalAmount: type: string TotalRequestAmount: type: string TotalAcceptedAmount: type: string Sublets: type: object properties: Sublet: type: array items: type: object properties: SubletType: type: string SubletDescription: type: string SubletAmount: type: string ProviderName: type: string InvoiceNum: type: string Description: type: string RentalInformation: type: object properties: Days: type: string DailyRate: type: string ReasonCode: type: string RentalVIN: type: string Comment: type: string LodgingInformation: type: object properties: Days: type: string DailyRate: type: string TotalAmount: type: string TotalRequestedAmount: type: string TotalAcceptedAmount: type: string Fees: type: object properties: Fee: type: array items: type: object properties: Type: type: string Amount: type: string InvoiceNum: type: string ProviderName: type: string TowMiles: type: string TotalAmount: type: string TotalRequestedAmount: type: string TotalAcceptedAmount: type: string ReplacementParts: type: object properties: ReplacementPart: type: array items: type: object properties: PartNum: type: string PartDescription: type: string PartQuantity: type: string UnitCost: type: string CoreAmt: type: string ExtendedCost: type: string PartMarkUpPercentage: type: string TotalAmount: type: string TotalRequestedAmount: type: string TotalAcceptedAmount: type: string AuthorizationInfo: type: object properties: AuthorizationType: type: string AuthorizationNo: type: string CustomerRelationsCaseNum: type: string ArbitrationCaseNo: type: string TechnicalAssistanceCaseNum: type: string LegalCaseNo: type: string GoodWillFlag: type: string GoodWillComments: type: string LaborParticipation: type: object properties: DealerParticipationPct: type: string CustomerParticipationPct: type: string PartsAndMarkupParticipation: type: object properties: DealerParticipationPct: type: string CustomerParticipationPct: type: string SubletParticipation: type: object properties: DealerParticipationPct: type: string CustomerParticipationPct: type: string FeeParticipation: type: object properties: DealerParticipationPct: type: string CustomerParticipationPct: type: string Comments: type: array items: type: object properties: Comment: type: string Author: type: string Date: type: string ClaimJudgment: type: object properties: Status: type: string Errors: type: array items: type: object properties: ErrorType: type: string Message: type: string Conditions: type: array items: type: object properties: Status: type: string ConditionCode: type: string ConditionDescription: type: string ConditionComment: type: string ReturnReason: type: string Amounts: type: object properties: ClaimTotalAmount: type: string DifferencePct: type: string ClaimRequestedAmount: type: string ClaimAcceptedAmount: type: string StateTaxDue: type: string IsAttachmentPending: type: string ExistingClaimAttachmentNumbers: type: array items: type: string ClaimAttachmentList: type: object properties: ClaimAttachment: type: array items: type: object properties: FileName: type: string FileFormat: type: string FileData: type: string AttachmentId: type: string LastUpdatedDateTime: type: string RepairAuthorization: type: object properties: AuthorizationType: type: string AuthorizationNo: type: string CustomerRelationsCaseNum: type: string AuthorizationOwner: type: object properties: PartyID: type: string AsssignedGroup: type: string CustomerUser: type: object properties: SpecifiedPerson: type: object properties: Name: type: object properties: FirstName: type: string LastName: type: string AuthorizationStatusCode: type: string AuthorizationReasonCode: type: string DispositionNotes: type: string JustificationDetails: type: string VehicleDetails: type: object properties: VIN: type: string DOFU: type: string RepairOrderNum: type: string Condition: type: string Cause: type: string Remedy: type: string MonthsInUse: type: string MilesInUse: type: string ModelYear: type: string ModelName: type: string DealerUser: type: object properties: SpecifiedPerson: type: object properties: Name: type: object properties: FirstName: type: string LastName: type: string TelephoneCommunication: type: object properties: ChannelCode: type: string CompleteNumber: type: string URICommunication: type: object properties: ChannelCode: type: string CompleteNumber: type: string DealerCode: type: string RepairAmountList: type: object properties: RepairAmount: type: array items: type: object properties: AmountType: type: string AuthorizationType: type: string TotalClassPrice: type: object properties: PriceCode: type: string ChargeAmount: type: object properties: currencyID: type: string Value: type: string DifferencePct: type: string RepairAmountClassList: type: object properties: ClassPrice: type: array items: type: object properties: PriceCode: type: string ChargeAmount: type: object properties: currencyID: type: string Value: type: string DifferencePct: type: string HasCustomerContactedTMS: type: string AuthorizationPreferenceList: type: object properties: AuthorizationPreference: type: array items: type: object properties: PreferenceType: type: string PreferenceValue: type: string ValidTillDateTime: type: string ValidityPeriod: type: string AdditionalComments: type: string AuthorizationHistoryList: type: object properties: AuthorizationHistory: type: array items: type: object properties: AuthorizationType: type: string AuthorizationOwner: type: object properties: PartyID: type: string SpecifiedPerson: type: object properties: Name: type: object properties: PreferredName: type: string Role: type: string AuthorizationStatusCode: type: string AuthorizationDateTime: type: string AuthorizationReasonCode: type: string DispositionNotes: type: string JustificationDetails: type: string RoutingDetailsList: type: object properties: RoutingDetails: type: array items: type: object properties: FromUser: type: object properties: PartyID: type: string AsssignedGroup: type: string ToUser: type: object properties: PartyID: type: string AsssignedGroup: type: string AuthorizationAttachmentList: type: object properties: AuthorizationAttachment: type: array items: type: object properties: FileName: type: string FileFormat: type: string FileData: type: string AttachmentId: type: string LastUpdatedDateTime: type: string example: ShowWarrantyClaimDetail: WarrantyClaimBOD: ApplicationArea: CreationDateTime: "2001-12-17T09:30:47Z" BODID: af45d42b-a4f9-357e-9a88-fcc11c0c88c8 Sender: ReferenceID: be45d42b-a4f9-357e-9a88-fcc11c0c88c8 UserID: "12315" CreatorNameCode: "12315" SendorNameCode: DSPMMobile Destination: DestinationNameCode: CPS WarrantyClaimDataArea: BusinessContext: TransactionType: SYNC Action: GetWarrantyClaimDetail ExtendedStatus: StatusCode: SUCCESS WarrantyClaimPayload: WarrantyClaimList: WarrantyClaim: - TransactionId: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ClaimType: Pre-Delivery Service CPSClaimNumber: aaaaaaaaaa Claimant: PartnerCode: "32106" PartnerName: South Bay Toyota ServicingDealer: PartnerCode: "32106" PartnerName: South Bay Toyota ExternalReferenceNumber: aaaaaaaaaa SubmittedBy: CPS SubmitDate: "2012-06-25T11:40:56.909125-04:00" CustomerName: OLGA DUKES TechNumber: "249 " ServiceAdvisorNumber: "339 " Preferences: Currency: PASO LanguagePreference: ENGLISH RepairInfo: BasicRepairInfo: VIN: 1NXBR32E95Z398118 DOFU: "1967-08-13" DOFUMiles: "0" RepairOrderNum: "595795" RepairDate: "1967-08-13" RepairMiles: "0" OriginalFailedPartNum: aaaaaaaaaaaaaaa ServicePartIndicator: "true" T1Code: aa T2Code: aa Condition: A0J RECALL SOP IN Cause: A0J RECALL Remedy: REPLACED COMPUTER AS PER RECALL 0519H2 0.7 OdometerUnits: Miles MonthsInUse: "0" MilesInUse: "0" OriginalRONum: aaaaaaa OriginalRepairDate: "1967-08-13" OriginalRepairMiles: "0" ModelYear: "2013" ModelName: PRIUS AdditonalRepairInfo: PartBackOrder: BackOrderDate: "1967-08-13" BackOrderMiles: "0" BackOrderNum: String Transmission: SerialNumber: String EngineIdlingInDrivePosition: String EngineIdlingInReversePosition: String StallInDrivePosition: String StallInReversePosition: String ACCompressorSerialNum: String RepairAuthNum: String CellPhoneExchangeElectronicSerialNum: String BatteryTesterCode: String NonWarrantyLeaseRepairIndicator: "true" DiagnosticLaborTroubleCodes: DiagnosticLaborTroubleCode: - String - String EmployeeInformation: LastName: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa FirstName: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Company: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Division: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa OTCRepairInfo: Invoice: InvoiceNumber: String InvoiceDate: "1967-08-13" OriginalInvoice: InvoiceNumber: String InvoiceDate: "1967-08-13" RepairProgramInfo: RepairProgramNum: aaaaaaaaaaaaaaaaaaaa RepairProgramType: String ServiceProgramInfo: SalvageReason: String TireInfo: - TirePosition: String DOTSerialNum: String Brand: String TreadDepthOutside: String TreadDepthCenter: String TreadDepthInside: String ConditionCode: String ReplacedTireBrand: String ReplacedTireSerialNum: String - TirePosition: String DOTSerialNum: String Brand: String TreadDepthOutside: String TreadDepthCenter: String TreadDepthInside: String ConditionCode: String ReplacedTireBrand: String ReplacedTireSerialNum: String T3Codes: PositionCode: - aaaa - aaaa Labor: MainOperation: Opcode: aaaaaa OperationDescription: String VariedWorkCode: a LaborHours: "12345.78" LaborAmount: "2340.50" ComboCodes: - ComboCode: a LaborHrs: "12345.78" - ComboCode: a LaborHrs: "12345.78" SubOperations: - Opcode: aaaaaa OperationDescription: String VariedWorkCode: a LaborHours: "12345.78" LaborAmount: "2340.50" ComboCodes: - ComboCode: a LaborHrs: "12345.78" - ComboCode: a LaborHrs: "12345.78" - Opcode: aaaaaa OperationDescription: String VariedWorkCode: a LaborHours: "12345.78" LaborAmount: "2340.50" ComboCodes: - ComboCode: a LaborHrs: "12345.78" - ComboCode: a LaborHrs: "12345.78" Zhrs: "12345.78" TotalLaborHours: "12345.78" LaborRate: "12345.78" TotalAmount: "12345.78" TotalRequestAmount: "12345.78" TotalAcceptedAmount: "12345.78" Sublets: Sublet: - SubletType: aa SubletDescription: String SubletAmount: "12345.78" ProviderName: String InvoiceNum: String Description: String RentalInformation: Days: "0" DailyRate: "12345.78" ReasonCode: String RentalVIN: aaaaaaaaaaaa Comment: String LodgingInformation: Days: "0" DailyRate: "12345.78" - SubletType: aa SubletDescription: String SubletAmount: "12345.78" ProviderName: String InvoiceNum: String Description: String RentalInformation: Days: "0" DailyRate: "12345.78" ReasonCode: String RentalVIN: aaaaaaaaaaaa Comment: String LodgingInformation: Days: "0" DailyRate: "12345.78" TotalAmount: "12345.78" TotalRequestedAmount: "12345.78" TotalAcceptedAmount: "12345.78" Fees: Fee: - Type: String Amount: "12345.78" InvoiceNum: String ProviderName: String TowMiles: "0" - Type: String Amount: "12345.78" InvoiceNum: String ProviderName: String TowMiles: "0" TotalAmount: "12345.78" TotalRequestedAmount: "12345.78" TotalAcceptedAmount: "12345.78" ReplacementParts: ReplacementPart: - PartNum: aaaaaaaaaaaaaaa PartDescription: String PartQuantity: "0" UnitCost: "12345.78" CoreAmt: "12345.78" ExtendedCost: "12345.78" - PartNum: aaaaaaaaaaaaaaa PartDescription: String PartQuantity: "0" UnitCost: "12345.78" CoreAmt: "12345.78" ExtendedCost: "12345.78" PartMarkUpPercentage: "0" TotalAmount: "12345.78" TotalRequestedAmount: "12345.78" TotalAcceptedAmount: "12345.78" AuthorizationInfo: AuthorizationType: DSPM AuthorizationNo: "123456" CustomerRelationsCaseNum: "1308091111" ArbitrationCaseNo: ABC123344 TechnicalAssistanceCaseNum: String LegalCaseNo: String GoodWillFlag: "true" GoodWillComments: Long time customer LaborParticipation: DealerParticipationPct: "20" CustomerParticipationPct: "20" PartsAndMarkupParticipation: DealerParticipationPct: "20" CustomerParticipationPct: "20" SubletParticipation: DealerParticipationPct: "20" CustomerParticipationPct: "20" FeeParticipation: DealerParticipationPct: "20" CustomerParticipationPct: "20" Comments: - Comment: String Author: String Date: "1967-08-13" - Comment: String Author: String Date: "1967-08-13" ClaimJudgment: Status: Pending Review Errors: - ErrorType: INTEGRATION-ERROR Message: String - ErrorType: BUSINESS-WARNING Message: String Conditions: - Status: String ConditionCode: String ConditionDescription: String ConditionComment: String ReturnReason: String - Status: String ConditionCode: String ConditionDescription: String ConditionComment: String ReturnReason: String Amounts: ClaimTotalAmount: "12345.78" DifferencePct: "0" ClaimRequestedAmount: "12345.78" ClaimAcceptedAmount: "12345.78" StateTaxDue: "12345.78" IsAttachmentPending: String ExistingClaimAttachmentNumbers: - String - String ClaimAttachmentList: ClaimAttachment: - FileName: mycar.png FileFormat: image/png FileData: UjBsR09EbGhjZ0dTQUxNQUFBUUNBRU1tQ1p0dU1GUXhEUzhi AttachmentId: abcdefghij - FileName: mycar.png FileFormat: image/png FileData: UjBsR09EbGhjZ0dTQUxNQUFBUUNBRU1tQ1p0dU1GUXhEUzhi AttachmentId: abcdefghij LastUpdatedDateTime: "2013-04-12T04:24:56Z" RepairAuthorization: AuthorizationType: "" AuthorizationNo: AuthNO CustomerRelationsCaseNum: "1308091111" AuthorizationOwner: PartyID: "123456" AsssignedGroup: Warranty CustomerUser: SpecifiedPerson: Name: FirstName: customer first name LastName: customer last name AuthorizationStatusCode: Active AuthorizationReasonCode: asasdasdas DispositionNotes: aaa JustificationDetails: aaaa VehicleDetails: VIN: 4T1BD1FK4DU082644 DOFU: "1967-08-13" RepairOrderNum: abcdefg Condition: Noise over bumps Cause: Repair as per TSB SU002-99 Remedy: R/R/ suspension supports RH & LH MonthsInUse: "0" MilesInUse: "0" ModelYear: "2012" ModelName: Prius DealerUser: SpecifiedPerson: Name: FirstName: dealer first name LastName: dealer last name TelephoneCommunication: ChannelCode: Mobile CompleteNumber: 123-456-7890 URICommunication: ChannelCode: Email CompleteNumber: abc@xyz.com DealerCode: "33600" RepairAmountList: RepairAmount: - AmountType: Estimated AuthorizationType: DSPM TotalClassPrice: PriceCode: Total ChargeAmount: currencyID: USD Value: "123456.78" DifferencePct: "20" RepairAmountClassList: ClassPrice: - PriceCode: Labor ChargeAmount: currencyID: USD Value: "1234.56" DifferencePct: "20" - PriceCode: Parts ChargeAmount: currencyID: USD Value: "1234.56" DifferencePct: "20" - "" HasCustomerContactedTMS: "true" AuthorizationPreferenceList: AuthorizationPreference: - PreferenceType: ClaimReviewPreference PreferenceValue: Conditional - PreferenceType: RAUpgradePreference PreferenceValue: DSPM Only ValidTillDateTime: "2014-08-13T00:00:00Z" ValidityPeriod: 7 Days AdditionalComments: additional details for the RA AuthorizationHistoryList: AuthorizationHistory: - AuthorizationType: "" AuthorizationOwner: PartyID: "123455" SpecifiedPerson: Name: PreferredName: John Smith Role: WarrantyAdmin AuthorizationStatusCode: Pending AuthorizationDateTime: "2013-08-13T00:00:00Z" AuthorizationReasonCode: Good Service History DispositionNotes: some comments go here JustificationDetails: some comments go here - AuthorizationType: "" RoutingDetailsList: RoutingDetails: - FromUser: PartyID: "345678" AsssignedGroup: Warranty ToUser: PartyID: "345679" AsssignedGroup: CRDept - FromUser: PartyID: "345679" AsssignedGroup: CRDept ToUser: PartyID: "345680" AsssignedGroup: Warranty AuthorizationAttachmentList: AuthorizationAttachment: - FileName: mycar.png FileFormat: image/png FileData: UjBsR09EbGhjZ0dTQUxNQUFBUUNBRU1tQ1p0dU1GUXhEUzhi AttachmentId: abcdefghij - FileName: mycar.png FileFormat: image/png FileData: UjBsR09EbGhjZ0dTQUxNQUFBUUNBRU1tQ1p0dU1GUXhEUzhi AttachmentId: abcdefghij LastUpdatedDateTime: "2013-04-12T04:24:56Z" - TransactionId: "" ClaimType: Paint Claimant: PartnerCode: "12345" ServicingDealer: PartnerCode: "12345" SubmitDate: "2012-06-25T11:40:56.909125-04:00" RepairInfo: BasicRepairInfo: "" GetWarrantyClaimSummaryJSONResponse: properties: ShowWarrantyClaimSummary: type: object properties: WarrantyClaimBOD: type: object properties: ApplicationArea: type: object properties: CreationDateTime: type: string BODID: type: string Sender: type: object properties: ReferenceID: type: string UserID: type: string CreatorNameCode: type: string SendorNameCode: type: string Destination: type: object properties: DestinationNameCode: type: string WarrantyClaimDataArea: type: object properties: BusinessContext: type: object properties: TransactionType: type: string Action: type: string ExtendedStatus: type: object properties: StatusCode: type: string WarrantyClaimPayload: type: object properties: WarrantyClaimList: type: object properties: WarrantyClaim: type: array items: type: object properties: TransactionId: type: string ClaimType: type: string CPSClaimNumber: type: string Claimant: type: object properties: PartnerCode: type: string PartnerName: type: string ServicingDealer: type: object properties: PartnerCode: type: string PartnerName: type: string ExternalReferenceNumber: type: string SubmittedBy: type: string SubmitDate: type: string CustomerName: type: string TechNumber: type: string ServiceAdvisorNumber: type: string Preferences: type: object properties: Currency: type: string LanguagePreference: type: string RepairInfo: type: object properties: BasicRepairInfo: type: object properties: VIN: type: string DOFU: type: string DOFUMiles: type: string RepairOrderNum: type: string RepairDate: type: string RepairMiles: type: string OriginalFailedPartNum: type: string ServicePartIndicator: type: string T1Code: type: string T2Code: type: string Condition: type: string Cause: type: string Remedy: type: string OdometerUnits: type: string MonthsInUse: type: string MilesInUse: type: string OriginalRONum: type: string OriginalRepairDate: type: string OriginalRepairMiles: type: string ModelYear: type: string ModelName: type: string AdditonalRepairInfo: type: object properties: PartBackOrder: type: object properties: BackOrderDate: type: string BackOrderMiles: type: string BackOrderNum: type: string Transmission: type: object properties: SerialNumber: type: string EngineIdlingInDrivePosition: type: string EngineIdlingInReversePosition: type: string StallInDrivePosition: type: string StallInReversePosition: type: string ACCompressorSerialNum: type: string RepairAuthNum: type: string CellPhoneExchangeElectronicSerialNum: type: string BatteryTesterCode: type: string NonWarrantyLeaseRepairIndicator: type: string DiagnosticLaborTroubleCodes: type: object properties: DiagnosticLaborTroubleCode: type: array items: type: string EmployeeInformation: type: object properties: LastName: type: string FirstName: type: string Company: type: string Division: type: string OTCRepairInfo: type: object properties: Invoice: type: object properties: InvoiceNumber: type: string InvoiceDate: type: string OriginalInvoice: type: object properties: InvoiceNumber: type: string InvoiceDate: type: string RepairProgramInfo: type: object properties: RepairProgramNum: type: string RepairProgramType: type: string ServiceProgramInfo: type: object properties: SalvageReason: type: string TireInfo: type: array items: type: object properties: TirePosition: type: string DOTSerialNum: type: string Brand: type: string TreadDepthOutside: type: string TreadDepthCenter: type: string TreadDepthInside: type: string ConditionCode: type: string ReplacedTireBrand: type: string ReplacedTireSerialNum: type: string T3Codes: type: object properties: PositionCode: type: array items: type: string Labor: type: object properties: MainOperation: type: object properties: Opcode: type: string OperationDescription: type: string VariedWorkCode: type: string LaborHours: type: string LaborAmount: type: string ComboCodes: type: array items: type: object properties: ComboCode: type: string LaborHrs: type: string SubOperations: type: array items: type: object properties: Opcode: type: string OperationDescription: type: string VariedWorkCode: type: string LaborHours: type: string LaborAmount: type: string ComboCodes: type: array items: type: object properties: ComboCode: type: string LaborHrs: type: string Zhrs: type: string TotalLaborHours: type: string LaborRate: type: string TotalAmount: type: string TotalRequestAmount: type: string TotalAcceptedAmount: type: string Sublets: type: object properties: Sublet: type: array items: type: object properties: SubletType: type: string SubletDescription: type: string SubletAmount: type: string ProviderName: type: string InvoiceNum: type: string Description: type: string RentalInformation: type: object properties: Days: type: string DailyRate: type: string ReasonCode: type: string RentalVIN: type: string Comment: type: string LodgingInformation: type: object properties: Days: type: string DailyRate: type: string TotalAmount: type: string TotalRequestedAmount: type: string TotalAcceptedAmount: type: string Fees: type: object properties: Fee: type: array items: type: object properties: Type: type: string Amount: type: string InvoiceNum: type: string ProviderName: type: string TowMiles: type: string TotalAmount: type: string TotalRequestedAmount: type: string TotalAcceptedAmount: type: string ReplacementParts: type: object properties: ReplacementPart: type: array items: type: object properties: PartNum: type: string PartDescription: type: string PartQuantity: type: string UnitCost: type: string CoreAmt: type: string ExtendedCost: type: string PartMarkUpPercentage: type: string TotalAmount: type: string TotalRequestedAmount: type: string TotalAcceptedAmount: type: string AuthorizationInfo: type: object properties: AuthorizationType: type: string AuthorizationNo: type: string CustomerRelationsCaseNum: type: string ArbitrationCaseNo: type: string TechnicalAssistanceCaseNum: type: string LegalCaseNo: type: string GoodWillFlag: type: string GoodWillComments: type: string LaborParticipation: type: object properties: DealerParticipationPct: type: string CustomerParticipationPct: type: string PartsAndMarkupParticipation: type: object properties: DealerParticipationPct: type: string CustomerParticipationPct: type: string SubletParticipation: type: object properties: DealerParticipationPct: type: string CustomerParticipationPct: type: string FeeParticipation: type: object properties: DealerParticipationPct: type: string CustomerParticipationPct: type: string Comments: type: array items: type: object properties: Comment: type: string Author: type: string Date: type: string ClaimJudgment: type: object properties: Status: type: string Errors: type: array items: type: object properties: ErrorType: type: string Message: type: string Conditions: type: array items: type: object properties: Status: type: string ConditionCode: type: string ConditionDescription: type: string ConditionComment: type: string ReturnReason: type: string Amounts: type: object properties: ClaimTotalAmount: type: string DifferencePct: type: string ClaimRequestedAmount: type: string ClaimAcceptedAmount: type: string StateTaxDue: type: string IsAttachmentPending: type: string ExistingClaimAttachmentNumbers: type: array items: type: string ClaimAttachmentList: type: object properties: ClaimAttachment: type: array items: type: object properties: FileName: type: string FileFormat: type: string FileData: type: string AttachmentId: type: string LastUpdatedDateTime: type: string RepairAuthorization: type: object properties: AuthorizationType: type: string AuthorizationNo: type: string CustomerRelationsCaseNum: type: string AuthorizationOwner: type: object properties: PartyID: type: string AsssignedGroup: type: string CustomerUser: type: object properties: SpecifiedPerson: type: object properties: Name: type: object properties: FirstName: type: string LastName: type: string AuthorizationStatusCode: type: string AuthorizationReasonCode: type: string DispositionNotes: type: string JustificationDetails: type: string VehicleDetails: type: object properties: VIN: type: string DOFU: type: string RepairOrderNum: type: string Condition: type: string Cause: type: string Remedy: type: string MonthsInUse: type: string MilesInUse: type: string ModelYear: type: string ModelName: type: string DealerUser: type: object properties: SpecifiedPerson: type: object properties: Name: type: object properties: FirstName: type: string LastName: type: string TelephoneCommunication: type: object properties: ChannelCode: type: string CompleteNumber: type: string URICommunication: type: object properties: ChannelCode: type: string CompleteNumber: type: string DealerCode: type: string RepairAmountList: type: object properties: RepairAmount: type: array items: type: object properties: AmountType: type: string AuthorizationType: type: string TotalClassPrice: type: object properties: PriceCode: type: string ChargeAmount: type: object properties: currencyID: type: string Value: type: string DifferencePct: type: string RepairAmountClassList: type: object properties: ClassPrice: type: array items: type: object properties: PriceCode: type: string ChargeAmount: type: object properties: currencyID: type: string Value: type: string DifferencePct: type: string HasCustomerContactedTMS: type: string AuthorizationPreferenceList: type: object properties: AuthorizationPreference: type: array items: type: object properties: PreferenceType: type: string PreferenceValue: type: string ValidTillDateTime: type: string ValidityPeriod: type: string AdditionalComments: type: string AuthorizationHistoryList: type: object properties: AuthorizationHistory: type: array items: type: object properties: AuthorizationType: type: string AuthorizationOwner: type: object properties: PartyID: type: string SpecifiedPerson: type: object properties: Name: type: object properties: PreferredName: type: string Role: type: string AuthorizationStatusCode: type: string AuthorizationDateTime: type: string AuthorizationReasonCode: type: string DispositionNotes: type: string JustificationDetails: type: string RoutingDetailsList: type: object properties: RoutingDetails: type: array items: type: object properties: FromUser: type: object properties: PartyID: type: string AsssignedGroup: type: string ToUser: type: object properties: PartyID: type: string AsssignedGroup: type: string AuthorizationAttachmentList: type: object properties: AuthorizationAttachment: type: array items: type: object properties: FileName: type: string FileFormat: type: string FileData: type: string AttachmentId: type: string LastUpdatedDateTime: type: string example: ShowWarrantyClaimSummary: WarrantyClaimBOD: ApplicationArea: CreationDateTime: "2001-12-17T09:30:47Z" BODID: af45d42b-a4f9-357e-9a88-fcc11c0c88c8 Sender: ReferenceID: be45d42b-a4f9-357e-9a88-fcc11c0c88c8 UserID: "12315" CreatorNameCode: "12315" SendorNameCode: DSPMMobile Destination: DestinationNameCode: CPS WarrantyClaimDataArea: BusinessContext: TransactionType: SYNC Action: GetWarrantyClaimSummary ExtendedStatus: StatusCode: SUCCESS WarrantyClaimPayload: WarrantyClaimList: WarrantyClaim: - TransactionId: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ClaimType: Pre-Delivery Service CPSClaimNumber: aaaaaaaaaa Claimant: PartnerCode: "32106" PartnerName: South Bay Toyota ServicingDealer: PartnerCode: "32106" PartnerName: South Bay Toyota ExternalReferenceNumber: aaaaaaaaaa SubmittedBy: CPS SubmitDate: "2012-06-25T11:40:56.909125-04:00" CustomerName: OLGA DUKES TechNumber: "249 " ServiceAdvisorNumber: "339 " Preferences: Currency: PASO LanguagePreference: ENGLISH RepairInfo: BasicRepairInfo: VIN: 1NXBR32E95Z398118 DOFU: "1967-08-13" DOFUMiles: "0" RepairOrderNum: "595795" RepairDate: "1967-08-13" RepairMiles: "0" OriginalFailedPartNum: aaaaaaaaaaaaaaa ServicePartIndicator: "true" T1Code: aa T2Code: aa Condition: A0J RECALL SOP IN Cause: A0J RECALL Remedy: REPLACED COMPUTER AS PER RECALL 0519H2 0.7 OdometerUnits: Miles MonthsInUse: "0" MilesInUse: "0" OriginalRONum: aaaaaaa OriginalRepairDate: "1967-08-13" OriginalRepairMiles: "0" ModelYear: "2013" ModelName: PRIUS AdditonalRepairInfo: PartBackOrder: BackOrderDate: "1967-08-13" BackOrderMiles: "0" BackOrderNum: String Transmission: SerialNumber: String EngineIdlingInDrivePosition: String EngineIdlingInReversePosition: String StallInDrivePosition: String StallInReversePosition: String ACCompressorSerialNum: String RepairAuthNum: String CellPhoneExchangeElectronicSerialNum: String BatteryTesterCode: String NonWarrantyLeaseRepairIndicator: "true" DiagnosticLaborTroubleCodes: DiagnosticLaborTroubleCode: - String - String EmployeeInformation: LastName: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa FirstName: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Company: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Division: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa OTCRepairInfo: Invoice: InvoiceNumber: String InvoiceDate: "1967-08-13" OriginalInvoice: InvoiceNumber: String InvoiceDate: "1967-08-13" RepairProgramInfo: RepairProgramNum: aaaaaaaaaaaaaaaaaaaa RepairProgramType: String ServiceProgramInfo: SalvageReason: String TireInfo: - TirePosition: String DOTSerialNum: String Brand: String TreadDepthOutside: String TreadDepthCenter: String TreadDepthInside: String ConditionCode: String ReplacedTireBrand: String ReplacedTireSerialNum: String - TirePosition: String DOTSerialNum: String Brand: String TreadDepthOutside: String TreadDepthCenter: String TreadDepthInside: String ConditionCode: String ReplacedTireBrand: String ReplacedTireSerialNum: String T3Codes: PositionCode: - aaaa - aaaa Labor: MainOperation: Opcode: aaaaaa OperationDescription: String VariedWorkCode: a LaborHours: "12345.78" LaborAmount: 3.14159265358979E0 ComboCodes: - ComboCode: a LaborHrs: "12345.78" - ComboCode: a LaborHrs: "12345.78" SubOperations: - Opcode: aaaaaa OperationDescription: String VariedWorkCode: a LaborHours: "12345.78" LaborAmount: 3.14159265358979E0 ComboCodes: - ComboCode: a LaborHrs: "12345.78" - ComboCode: a LaborHrs: "12345.78" - Opcode: aaaaaa OperationDescription: String VariedWorkCode: a LaborHours: "12345.78" LaborAmount: 3.14159265358979E0 ComboCodes: - ComboCode: a LaborHrs: "12345.78" - ComboCode: a LaborHrs: "12345.78" Zhrs: "12345.78" TotalLaborHours: "12345.78" LaborRate: "12345.78" TotalAmount: "12345.78" TotalRequestAmount: "12345.78" TotalAcceptedAmount: "12345.78" Sublets: Sublet: - SubletType: aa SubletDescription: String SubletAmount: "12345.78" ProviderName: String InvoiceNum: String Description: String RentalInformation: Days: "0" DailyRate: "12345.78" ReasonCode: String RentalVIN: aaaaaaaaaaaa Comment: String LodgingInformation: Days: "0" DailyRate: "12345.78" - SubletType: aa SubletDescription: String SubletAmount: "12345.78" ProviderName: String InvoiceNum: String Description: String RentalInformation: Days: "0" DailyRate: "12345.78" ReasonCode: String RentalVIN: aaaaaaaaaaaa Comment: String LodgingInformation: Days: "0" DailyRate: "12345.78" TotalAmount: "12345.78" TotalRequestedAmount: "12345.78" TotalAcceptedAmount: "12345.78" Fees: Fee: - Type: String Amount: "12345.78" InvoiceNum: String ProviderName: String TowMiles: "0" - Type: String Amount: "12345.78" InvoiceNum: String ProviderName: String TowMiles: "0" TotalAmount: "12345.78" TotalRequestedAmount: "12345.78" TotalAcceptedAmount: "12345.78" ReplacementParts: ReplacementPart: - PartNum: aaaaaaaaaaaaaaa PartDescription: String PartQuantity: "0" UnitCost: "12345.78" CoreAmt: "12345.78" ExtendedCost: "12345.78" - PartNum: aaaaaaaaaaaaaaa PartDescription: String PartQuantity: "0" UnitCost: "12345.78" CoreAmt: "12345.78" ExtendedCost: "12345.78" PartMarkUpPercentage: "0" TotalAmount: "12345.78" TotalRequestedAmount: "12345.78" TotalAcceptedAmount: "12345.78" AuthorizationInfo: AuthorizationType: DSPM AuthorizationNo: "123456" CustomerRelationsCaseNum: "1308091111" ArbitrationCaseNo: ABC123344 TechnicalAssistanceCaseNum: String LegalCaseNo: String GoodWillFlag: "true" GoodWillComments: Long time customer LaborParticipation: DealerParticipationPct: "20" CustomerParticipationPct: "20" PartsAndMarkupParticipation: DealerParticipationPct: "20" CustomerParticipationPct: "20" SubletParticipation: DealerParticipationPct: "20" CustomerParticipationPct: "20" FeeParticipation: DealerParticipationPct: "20" CustomerParticipationPct: "20" Comments: - Comment: String Author: String Date: "1967-08-13" - Comment: String Author: String Date: "1967-08-13" ClaimJudgment: Status: Pending Review Errors: - ErrorType: INTEGRATION-ERROR Message: String - ErrorType: BUSINESS-WARNING Message: String Conditions: - Status: String ConditionCode: String ConditionDescription: String ConditionComment: String ReturnReason: String - Status: String ConditionCode: String ConditionDescription: String ConditionComment: String ReturnReason: String Amounts: ClaimTotalAmount: "12345.78" DifferencePct: "0" ClaimRequestedAmount: "12345.78" ClaimAcceptedAmount: "12345.78" StateTaxDue: "12345.78" IsAttachmentPending: String ExistingClaimAttachmentNumbers: - String - String ClaimAttachmentList: ClaimAttachment: - FileName: mycar.png FileFormat: image/png FileData: UjBsR09EbGhjZ0dTQUxNQUFBUUNBRU1tQ1p0dU1GUXhEUzhi AttachmentId: abcdefghij - FileName: mycar.png FileFormat: image/png FileData: UjBsR09EbGhjZ0dTQUxNQUFBUUNBRU1tQ1p0dU1GUXhEUzhi AttachmentId: abcdefghij LastUpdatedDateTime: "2013-04-12T04:24:56Z" RepairAuthorization: AuthorizationType: "" AuthorizationNo: AuthNO CustomerRelationsCaseNum: "1308091111" AuthorizationOwner: PartyID: "123456" AsssignedGroup: Warranty CustomerUser: SpecifiedPerson: Name: FirstName: customer first name LastName: customer last name AuthorizationStatusCode: Active AuthorizationReasonCode: asasdasdas DispositionNotes: aaa JustificationDetails: aaaa VehicleDetails: VIN: 4T1BD1FK4DU082644 DOFU: "1967-08-13" RepairOrderNum: abcdefg Condition: Noise over bumps Cause: Repair as per TSB SU002-99 Remedy: R/R/ suspension supports RH & LH MonthsInUse: "0" MilesInUse: "0" ModelYear: "2012" ModelName: Prius DealerUser: SpecifiedPerson: Name: FirstName: dealer first name LastName: dealer last name TelephoneCommunication: ChannelCode: Mobile CompleteNumber: 123-456-7890 URICommunication: ChannelCode: Email CompleteNumber: abc@xyz.com DealerCode: "33600" RepairAmountList: RepairAmount: - AmountType: Estimated AuthorizationType: DSPM TotalClassPrice: PriceCode: Total ChargeAmount: currencyID: USD Value: "123456.78" DifferencePct: "20" RepairAmountClassList: ClassPrice: - PriceCode: Labor ChargeAmount: currencyID: USD Value: "1234.56" DifferencePct: "20" - PriceCode: Parts ChargeAmount: currencyID: USD Value: "1234.56" DifferencePct: "20" - "" HasCustomerContactedTMS: "true" AuthorizationPreferenceList: AuthorizationPreference: - PreferenceType: ClaimReviewPreference PreferenceValue: Conditional - PreferenceType: RAUpgradePreference PreferenceValue: DSPM Only ValidTillDateTime: "2014-08-13T00:00:00Z" ValidityPeriod: 7 Days AdditionalComments: additional details for the RA AuthorizationHistoryList: AuthorizationHistory: - AuthorizationType: "" AuthorizationOwner: PartyID: "123455" SpecifiedPerson: Name: PreferredName: John Smith Role: WarrantyAdmin AuthorizationStatusCode: Pending AuthorizationDateTime: "2013-08-13T00:00:00Z" AuthorizationReasonCode: Good Service History DispositionNotes: some comments go here JustificationDetails: some comments go here - AuthorizationType: "" RoutingDetailsList: RoutingDetails: - FromUser: PartyID: "345678" AsssignedGroup: Warranty ToUser: PartyID: "345679" AsssignedGroup: CRDept - FromUser: PartyID: "345679" AsssignedGroup: CRDept ToUser: PartyID: "345680" AsssignedGroup: Warranty AuthorizationAttachmentList: AuthorizationAttachment: - FileName: mycar.png FileFormat: image/png FileData: UjBsR09EbGhjZ0dTQUxNQUFBUUNBRU1tQ1p0dU1GUXhEUzhi AttachmentId: abcdefghij - FileName: mycar.png FileFormat: image/png FileData: UjBsR09EbGhjZ0dTQUxNQUFBUUNBRU1tQ1p0dU1GUXhEUzhi AttachmentId: abcdefghij LastUpdatedDateTime: "2013-04-12T04:24:56Z" - TransactionId: "" ClaimType: Paint Claimant: PartnerCode: "12345" ServicingDealer: PartnerCode: "12345" SubmitDate: "2012-06-25T11:40:56.909125-04:00" RepairInfo: BasicRepairInfo: "" error401: properties: httpCode: type: string httpMessage: type: string moreInformation: type: string required: - httpCode - httpMessage - moreInformation example: httpCode: "401" httpMessage: Unauthorized moreInformation: Invalid client id or secret. additionalProperties: false error404: properties: httpCode: type: string httpMessage: type: string moreInformation: type: string required: - httpCode - httpMessage - moreInformation example: httpCode: "404" httpMessage: Not Found moreInformation: No resources match requested URI additionalProperties: false tags: [] x-ibm-endpoints: - endpointUrl: https://api-int.test.toyota.com/tmna/test type: - development - endpointUrl: https://api.test.toyota.com/tmna/test type: - development ...