Richemont.Booster2.PublicApi

GetTaskDetail

The following routes are available for this service:
GET	/tasks/{asyncTaskId}	Get task detail of authorized user

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Richemont.Booster2.PublicApi.NightlyProcess.ServiceModel

Namespace Global

    Namespace Richemont.Booster2.PublicApi.NightlyProcess.ServiceModel

        Public Partial Class GetTaskDetail
            '''<Summary>
            '''Async task ID
            '''</Summary>
            <ApiMember(Description:="Async task ID", IsRequired:=true)>
            Public Overridable Property asyncTaskId As Guid
        End Class

        Public Partial Class GetTaskDetailResponse
            Inherits Task
        End Class

        Public Partial Class Task
            '''<Summary>
            '''Async task ID
            '''</Summary>
            <ApiMember(Description:="Async task ID", IsRequired:=true)>
            Public Overridable Property asyncTaskId As Guid

            '''<Summary>
            '''Type of requested async task, e.g 'stock', 'sellout', 'crm'
            '''</Summary>
            <ApiMember(Description:="Type of requested async task, e.g 'stock', 'sellout', 'crm'", IsRequired:=true)>
            Public Overridable Property type As String

            '''<Summary>
            '''Async task creation date
            '''</Summary>
            <ApiMember(Description:="Async task creation date", IsRequired:=true)>
            Public Overridable Property requestDate As String

            '''<Summary>
            '''Status of requested async task, e.g 'REQ', 'INP', 'COM', 'ERR'
            '''</Summary>
            <ApiMember(Description:="Status of requested async task, e.g 'REQ', 'INP', 'COM', 'ERR'", IsRequired:=true)>
            Public Overridable Property status As String

            '''<Summary>
            '''Percentage of completion
            '''</Summary>
            <ApiMember(Description:="Percentage of completion", IsRequired:=true)>
            Public Overridable Property percentage As Integer

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

            '''<Summary>
            '''Download url of created files
            '''</Summary>
            <ApiMember(Description:="Download url of created files")>
            Public Overridable Property downloadUrl As String

            '''<Summary>
            '''Presigned expiring download url
            '''</Summary>
            <ApiMember(Description:="Presigned expiring download url")>
            Public Overridable Property signedDownloadUrl As String

            '''<Summary>
            '''Total count of operations
            '''</Summary>
            <ApiMember(Description:="Total count of operations")>
            Public Overridable Property totalResults As Nullable(Of Integer)

            '''<Summary>
            '''Count of successful operations
            '''</Summary>
            <ApiMember(Description:="Count of successful operations")>
            Public Overridable Property totalSucceeded As Nullable(Of Integer)

            '''<Summary>
            '''Count of failed operations
            '''</Summary>
            <ApiMember(Description:="Count of failed operations")>
            Public Overridable Property totalFailed As Nullable(Of Integer)
        End Class
    End Namespace
End Namespace

VB.NET GetTaskDetail DTOs

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

HTTP + JSV

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

GET /tasks/{asyncTaskId} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	asyncTaskId: 00000000000000000000000000000000,
	type: String,
	requestDate: String,
	status: String,
	percentage: 0,
	brand: String,
	downloadUrl: String,
	signedDownloadUrl: String,
	totalResults: 0,
	totalSucceeded: 0,
	totalFailed: 0
}