CreateProofOfPlay

 

CampaignService / CreateProofOfPlay

 

Description: Create ProofOfPlay

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

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.ProofOfPlays Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.Campaign.ProofOfPlay[] False

Response:

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

Parameter Type
Response.ProofOfPlays Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.Campaign.ProofOfPlay[]

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">
  <ProofOfPlays xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.Campaign">
    <a:ProofOfPlay>
      <a:AssetContentId>123</a:AssetContentId>
      <a:BookingId>123</a:BookingId>
      <a:BookingLoopId>123</a:BookingLoopId>
      <a:CampaignId>123</a:CampaignId>
      <a:FullPlayout>true</a:FullPlayout>
      <a:MasterLoopAssetId>123</a:MasterLoopAssetId>
      <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:PlayerId>String</a:PlayerId>
      <a:PlayerType>String</a:PlayerType>
      <a:PlayoutDuration>123</a:PlayoutDuration>
      <a:SiteId>123</a:SiteId>
      <a:StartPlayout>String</a:StartPlayout>
      <a:ZoneId>123</a:ZoneId>
    </a:ProofOfPlay>
  </ProofOfPlays>
</CampaignRequest>

The following is an example request Json body:
{
	"ProofOfPlays":[
		{
			"AssetContentId":123,
			"BookingId":123,
			"BookingLoopId":123,
			"CampaignId":123,
			"FullPlayout":true,
			"MasterLoopAssetId":123,
			"Metadata":[
				{
					"Key":"String",
					"Value":"String"
				}
			],
			"PlayerId":"String",
			"PlayerType":"String",
			"PlayoutDuration":123,
			"SiteId":123,
			"StartPlayout":"String",
			"ZoneId":123
		}
	]
}

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>
  <ProofOfPlays xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.Campaign">
    <a:ProofOfPlay>
      <a:AssetContentId>123</a:AssetContentId>
      <a:BookingId>123</a:BookingId>
      <a:BookingLoopId>123</a:BookingLoopId>
      <a:CampaignId>123</a:CampaignId>
      <a:FullPlayout>true</a:FullPlayout>
      <a:Id>123</a:Id>
      <a:MasterLoopAssetId>123</a:MasterLoopAssetId>
      <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:PlayerId>String</a:PlayerId>
      <a:PlayerType>String</a:PlayerType>
      <a:PlayoutDuration>123</a:PlayoutDuration>
      <a:SiteId>123</a:SiteId>
      <a:StartPlayout>String</a:StartPlayout>
      <a:ZoneId>123</a:ZoneId>
    </a:ProofOfPlay>
  </ProofOfPlays>
</CampaignResponse>

The following is an example response Json body:
{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"ProofOfPlays":[
		{
			"AssetContentId":123,
			"BookingId":123,
			"BookingLoopId":123,
			"CampaignId":123,
			"FullPlayout":true,
			"Id":123,
			"MasterLoopAssetId":123,
			"Metadata":[
				{
					"Key":"String",
					"Value":"String"
				}
			],
			"PlayerId":"String",
			"PlayerType":"String",
			"PlayoutDuration":123,
			"SiteId":123,
			"StartPlayout":"String",
			"ZoneId":123
		}
	]
}