1. v3
  2. Contacts
  3. GET - 3/contacts/import/configs/{importconfigid}

Definition

GET - 3/contacts/import/configs/{importConfigId}

Retrieve an existing import configuration by its id.

This method will result in a 204 response if there is no import configuration found for the requested id.

Request information

importConfigId

The id of the import configuration you want to retrieve.


Type integer
Additional info
Required

Response information

Payload containing the requested import configuration.


Meta

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


Type MetaData
Data

The actual data returned by the request.


Type 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.


Type Hateoas

Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-11-21T11:17:15.4693326Z",
    "IsFiltered": true
  },
  "Data": {
    "ImportConfigId": 1,
    "IsCustom": true,
    "UserId": 3,
    "BackOfficeUserId": 1,
    "SendAnswerNotification": true,
    "Name": "sample string 7",
    "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 8",
    "FirstRow": 1,
    "FieldDelimiter": "sample string 9",
    "RowDelimiter": "sample string 10",
    "SendNotificationMail": true,
    "IsReusable": true,
    "DefaultLanguageCode": "sample string 13",
    "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 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 8</DateFormat>
    <DefaultLanguageCode>sample string 13</DefaultLanguageCode>
    <EmailIsRequired>true</EmailIsRequired>
    <EmailMustBeUniqueWithinAccount>true</EmailMustBeUniqueWithinAccount>
    <EmailMustBeUniqueWithinFile>true</EmailMustBeUniqueWithinFile>
    <EmailMustBeUniqueWithinGroup>true</EmailMustBeUniqueWithinGroup>
    <FieldDelimiter>sample string 9</FieldDelimiter>
    <FirstRow>1</FirstRow>
    <IsReusable>true</IsReusable>
    <Name>sample string 7</Name>
    <RowDelimiter>sample string 10</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>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2024-11-21T11:17:15.4693326+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>