POST /external/api/v3/customer/addlock

Add lock.

Request Information

URI Parameters

None.

Body Parameters

AddLockRequest
NameDescriptionTypeAdditional informationNullable
CreationDate

Creation date. If not provided, the current date and time will be used.

date

None

True
OptIn

Boolean to enable opt-in.

boolean

None

True
QuestionnaireId

Questionnaire ID.

globally unique identifier

None

True
CustomerId

Customer ID.

integer

None

True
Email

Email address.

string

None

False
Data

Collection of customer data.

Collection of CustomerData

None

False

Request Formats

application/json

Sample:
{
  "CreationDate": "2024-12-07T17:14:26.5545804+01:00",
  "OptIn": true,
  "QuestionnaireId": "4f05e201-e343-4cf5-bfb6-2cfc15df94b2",
  "CustomerId": 1,
  "Email": "sample string 1",
  "Data": [
    {
      "CustomerDataColumnId": 1,
      "Name": "sample string 2",
      "Value": "sample string 3",
      "IsEncrypted": true,
      "CertificateThumbprint": "sample string 5",
      "EncryptionKey": "sample string 6"
    },
    {
      "CustomerDataColumnId": 1,
      "Name": "sample string 2",
      "Value": "sample string 3",
      "IsEncrypted": true,
      "CertificateThumbprint": "sample string 5",
      "EncryptionKey": "sample string 6"
    }
  ]
}

application/xml

Sample:
<AddLockRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V3.Requests">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
    <d2p1:CustomerData>
      <d2p1:CertificateThumbprint>sample string 5</d2p1:CertificateThumbprint>
      <d2p1:CustomerDataColumnId>1</d2p1:CustomerDataColumnId>
      <d2p1:EncryptionKey>sample string 6</d2p1:EncryptionKey>
      <d2p1:IsEncrypted>true</d2p1:IsEncrypted>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:CustomerData>
    <d2p1:CustomerData>
      <d2p1:CertificateThumbprint>sample string 5</d2p1:CertificateThumbprint>
      <d2p1:CustomerDataColumnId>1</d2p1:CustomerDataColumnId>
      <d2p1:EncryptionKey>sample string 6</d2p1:EncryptionKey>
      <d2p1:IsEncrypted>true</d2p1:IsEncrypted>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:CustomerData>
  </Data>
  <Email>sample string 1</Email>
  <CreationDate>2024-12-07T17:14:26.5545804+01:00</CreationDate>
  <CustomerId>1</CustomerId>
  <OptIn>true</OptIn>
  <QuestionnaireId>4f05e201-e343-4cf5-bfb6-2cfc15df94b2</QuestionnaireId>
</AddLockRequest>

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.

Response Status Codes

Status Code Name Description
200 OK The request has succeeded.
400 Bad Request Fulfilling the request would cause an invalid state. Request needs modification.
401 Unauthorized Missing or invalid authentication token.
403 Forbidden Server refuses to authorize the request.
408 Request Timeout The server timed out waiting for the request.
429 Too Many Requests Too many requests in a given amount of time.
500 Internal Server Error The server encountered an unexpected condition which prevented it from fulfilling the request.
503 Service Unavailable The server is unable to proces the request at the moment, try again later.