CreateCampaign

 

CampaignService / CreateCampaign

 

Description: Create Campaign

URL: http://{your-server-url}/api/v1/appspace/campaigns

Method: POST

Token Required: True


Request Headers: 
content-type: application/json or content-type: application/xml
token: {token}
Request:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.Campaign.CampaignRequest

Parameter Type Nullable
Request.Campaign Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.Campaign.Campaign False

Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.Campaign.CampaignResponse

Parameter Type
Response.Campaign Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.Campaign.Campaign

Enums:
Field Name Values
PlayoutMode Nexus.AppSpace.Service.Contract.Model.Enums.Campaign.PlayoutMode Undefined = 0, Strict = 1, BestEffort = 2, Loose = 3, Dynamic = 4

The following is an example request Xml body: 
<CampaignRequest xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.Campaign" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Campaign xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.Campaign">
    <a:Code>String</a:Code>
    <a:DeletedAt>2014-04-24T17:53:43.3493091Z</a:DeletedAt>
    <a:DeletedBy>String</a:DeletedBy>
    <a:Guid>11111111-1111-1111-1111-111111111111</a:Guid>
    <a:LastUpdatedAt>2014-04-24T17:53:43.3493091Z</a:LastUpdatedAt>
    <a:LastUpdatedBy>String</a:LastUpdatedBy>
    <a:TypeId>123</a:TypeId>
    <a:BookingIds xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <b:int>123</b:int>
    </a:BookingIds>
    <a:ClientId>123</a:ClientId>
    <a:DaysToPlay xmlns:b="http://schemas.datacontract.org/2004/07/System">
      <b:DayOfWeek>Saturday</b:DayOfWeek>
    </a:DaysToPlay>
    <a:DeactivationURL>String</a:DeactivationURL>
    <a:EndDate>2014-04-24T17:53:43.3493091Z</a:EndDate>
    <a:IsAllDayEvent>true</a:IsAllDayEvent>
    <a:IsManualDeactivationOn>true</a:IsManualDeactivationOn>
    <a:IsTemplate>true</a:IsTemplate>
    <a:Metadata xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO">
      <b:KeyValuePair>
        <b:Key>String</b:Key>
        <b:Value>String</b:Value>
      </b:KeyValuePair>
    </a:Metadata>
    <a:Name>String</a:Name>
    <a:OwnerId>123</a:OwnerId>
    <a:PlayEverdays>true</a:PlayEverdays>
    <a:PlayoutMode>Dynamic</a:PlayoutMode>
    <a:Priority>123</a:Priority>
    <a:SiteIds xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <b:int>123</b:int>
    </a:SiteIds>
    <a:StartDate>2014-04-24T17:53:43.3493091Z</a:StartDate>
    <a:TemplateId>123</a:TemplateId>
    <a:TimesToPlay xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO">
      <b:ActiveTimeSlot>
        <b:EndTime>2014-04-24T17:53:43.3493091Z</b:EndTime>
        <b:StartTime>2014-04-24T17:53:43.3493091Z</b:StartTime>
      </b:ActiveTimeSlot>
    </a:TimesToPlay>
    <a:ZoneIds xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <b:int>123</b:int>
    </a:ZoneIds>
    <a:activationURL>String</a:activationURL>
  </Campaign>
</CampaignRequest>

The following is an example request Json body: 
{
	"Campaign":{
		"Code":"String",
		"DeletedAt":"\/Date(1398362023349)\/",
		"DeletedBy":"String",
		"Guid":"11111111-1111-1111-1111-111111111111",
		"LastUpdatedAt":"\/Date(1398362023349)\/",
		"LastUpdatedBy":"String",
		"TypeId":123,
		"BookingIds":[
			123
		],
		"ClientId":123,
		"DaysToPlay":[
			6
		],
		"DeactivationURL":"String",
		"EndDate":"\/Date(1398362023349)\/",
		"IsAllDayEvent":true,
		"IsManualDeactivationOn":true,
		"IsTemplate":true,
		"Metadata":[
			{
				"Key":"String",
				"Value":"String"
			}
		],
		"Name":"String",
		"OwnerId":123,
		"PlayEverdays":true,
		"PlayoutMode":4,
		"Priority":123,
		"SiteIds":[
			123
		],
		"StartDate":"\/Date(1398362023349)\/",
		"TemplateId":123,
		"TimesToPlay":[
			{
				"EndTime":"\/Date(1398362023349)\/",
				"StartTime":"\/Date(1398362023349)\/"
			}
		],
		"ZoneIds":[
			123
		],
		"activationURL":"String"
	}
}

The following is an example response Xml body: 
<CampaignResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.Campaign" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <DebugMessage xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">String</DebugMessage>
  <Errors xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">
    <Error>
      <Code>String</Code>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
    </Error>
  </Errors>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">Success</Status>
  <Campaign xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.Campaign">
    <a:Code>String</a:Code>
    <a:CreatedAt>2014-04-24T17:53:43.3503099Z</a:CreatedAt>
    <a:CreatedBy>String</a:CreatedBy>
    <a:DeletedAt>2014-04-24T17:53:43.3503099Z</a:DeletedAt>
    <a:DeletedBy>String</a:DeletedBy>
    <a:Guid>11111111-1111-1111-1111-111111111111</a:Guid>
    <a:Id>123</a:Id>
    <a:LastUpdatedAt>2014-04-24T17:53:43.3503099Z</a:LastUpdatedAt>
    <a:LastUpdatedBy>String</a:LastUpdatedBy>
    <a:TypeId>123</a:TypeId>
    <a:BookingIds xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <b:int>123</b:int>
    </a:BookingIds>
    <a:ClientId>123</a:ClientId>
    <a:DaysToPlay xmlns:b="http://schemas.datacontract.org/2004/07/System">
      <b:DayOfWeek>Saturday</b:DayOfWeek>
    </a:DaysToPlay>
    <a:DeactivationURL>String</a:DeactivationURL>
    <a:EndDate>2014-04-24T17:53:43.3503099Z</a:EndDate>
    <a:IsAllDayEvent>true</a:IsAllDayEvent>
    <a:IsManualDeactivationOn>true</a:IsManualDeactivationOn>
    <a:IsTemplate>true</a:IsTemplate>
    <a:Metadata xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO">
      <b:KeyValuePair>
        <b:Key>String</b:Key>
        <b:Value>String</b:Value>
      </b:KeyValuePair>
    </a:Metadata>
    <a:Name>String</a:Name>
    <a:OwnerId>123</a:OwnerId>
    <a:PlayEverdays>true</a:PlayEverdays>
    <a:PlayoutMode>Dynamic</a:PlayoutMode>
    <a:Priority>123</a:Priority>
    <a:SiteIds xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <b:int>123</b:int>
    </a:SiteIds>
    <a:StartDate>2014-04-24T17:53:43.3503099Z</a:StartDate>
    <a:TemplateId>123</a:TemplateId>
    <a:TimesToPlay xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO">
      <b:ActiveTimeSlot>
        <b:EndTime>2014-04-24T17:53:43.3503099Z</b:EndTime>
        <b:StartTime>2014-04-24T17:53:43.3503099Z</b:StartTime>
      </b:ActiveTimeSlot>
    </a:TimesToPlay>
    <a:ZoneIds xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <b:int>123</b:int>
    </a:ZoneIds>
    <a:activationURL>String</a:activationURL>
  </Campaign>
</CampaignResponse>

The following is an example response Json body: 
{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"Campaign":{
		"Code":"String",
		"CreatedAt":"\/Date(1398362023350)\/",
		"CreatedBy":"String",
		"DeletedAt":"\/Date(1398362023350)\/",
		"DeletedBy":"String",
		"Guid":"11111111-1111-1111-1111-111111111111",
		"Id":123,
		"LastUpdatedAt":"\/Date(1398362023350)\/",
		"LastUpdatedBy":"String",
		"TypeId":123,
		"BookingIds":[
			123
		],
		"ClientId":123,
		"DaysToPlay":[
			6
		],
		"DeactivationURL":"String",
		"EndDate":"\/Date(1398362023350)\/",
		"IsAllDayEvent":true,
		"IsManualDeactivationOn":true,
		"IsTemplate":true,
		"Metadata":[
			{
				"Key":"String",
				"Value":"String"
			}
		],
		"Name":"String",
		"OwnerId":123,
		"PlayEverdays":true,
		"PlayoutMode":4,
		"Priority":123,
		"SiteIds":[
			123
		],
		"StartDate":"\/Date(1398362023350)\/",
		"TemplateId":123,
		"TimesToPlay":[
			{
				"EndTime":"\/Date(1398362023350)\/",
				"StartTime":"\/Date(1398362023350)\/"
			}
		],
		"ZoneIds":[
			123
		],
		"activationURL":"String"
	}
}