SearchEntityTypes

CampaignService / SearchEntityTypes

Description: Search entitype

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

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.CategoryType	Nexus.AppSpace.Service.Contract.Model.Enums.Campaign.CategoryType	True
Request.OwnerID	integer	True

Response:

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

Parameter	Type
Response.EntityTypes	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.Campaign.EntityType[]

Enums:

Field	Name	Values
CategoryType	Nexus.AppSpace.Service.Contract.Model.Enums.Campaign.CategoryType	Undefined = 0, Asset = 1, Client = 2, Zone = 3, Campaign = 4, Booking = 5, Site = 6, Emergency = 7

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">
  <CategoryType>Emergency</CategoryType>
  <OwnerID>123</OwnerID>
</CampaignRequest>

The following is an example request Json body:

{
	"CategoryType":7,
	"OwnerID":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>
  <EntityTypes xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.Campaign">
    <a:EntityType>
      <a:CategoryType>Emergency</a:CategoryType>
      <a:Code>String</a:Code>
      <a:ColorCode>String</a:ColorCode>
      <a:Description>String</a:Description>
      <a:Id>123</a:Id>
      <a:Name>String</a:Name>
      <a:OwnerId>123</a:OwnerId>
    </a:EntityType>
  </EntityTypes>
</CampaignResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"EntityTypes":[
		{
			"CategoryType":7,
			"Code":"String",
			"ColorCode":"String",
			"Description":"String",
			"Id":123,
			"Name":"String",
			"OwnerId":123
		}
	]
}