POST api/ContactListOnLabel?user={user}&password={password}&applicationName={applicationName}

Alle contactpersonen die zijn gekoppeld aan een label opvragen. Deze aanvraag werkt met paginering, er worden maximaal 100 personen per aanvraag geretourneerd.

Request Information

URI Parameters

NaamOmschrijvingTypeExtra informatie
user

E-mailadres van Mijn DATA-collectief account.

string

Vereist

password

Wachtwoord API koppeling.

string

Vereist

applicationName

Applicatienaam API koppeling.

string

Vereist

Body Parameters

ContactListOnLabelRequest
NaamOmschrijvingTypeExtra informatie
LabelName

Data-collectief labelnaam (Interessant, Niet interessant, Inschrijven voor e-mailings, Uitschrijven voor e-mailings)

string

Geen

CompanyID

Contactpersonen met geselecteerd label van een enkel bedrijf opvragen (0 = alle bedrijven).

integer

Geen

PageNumber

Paginanummer

integer

Geen

Request Formats

application/json, text/json

Voorbeeld:
{
  "LabelName": "voorbeeld string 1",
  "CompanyID": 2,
  "PageNumber": 3
}

application/xml, text/xml

Voorbeeld:
<ContactListOnLabelRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <LabelName>voorbeeld string 1</LabelName>
  <CompanyID>2</CompanyID>
  <PageNumber>3</PageNumber>
</ContactListOnLabelRequest>

Response Information

NaamOmschrijvingTypeExtra informatie
LabelName

Data-collectief labelnaam

string

Geen

TotalFound

Totaal aantal gevonden personen

integer

Geen

PageNumber

Paginanummer

integer

Geen

Contacts

Gepagineerde lijst van 100 DATA-collectief personen per aanvraag

Verzameling van ContactLimitedV2Result

Geen

Response Formats

application/json, text/json

Voorbeeld:
{
  "LabelName": "voorbeeld string 1",
  "TotalFound": 2,
  "PageNumber": 3,
  "Contacts": [
    {
      "ID": 1,
      "CompanyID": 2,
      "Name": "voorbeeld string 3",
      "FirstName": "voorbeeld string 4",
      "FunctionID": "voorbeeld string 5",
      "FunctionDescription": "voorbeeld string 6",
      "Gender": 0,
      "Deleted": true
    },
    {
      "ID": 1,
      "CompanyID": 2,
      "Name": "voorbeeld string 3",
      "FirstName": "voorbeeld string 4",
      "FunctionID": "voorbeeld string 5",
      "FunctionDescription": "voorbeeld string 6",
      "Gender": 0,
      "Deleted": true
    }
  ]
}

application/xml, text/xml

Voorbeeld:
<ContactListOnLabelResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <LabelName>voorbeeld string 1</LabelName>
  <TotalFound>2</TotalFound>
  <PageNumber>3</PageNumber>
  <Contacts>
    <ContactLimitedV2Result>
      <ID>1</ID>
      <CompanyID>2</CompanyID>
      <Name>voorbeeld string 3</Name>
      <FirstName>voorbeeld string 4</FirstName>
      <FunctionID>voorbeeld string 5</FunctionID>
      <FunctionDescription>voorbeeld string 6</FunctionDescription>
      <Gender>Male</Gender>
      <Deleted>true</Deleted>
    </ContactLimitedV2Result>
    <ContactLimitedV2Result>
      <ID>1</ID>
      <CompanyID>2</CompanyID>
      <Name>voorbeeld string 3</Name>
      <FirstName>voorbeeld string 4</FirstName>
      <FunctionID>voorbeeld string 5</FunctionID>
      <FunctionDescription>voorbeeld string 6</FunctionDescription>
      <Gender>Male</Gender>
      <Deleted>true</Deleted>
    </ContactLimitedV2Result>
  </Contacts>
</ContactListOnLabelResult>