Definition

GET - 3/contacts/import/configs?top={top}&skip={skip}&select={select}&filter={filter}&orderby={orderby}&expand={expand}

Retrieve the existing import configurations.

Request information

NameDescriptionTypeAdditional information
top

Select only the first N import configurations of the list.

string

Optional, Default value is 25

skip

Skip the first N import configurations of the list.

string

Optional

select

Define the properties which you want in the result. If empty all not-empty properties are returned.

string

Optional

filter

Select only the import configurations that satisfy the predicate expression.

string

Optional

orderby

Define the properties which are used to order the list of import configurations.

string

Optional

expand

With the expand, you can retrieve additional information about the import configurations. This information is by default hidden when retrieving a list.

string

Optional

Response information

Payload containing a list of import configurations.


NameDescriptionTypeAdditional information
Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.

MetaData

Data

The actual data returned by the request.

Collection of ImportConfig

Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.

Hateoas

Sample:
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2019-02-21T13:31:49.0942811Z",
    "IsFiltered": true
  },
  "Data": [
    {
      "ImportConfigId": 1,
      "IsCustom": true,
      "UserId": 3,
      "BackOfficeUserId": 1,
      "SendAnswerNotification": true,
      "Name": "sample string 6",
      "ContactGroupId": 1,
      "ContactListId": 1,
      "SurveySettings": {
        "SurveyId": 1,
        "InvitationDelayInDays": 1,
        "InvitationTime": "00:00:00.1234567",
        "ExpirationAfterDays": 1,
        "ExpirationTime": "00:00:00.1234567",
        "ConsiderCooldownPeriod": true,
        "SurveyCooldownAfterInvitation": 1,
        "SurveyCooldownAfterResponse": 1,
        "AccountCooldownAfterInvitation": 1,
        "AccountCooldownAfterResponse": 1
      },
      "ColumnMappings": [
        {
          "SourceColumnNumber": 64,
          "TargetColumnName": "sample string 2"
        },
        {
          "SourceColumnNumber": 64,
          "TargetColumnName": "sample string 2"
        }
      ],
      "EmailMustBeUniqueWithinAccount": true,
      "EmailMustBeUniqueWithinGroup": true,
      "EmailMustBeUniqueWithinFile": true,
      "EmailIsRequired": true,
      "DateFormat": "sample string 7",
      "FirstRow": 1,
      "FieldDelimiter": "sample string 8",
      "RowDelimiter": "sample string 9",
      "SendNotificationMail": true,
      "IsReusable": true,
      "DefaultLanguageCode": "sample string 12",
      "UpdateTypeId": 1
    },
    {
      "ImportConfigId": 1,
      "IsCustom": true,
      "UserId": 3,
      "BackOfficeUserId": 1,
      "SendAnswerNotification": true,
      "Name": "sample string 6",
      "ContactGroupId": 1,
      "ContactListId": 1,
      "SurveySettings": {
        "SurveyId": 1,
        "InvitationDelayInDays": 1,
        "InvitationTime": "00:00:00.1234567",
        "ExpirationAfterDays": 1,
        "ExpirationTime": "00:00:00.1234567",
        "ConsiderCooldownPeriod": true,
        "SurveyCooldownAfterInvitation": 1,
        "SurveyCooldownAfterResponse": 1,
        "AccountCooldownAfterInvitation": 1,
        "AccountCooldownAfterResponse": 1
      },
      "ColumnMappings": [
        {
          "SourceColumnNumber": 64,
          "TargetColumnName": "sample string 2"
        },
        {
          "SourceColumnNumber": 64,
          "TargetColumnName": "sample string 2"
        }
      ],
      "EmailMustBeUniqueWithinAccount": true,
      "EmailMustBeUniqueWithinGroup": true,
      "EmailMustBeUniqueWithinFile": true,
      "EmailIsRequired": true,
      "DateFormat": "sample string 7",
      "FirstRow": 1,
      "FieldDelimiter": "sample string 8",
      "RowDelimiter": "sample string 9",
      "SendNotificationMail": true,
      "IsReusable": true,
      "DefaultLanguageCode": "sample string 12",
      "UpdateTypeId": 1
    }
  ]
}
Sample:
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>
    <ImportConfig z:Id="i2">
      <ColumnMappings>
        <ImportColumnMapping>
          <SourceColumnNumber>64</SourceColumnNumber>
          <TargetColumnName>sample string 2</TargetColumnName>
        </ImportColumnMapping>
        <ImportColumnMapping>
          <SourceColumnNumber>64</SourceColumnNumber>
          <TargetColumnName>sample string 2</TargetColumnName>
        </ImportColumnMapping>
      </ColumnMappings>
      <ContactGroupId>1</ContactGroupId>
      <ContactListId>1</ContactListId>
      <DateFormat>sample string 7</DateFormat>
      <DefaultLanguageCode>sample string 12</DefaultLanguageCode>
      <EmailIsRequired>true</EmailIsRequired>
      <EmailMustBeUniqueWithinAccount>true</EmailMustBeUniqueWithinAccount>
      <EmailMustBeUniqueWithinFile>true</EmailMustBeUniqueWithinFile>
      <EmailMustBeUniqueWithinGroup>true</EmailMustBeUniqueWithinGroup>
      <FieldDelimiter>sample string 8</FieldDelimiter>
      <FirstRow>1</FirstRow>
      <IsReusable>true</IsReusable>
      <Name>sample string 6</Name>
      <RowDelimiter>sample string 9</RowDelimiter>
      <SendNotificationMail>true</SendNotificationMail>
      <SurveySettings>
        <AccountCooldownAfterInvitation>1</AccountCooldownAfterInvitation>
        <AccountCooldownAfterResponse>1</AccountCooldownAfterResponse>
        <ConsiderCooldownPeriod>true</ConsiderCooldownPeriod>
        <ExpirationAfterDays>1</ExpirationAfterDays>
        <ExpirationTime>PT0.1234567S</ExpirationTime>
        <InvitationDelayInDays>1</InvitationDelayInDays>
        <InvitationTime>PT0.1234567S</InvitationTime>
        <SurveyCooldownAfterInvitation>1</SurveyCooldownAfterInvitation>
        <SurveyCooldownAfterResponse>1</SurveyCooldownAfterResponse>
        <SurveyId>1</SurveyId>
      </SurveySettings>
      <UpdateTypeId>1</UpdateTypeId>
      <BackOfficeUserId>1</BackOfficeUserId>
      <ImportConfigId>1</ImportConfigId>
      <IsCustom>true</IsCustom>
      <SendAnswerNotification>true</SendAnswerNotification>
      <UserId>3</UserId>
    </ImportConfig>
    <ImportConfig z:Ref="i2" />
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2019-02-21T13:31:49.0942811+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>