NAV

CampaignsGetList

The following routes are available for this service:
GET	/campaigns

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports NAV.ServiceModel

Namespace Global

    Namespace NAV.ServiceModel

        Public Partial Class CampaignDetails
            Public Overridable Property CampaignNumber As Integer
            Public Overridable Property CampaignName As String
            Public Overridable Property BatchNumber As Decimal
            Public Overridable Property BatchName As String
            Public Overridable Property CampaignsAwayFromCurrent As Integer
            Public Overridable Property Cycle As Integer
            Public Overridable Property PeriodStartTime As Date
            Public Overridable Property PeriodEndTime As Date
            Public Overridable Property FiscalYear As Integer
            Public Overridable Property Status As String
        End Class

        Public Partial Class CampaignsGetList
        End Class

        Public Partial Class CampaignsGetListResponse
            Inherits GetResponse(Of CampaignViewModel)
        End Class

        Public Partial Class CampaignViewModel
            Public Sub New()
                Campaigns = New List(Of CampaignDetails)
            End Sub

            Public Overridable Property CurrentCampaignNumber As Integer
            Public Overridable Property PriorYearCampaignNumber As Integer
            Public Overridable Property Campaigns As List(Of CampaignDetails)
        End Class

        Public Partial Class GetResponse(Of TEntity)
            Public Overridable Property Item As TEntity
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET CampaignsGetList 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 /campaigns HTTP/1.1 
Host: extensions.avon.ca 
Accept: text/jsv

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

{
	item: 
	{
		currentCampaignNumber: 0,
		priorYearCampaignNumber: 0,
		campaigns: 
		[
			{
				campaignNumber: 0,
				campaignName: String,
				batchNumber: 0,
				batchName: String,
				campaignsAwayFromCurrent: 0,
				cycle: 0,
				periodStartTime: 0001-01-01T00:00:00,
				periodEndTime: 0001-01-01T00:00:00,
				fiscalYear: 0,
				status: String
			}
		]
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}