| GET | /sync/incompleteupliftrequests |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports WebService.ServiceModel
Imports WebService.AppApi.Models.Base
Imports WebService.AppApi.Models
Namespace Global
Namespace WebService.AppApi.Models
Public Partial Class OutletData
Public Sub New()
AssignedPrincipalIds = New List(Of Integer)
AssignedRegions = New List(Of OutletRegionData)
End Sub
Public Overridable Property Id As Integer
Public Overridable Property Name As String
Public Overridable Property LastRequestedDate As String
Public Overridable Property HasGeneralUpliftRequest As Boolean
Public Overridable Property UpliftRequestCount As Integer
Public Overridable Property AssignedPrincipalIds As List(Of Integer)
Public Overridable Property AssignedRegions As List(Of OutletRegionData)
Public Overridable Property Channel As String
Public Overridable Property NextScheduledDate As String
End Class
Public Partial Class OutletRegionData
Public Overridable Property PrincipalId As Integer
Public Overridable Property Region As String
End Class
End Namespace
Namespace WebService.AppApi.Models.Base
Public Partial Class ApiServiceRequest
Implements IServiceRequest
Implements IHasApiKey
Implements IHasDeviceInfo
'''<Summary>
'''The API Key required for authentication
'''</Summary>
<ApiMember(DataType:="string", Description:="The API Key required for authentication", IsRequired:=true)>
Public Overridable Property ApiKey As String
'''<Summary>
'''Latitude of the user making this request
'''</Summary>
<ApiMember(DataType:="double", Description:="Latitude of the user making this request")>
Public Overridable Property Latitude As Double
'''<Summary>
'''Longitude of the user making this request
'''</Summary>
<ApiMember(DataType:="double", Description:="Longitude of the user making this request")>
Public Overridable Property Longitude As Double
End Class
Public Partial Class ApiServiceResponse
Implements IServiceResponse
'''<Summary>
'''Information about the response.
'''</Summary>
<ApiMember(Description:="Information about the response.", IsRequired:=true)>
Public Overridable Property Description As String
'''<Summary>
'''Heading or summary of the response.
'''</Summary>
<ApiMember(Description:="Heading or summary of the response.", IsRequired:=true)>
Public Overridable Property Heading As String
'''<Summary>
'''Did the intended operation for this response complete successfully?
'''</Summary>
<ApiMember(DataType:="boolean", Description:="Did the intended operation for this response complete successfully?", IsRequired:=true)>
Public Overridable Property WasSuccessful As Boolean
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
Namespace WebService.ServiceModel
Public Partial Class IncompleteUpliftRequestData
Public Overridable Property SystemUserId As Integer
Public Overridable Property IncompleteUpliftRequestId As Guid
Public Overridable Property UpliftRequestOnDeviceId As Guid
Public Overridable Property OutletId As Integer
Public Overridable Property LastSynced As Date
Public Overridable Property IsSubmitted As Boolean
Public Overridable Property DeleteFromDevice As Boolean
Public Overridable Property CreatedByMerchandiserName As String
End Class
Public Partial Class IncompleteUpliftRequestList
Inherits ApiServiceRequest
End Class
Public Partial Class IncompleteUpliftRequestListResponse
Inherits ApiServiceResponse
Public Sub New()
IncompleteUpliftRequests = New List(Of IncompleteUpliftRequestData)
AssignedOutlets = New List(Of OutletData)
End Sub
Public Overridable Property IncompleteUpliftRequests As List(Of IncompleteUpliftRequestData)
Public Overridable Property AllowLogin As Boolean
Public Overridable Property AssignedOutlets As List(Of OutletData)
Public Overridable Property Archived As Boolean
End Class
End Namespace
End Namespace
VB.NET IncompleteUpliftRequestList DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /sync/incompleteupliftrequests HTTP/1.1 Host: returnit-api-dev.happen.zone Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
IncompleteUpliftRequests:
[
{
}
],
AllowLogin: False,
AssignedOutlets:
[
{
}
],
Archived: False,
Description: String,
Heading: String,
WasSuccessful: False,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}