swagger: '2.0' info: description: AgoraPlus API Portal version: 2.0.0 title: AgoraPlus API Portal contact: email: support@agoraplus.com host: preprod-api.agoraplus.com basePath: /v2 tags: - name: AgoraPlus Web APIs description: AgoraPlus Web APIs externalDocs: description: Find out more url: http://support.agoraplus.com schemes: - https - http paths: /api/v2/EcoSupport/CreateSupportRequest: post: tags: - EcoSupport summary: Request for an ECO Support description: '' operationId: CreateSupportRequest produces: - application/json - text/json - application/xml - text/xml parameters: - name: CallDate in: query description: Date the consumer contact the repair center took in charge the appliance required: true type: string format: date-time - name: RepairSiteId in: query description: Site ID of the repair required: true type: string - name: QuoteNumber in: query description: Number of the quote required: true type: string - in: body name: RepairDetails description: Details needed for the Eco support required: true schema: $ref: '#/definitions/AgoraWebServices.Models.EcoSupport.RepairDetails' responses: '200': description: successful operation schema: $ref: '#/definitions/AgoraWebServices.Models.Response.CreateSupportRequestResponse' '400': description: Bad request schema: $ref: '#/definitions/AgoraWebServices.Models.Response.ErrorResponse' '500': description: InternalServerError schema: $ref: '#/definitions/AgoraWebServices.Models.Response.ErrorResponse' /api/v2/EcoSupport/GetSupportRequestStatus: get: tags: - EcoSupport summary: Get support request status operationId: GetSupportRequestStatus consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: RequestId in: query description: Identifier of the request in Agora required: false type: integer format: int32 responses: '200': description: OK schema: $ref: '#/definitions/AgoraWebServices.Models.Response.RequestStatusResponse' '500': description: InternalServerError schema: $ref: '#/definitions/AgoraWebServices.Models.Response.ErrorResponse' /api/v2/EcoSupport/CreateClaim: post: tags: - EcoSupport summary: Claim for reimbursment description: '' operationId: CreateClaim produces: - application/json - text/json - application/xml - text/xml parameters: - name: RequestId in: query description: Support request identifier, returned by AgoraPlus (CreateSupportRequest) required: true type: integer format: int32 - name: RepairEndDate in: query description: Date of the end of the repair required: true type: string format: date-time - name: RepairSiteId in: query description: Qualirepar ID of the repair site required: true type: string - name: ConsumerInvoiceNumber in: query description: Invoice number required: true type: string - in: body name: RepairDetails description: Details needed for the Eco support required: true schema: $ref: '#/definitions/AgoraWebServices.Models.EcoSupport.RepairDetails' responses: '200': description: successful operation schema: $ref: '#/definitions/AgoraWebServices.Models.Response.ClaimResponse' '400': description: Bad request schema: $ref: '#/definitions/AgoraWebServices.Models.Response.ErrorResponse' '500': description: InternalServerError schema: $ref: '#/definitions/AgoraWebServices.Models.Response.ErrorResponse' /api/v2/EcoSupport/UpdateClaim: post: tags: - EcoSupport summary: Update the claim to fix issue raised by AgoraPlus description: '' operationId: UpdateClaim produces: - application/json - text/json - application/xml - text/xml parameters: - name: ClaimId in: query description: Identifier of the claim provided by Agoraplus after the creation required: true type: integer format: int32 - name: RepairEndDate in: query description: Date of the end of the repair required: true type: string format: date-time - name: RepairSiteId in: query description: Site ID of the repair required: true type: string - name: ConsumerInvoiceNumber in: query description: Invoice number required: true type: string - name: Submit in: query description: Submit claim if valid required: false type: boolean - in: body name: Body description: Repair details required: true schema: $ref: '#/definitions/AgoraWebServices.Models.EcoSupport.RepairDetails' responses: '200': description: successful operation schema: $ref: '#/definitions/AgoraWebServices.Models.Response.ClaimResponse' '400': description: Bad request schema: $ref: '#/definitions/AgoraWebServices.Models.Response.ErrorResponse' '500': description: InternalServerError schema: $ref: '#/definitions/AgoraWebServices.Models.Response.ErrorResponse' /api/v2/EcoSupport/AttachFile: post: tags: - EcoSupport summary: Attach a file to the claim description: '' operationId: AttachedFile produces: - application/json - text/json - application/xml - text/xml parameters: - name: ClaimId in: query description: Identifier of the claim provided by Agoraplus after the creation required: true type: integer format: int32 - name: FileName in: query description: Date of the end of the repair required: true type: string - name: FileExtension in: query description: File extension required: true type: string - name: DocumentType in: query description: Document type. Possible values (Invoice, Nameplate) required: true type: string - name: FileContent in: body description: Document content in base 64. required: true schema: type: string responses: '200': description: OK '400': description: Bad request '500': description: InternalServerError /api/v2/EcoSupport/GetClaimStatus: get: tags: - EcoSupport summary: Get claim status operationId: GetClaimStatus consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: Claimid in: query description: Identifier of the request in Agora required: false type: integer format: int32 responses: '200': description: OK schema: $ref: '#/definitions/AgoraWebServices.Models.Response.ClaimStatusResponse' '500': description: InternalServerError schema: $ref: '#/definitions/AgoraWebServices.Models.Response.ErrorResponse' /api/v2/EcoSupport/CalculateEcoSupport: get: tags: - EcoSupport summary: Check the eligibility and Calculate the suppport operationId: CalculateEcoSupport consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: TotalAmountExclVAT in: query description: Identifier of the request in Agora type: number format: float - name: TotalAmountExclVAT_Currency in: query description: Identifier of the request in Agora type: string - name: BrandId in: query description: Identifier of the request in Agora required: false type: integer format: int32 - name: ProductId in: query description: Identifier of the request in Agora required: false type: integer format: int32 - name: IRISSymptom in: query description: Identifier of the request in Agora required: false type: string - name: RepairCode in: query description: Repair code or Iris Repair code required: false type: string responses: '200': description: OK schema: $ref: '#/definitions/AgoraWebServices.Models.Response.CalculateSupportResponse' '500': description: InternalServerError schema: $ref: '#/definitions/AgoraWebServices.Models.Response.ErrorResponse' /api/v2/EcoSupport/PrintBrandList: get: tags: - EcoSupport summary: Print the list of brands operationId: PrintBrandList consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: [] responses: '200': description: OK schema: $ref: '#/definitions/AgoraWebServices.Models.Response.PrintBrandListResponse' '500': description: InternalServerError schema: $ref: '#/definitions/AgoraWebServices.Models.Response.ErrorResponse' /api/v2/EcoSupport/PrintProductTypeList: get: tags: - EcoSupport summary: Print the list of product type with for each its related repair codes and symptom codes operationId: PrintProductTypeList consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: [] responses: '200': description: OK schema: $ref: '#/definitions/AgoraWebServices.Models.Response.PrintProductTypeListResponse' '500': description: InternalServerError schema: $ref: '#/definitions/AgoraWebServices.Models.Response.ErrorResponse' securityDefinitions: api_key: type: apiKey description: API Key Authentication name: api_key in: header definitions: AgoraWebServices.Models.EcoSupport.RepairDetails: type: object required: - Consumer - Product - Quote properties: Consumer: type: object $ref: '#/definitions/AgoraWebServices.Models.EcoSupport.Consumer' Product: type: object $ref: '#/definitions/AgoraWebServices.Models.EcoSupport.Product' Quote: type: object $ref: '#/definitions/AgoraWebServices.Models.EcoSupport.CostDetails' SpareParts: type: array items: $ref: '#/definitions/AgoraWebServices.Models.EcoSupport.Sparepart' xml: name: Request AgoraWebServices.Models.EcoSupport.Consumer: type: object required: - LastName - Address1 - Zip - City - Country - Email properties: Title: type: integer format: int32 LastName: type: string FirstName: type: string StreetNumber: type: string Address1: type: string Address2: type: string Address3: type: string Zip: type: string City: type: string Country: type: string Phone: type: string Email: type: string xml: name: Consumer AgoraWebServices.Models.EcoSupport.Product: type: object required: - ProductId - BrandId - SerialNumber - PurchaseDate - IRISSymptom properties: ProductId: type: string BrandId: type: string CommercialRef: type: string SerialNumber: type: string PurchaseDate: type: string format: date IRISCondition: type: string IRISConditionEX: type: string IRISSymptom: type: string IRISSection: type: string IRISDefault: type: string IRISRepair: type: string FailureDescription: type: string DefectCode: type: string xml: name: Product AgoraWebServices.Models.EcoSupport.CostDetails: type: object required: - LaborCost - SparePartsCost - TravelCost - TotalAmountExclVAT - TotalAmountInclVAT - SupportAmount properties: LaborCost: type: object properties: Amount: type: number format: float Currency: type: string SparePartsCost: type: object properties: Amount: type: number format: float Currency: type: string TravelCost: type: object properties: Amount: type: number format: float Currency: type: string TotalAmountExclVAT: type: object properties: Amount: type: number format: float Currency: type: string TotalAmountInclVAT: type: object properties: Amount: type: number format: float Currency: type: string SupportAmount: type: object properties: Amount: type: number format: float Currency: type: string xml: name: Quote AgoraWebServices.Models.EcoSupport.Sparepart: type: object required: - Partref - Quantity - Status properties: Partref: type: string Quantity: type: integer format: int64 Status: type: string xml: name: Sparepart Tag: type: object properties: id: type: integer format: int64 name: type: string xml: name: Tag AgoraWebServices.Models.Response.CreateSupportRequestResponse: description: Create complete repair method response values type: object properties: ResponseData: $ref: '#/definitions/AgoraWebServices.Models.Response.SupportRequestResponseData' description: Response data ResponseStatus: description: 'Response status ("S" : Sucess, "E": Error, "W":Warning)' type: string IsValid: description: Response validity type: boolean ResponseMessage: description: Response message type: string ResponseErrorMessage: description: Response Error Message type: string AgoraWebServices.Models.Response.SupportRequestResponseData: description: Response data from create complete repair method type: object properties: EcoOrganizationId: format: int32 description: Identifier of the Eco organization who will provide the suppot type: integer RequestId: format: int32 description: AgoraPlus internal identifier of the request type: integer IsValid: description: Validity type: boolean ErrorMessage: description: Error message type: string AgoraWebServices.Models.Response.ClaimResponse: description: Create complete repair method response values type: object properties: ResponseData: $ref: '#/definitions/AgoraWebServices.Models.Response.ClaimResponseData' description: Response data ResponseStatus: description: 'Response status ("S" : Sucess, "E": Error, "W":Warning)' type: string IsValid: description: Response validity type: boolean ResponseMessage: description: Response message type: string ResponseErrorMessage: description: Response Error Message type: string AgoraWebServices.Models.Response.ClaimResponseData: description: Response data from create complete repair method type: object properties: ClaimId: format: int32 description: AgoraPlus internal identifier of the request type: integer IsValid: description: Validity type: boolean ValidationErrors: description: Validation errors type: array items: $ref: '#/definitions/AgoraWebServices.Models.Return.ValidationResult' ErrorMessage: description: Error message type: string AgoraWebServices.Models.Return.ValidationResult: description: Validation error result values type: object properties: Field: description: Field assotiated to the error type: string ErrorMessage: description: Error message type: string MessageType: description: "Type of the error message : \r\n - E : Error\r\n - W : Warning" type: string AgoraWebServices.Models.Response.ErrorResponse: description: Error response object type: object properties: ResponseData: description: Response data type: object ResponseStatus: description: 'Response status ("S" : Sucess, "E": Error, "W":Warning)' type: string IsValid: description: Response validity type: boolean ResponseMessage: description: Response message type: string ResponseErrorMessage: description: Response Error Message type: string AgoraWebServices.Models.Response.RequestStatusResponse: description: Get request method response values type: object properties: ResponseData: description: Response data type: array items: $ref: '#/definitions/AgoraWebServices.Models.EcoSupport.RequestStatusResponseData' ResponseStatus: description: 'Response status ("S" : Sucess, "E": Error, "W":Warning)' type: string IsValid: description: Response validity type: boolean ResponseMessage: description: Response message type: string ResponseErrorMessage: description: Response Error Message type: string AgoraWebServices.Models.EcoSupport.RequestStatusResponseData: description: Warranty claim informations type: object properties: RequestId: format: int32 description: Identifier in Agora type: integer LastStatus: description: Last status type: string Comment: description: Comment type: string CreateDate: format: date-time description: Creation date type: string AgoraWebServices.Models.Response.ClaimStatusResponse: description: Get request method response values type: object properties: ResponseData: description: Response data type: array items: $ref: '#/definitions/AgoraWebServices.Models.EcoSupport.ClaimStatusResponseData' ResponseStatus: description: 'Response status ("S" : Sucess, "E": Error, "W":Warning)' type: string IsValid: description: Response validity type: boolean ResponseMessage: description: Response message type: string ResponseErrorMessage: description: Response Error Message type: string AgoraWebServices.Models.EcoSupport.ClaimStatusResponseData: description: Warranty claim informations type: object properties: ClaimId: format: int32 description: Identifier in Agora type: integer LastStatus: description: Last status type: string Comment: description: Comment type: string CreateDate: format: date-time description: Creation date type: string AgoraWebServices.Models.Response.CalculateSupportResponse: description: Get request method response values type: object properties: ResponseData: description: Response data type: array items: $ref: '#/definitions/AgoraWebServices.Models.EcoSupport.CalculateSupportResponseData' ResponseStatus: description: 'Response status ("S" : Sucess, "E": Error, "W":Warning)' type: string IsValid: description: Response validity type: boolean ResponseMessage: description: Response message type: string ResponseErrorMessage: description: Response Error Message type: string AgoraWebServices.Models.EcoSupport.CalculateSupportResponseData: description: Warranty claim informations type: object properties: EcoOrganizationId: format: int32 description: Identifier of the Eco organization who will provide the suppot type: integer SupportAmount: type: object properties: Amount: type: number format: float Currency: type: string AgoraWebServices.Models.Response.PrintBrandListResponse: description: Get request method response values type: object properties: ResponseData: description: Response data type: array items: $ref: '#/definitions/AgoraWebServices.Models.EcoSupport.PrintBrandListResponseData' ResponseStatus: description: 'Response status ("S" : Sucess, "E": Error, "W":Warning)' type: string IsValid: description: Response validity type: boolean ResponseMessage: description: Response message type: string ResponseErrorMessage: description: Response Error Message type: string AgoraWebServices.Models.EcoSupport.PrintBrandListResponseData: description: List of brands type: object properties: BrandName: description: Brand name type: string BrandId: description: Brand code type: string AgoraWebServices.Models.Response.PrintProductTypeListResponse: description: Get request method response values type: object properties: ResponseData: description: Response data type: array items: $ref: '#/definitions/AgoraWebServices.Models.EcoSupport.PrintProductTypeListResponseData' ResponseStatus: description: 'Response status ("S" : Sucess, "E": Error, "W":Warning)' type: string IsValid: description: Response validity type: boolean ResponseMessage: description: Response message type: string ResponseErrorMessage: description: Response Error Message type: string AgoraWebServices.Models.EcoSupport.PrintProductTypeListResponseData: description: List of brands type: object properties: ProductId: description: Identifier of the product type: string ProductName: description: Name of the product type type: string EligibilityStartDate: description: Name of the product type type: string format: date EligibilityEndDate: description: Name of the product type type: string format: date RepairCodes: type: array items: type: object properties: RepairCode: description: Repair Code type: string IRISSymtoms: type: array items: type: object properties: IRISSymtom: description: IRIS code of the symptom type: string externalDocs: description: Find out more about Swagger url: http://swagger.io