RetrieveClients

 

CampaignService / RetrieveClients

 

Description: Retrieve Clients

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

Method: GET

Token Required: True


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

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

Parameter Type
Response.Clients Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.Campaign.Client[]

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>
  <Clients xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.Campaign">
    <a:Client>
      <a:Code>String</a:Code>
      <a:CreatedAt>2014-04-24T17:53:43.3613343Z</a:CreatedAt>
      <a:CreatedBy>String</a:CreatedBy>
      <a:DeletedAt>2014-04-24T17:53:43.3613343Z</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.3613343Z</a:LastUpdatedAt>
      <a:LastUpdatedBy>String</a:LastUpdatedBy>
      <a:TypeId>123</a:TypeId>
      <a:AccountId>123</a:AccountId>
      <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:Client>
  </Clients>
</CampaignResponse>

The following is an example response Json body:
{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"Clients":[
		{
			"Code":"String",
			"CreatedAt":"\/Date(1398362023361)\/",
			"CreatedBy":"String",
			"DeletedAt":"\/Date(1398362023361)\/",
			"DeletedBy":"String",
			"Guid":"11111111-1111-1111-1111-111111111111",
			"Id":123,
			"LastUpdatedAt":"\/Date(1398362023361)\/",
			"LastUpdatedBy":"String",
			"TypeId":123,
			"AccountId":123,
			"Metadata":[
				{
					"Key":"String",
					"Value":"String"
				}
			],
			"Name":"String",
			"OwnerId":123
		}
	]
}