Richemont.Booster2.PublicApi

<back to all web services

GetEquipment

Requires Authentication
The following routes are available for this service:
GET/equipment/{brand}/{posCode}/{serialNumber}Get the list of SAP equipment
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Richemont.Booster2.PublicApi.MasterFile.ServiceModel

Namespace Global

    Namespace Richemont.Booster2.PublicApi.MasterFile.ServiceModel

        Public Partial Class Equipment
            Public Sub New()
                equipmentList = New List(Of EquipmentDetail)
            End Sub

            Public Overridable Property equipmentFound As Boolean
            Public Overridable Property equipmentList As List(Of EquipmentDetail)
        End Class

        Public Partial Class EquipmentDetail
            Public Sub New()
                repairs = New List(Of EquipmentRepair)
                status = New List(Of EquipmentStatus)
                warranties = New List(Of EquipmentWarranty)
            End Sub

            Public Overridable Property articleCode As String
            Public Overridable Property articleDescription As String
            Public Overridable Property cassFamily As String
            Public Overridable Property serialNumber As String
            Public Overridable Property equipmentNumber As String
            Public Overridable Property articleName As String
            Public Overridable Property lastRepairNumber As String
            Public Overridable Property repairs As List(Of EquipmentRepair)
            Public Overridable Property status As List(Of EquipmentStatus)
            Public Overridable Property warranties As List(Of EquipmentWarranty)
        End Class

        Public Partial Class EquipmentRepair
            Public Sub New()
                details = New List(Of EquipmentRepairDetail)
            End Sub

            Public Overridable Property equipmentNumber As String
            Public Overridable Property repairNumber As String
            Public Overridable Property repairCloseDate As String
            Public Overridable Property details As List(Of EquipmentRepairDetail)
        End Class

        Public Partial Class EquipmentRepairDetail
            Public Overridable Property equipmentNumber As String
            Public Overridable Property repairNumber As String
            Public Overridable Property itemCategory As String
            Public Overridable Property item As String
        End Class

        Public Partial Class EquipmentStatus
            Public Overridable Property equipmentNumber As String
            Public Overridable Property statusCode As String
            Public Overridable Property statusDescription As String
            Public Overridable Property statusTextCode As String
        End Class

        Public Partial Class EquipmentWarranty
            Public Overridable Property equipmentNumber As String
            Public Overridable Property warrantyType As String
            Public Overridable Property warrantyStartDate As String
            Public Overridable Property warrantyEndDate As String
        End Class

        Public Partial Class GetEquipment
            '''<Summary>
            '''Brand trigram
            '''</Summary>
            <ApiMember(Description:="Brand trigram", IsRequired:=true)>
            Public Overridable Property brand As String

            '''<Summary>
            '''POS Legacy
            '''</Summary>
            <ApiMember(Description:="POS Legacy", IsRequired:=true)>
            Public Overridable Property posCode As String

            '''<Summary>
            '''SerialNumber
            '''</Summary>
            <ApiMember(Description:="SerialNumber", IsRequired:=true)>
            Public Overridable Property serialNumber As String

            '''<Summary>
            '''Reference like 'CRWSTA0030'
            '''</Summary>
            <ApiMember(Description:="Reference like 'CRWSTA0030'")>
            Public Overridable Property articleCode As String
        End Class

        Public Partial Class GetEquipmentResponse
            Inherits Equipment
        End Class
    End Namespace
End Namespace

VB.NET GetEquipment DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /equipment/{brand}/{posCode}/{serialNumber} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"equipmentFound":false,"equipmentList":[{"articleCode":"String","articleDescription":"String","cassFamily":"String","serialNumber":"String","equipmentNumber":"String","articleName":"String","lastRepairNumber":"String","repairs":[{"equipmentNumber":"String","repairNumber":"String","repairCloseDate":"String","details":[{"equipmentNumber":"String","repairNumber":"String","itemCategory":"String","item":"String"}]}],"status":[{"equipmentNumber":"String","statusCode":"String","statusDescription":"String","statusTextCode":"String"}],"warranties":[{"equipmentNumber":"String","warrantyType":"String","warrantyStartDate":"String","warrantyEndDate":"String"}]}]}