Skip to content

Campaign_Get

GET
/v1/Campaign/{id}
curl --request GET \
  --url https://rms.dev.caspeco.net/api/booking/v1/Campaign/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'system: example'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
integer format: int64

Header Parameters

Section titled “Header Parameters”
system
required
string

The system name / database to query

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
name
string
displayName
string
description
string
startDate
string format: date-time
endDate
string format: date-time
requirements
Array<object>
object
requirementType
integer
Allowed values: 0 1 2 3 4 5 6 7 99
type
string
nullable
campaignCodeIds
Array<string>
nullable
campaignCodes
Array<object>
object
id
string
name
string
code
string
createdDate
string format: date-time
createdBy
string
usages
integer format: int32
maxUsage
integer format: int32
maxUsagePerCustomer
integer format: int32
isDirty
boolean
doDelete
boolean
customerIds
Array<string>
nullable
weekDays
Array<string>
nullable
localTimeInterval
One of:
object
start
string
nullable
end
string
nullable
groups
Array<object>
nullable
object
name
string
quantity
integer format: int32
articles
Array<object>
object
id
integer format: int64
uuid
string
totalAmountCents
integer format: int32
tierId
string
nullable
rewardId
string
nullable
voucherId
string
nullable
numberOfCodes
integer format: int32
codeLength
integer format: int32
loggingSummary
string
benefits
Array<object>
object
benefitType
integer
Allowed values: 0 1 2 3 4
type
string
nullable
amountCents
integer format: int32
percentage
integer format: int32
maxDiscountAmount
integer format: int32
nullable
maxNumberOfOutcomes
integer format: int32
marketing
object
enabled
boolean
imageMap
object
key
additional properties
string
uploadImages
Array
nullable
object
tags
Array<string>
nullable
cropRatios
Array<object>
nullable
object
id
integer format: int64
nullable
imageId
integer format: int64
nullable
left
number format: double
top
number format: double
width
number format: double
height
number format: double
aspectRatio
string
image
string
imageUrl
string
imageFilename
string
imageUploadData
string
sortOrder
integer format: int32
nullable
imageMap
object
key
additional properties
string
uploadImages
Array
nullable
object
tags
Array<string>
nullable
cropRatios
Array<object>
nullable
object
id
integer format: int64
nullable
imageId
integer format: int64
nullable
left
number format: double
top
number format: double
width
number format: double
height
number format: double
aspectRatio
string
image
string
imageUrl
string
imageFilename
string
imageUploadData
string
id
integer format: int64
campaignId
string
nullable
status
integer
Allowed values: 0 1 2 3 4
availableTiers
Array<object>
nullable
object
id
string
name
string
availableRewards
Array<object>
nullable
object
id
string
name
string
availableVouchers
Array<object>
nullable
object
id
string
name
string
Example
{
  "requirements": [
    {
      "requirementType": 0
    }
  ],
  "benefits": [
    {
      "benefitType": 0
    }
  ],
  "status": 0
}