Batch Get Profile

customerprofiles_batch_get_profile

R Documentation

Get a batch of profiles

Description

Get a batch of profiles.

Usage

customerprofiles_batch_get_profile(DomainName, ProfileIds)

Arguments

DomainName

[required] The unique name of the domain.

ProfileIds

[required] List of unique identifiers for customer profiles to retrieve.

Value

A list with the following syntax:

list(
  Errors = list(
    list(
      Code = "string",
      Message = "string",
      ProfileId = "string"
    )
  ),
  Profiles = list(
    list(
      ProfileId = "string",
      AccountNumber = "string",
      AdditionalInformation = "string",
      PartyType = "INDIVIDUAL"|"BUSINESS"|"OTHER",
      BusinessName = "string",
      FirstName = "string",
      MiddleName = "string",
      LastName = "string",
      BirthDate = "string",
      Gender = "MALE"|"FEMALE"|"UNSPECIFIED",
      PhoneNumber = "string",
      MobilePhoneNumber = "string",
      HomePhoneNumber = "string",
      BusinessPhoneNumber = "string",
      EmailAddress = "string",
      PersonalEmailAddress = "string",
      BusinessEmailAddress = "string",
      Address = list(
        Address1 = "string",
        Address2 = "string",
        Address3 = "string",
        Address4 = "string",
        City = "string",
        County = "string",
        State = "string",
        Province = "string",
        Country = "string",
        PostalCode = "string"
      ),
      ShippingAddress = list(
        Address1 = "string",
        Address2 = "string",
        Address3 = "string",
        Address4 = "string",
        City = "string",
        County = "string",
        State = "string",
        Province = "string",
        Country = "string",
        PostalCode = "string"
      ),
      MailingAddress = list(
        Address1 = "string",
        Address2 = "string",
        Address3 = "string",
        Address4 = "string",
        City = "string",
        County = "string",
        State = "string",
        Province = "string",
        Country = "string",
        PostalCode = "string"
      ),
      BillingAddress = list(
        Address1 = "string",
        Address2 = "string",
        Address3 = "string",
        Address4 = "string",
        City = "string",
        County = "string",
        State = "string",
        Province = "string",
        Country = "string",
        PostalCode = "string"
      ),
      Attributes = list(
        "string"
      ),
      FoundByItems = list(
        list(
          KeyName = "string",
          Values = list(
            "string"
          )
        )
      ),
      PartyTypeString = "string",
      GenderString = "string"
    )
  )
)

Request syntax

svc$batch_get_profile(
  DomainName = "string",
  ProfileIds = list(
    "string"
  )
)