POST api/Notifications/Subscribe

Serializes entire form and store the form as Json for later retrieval No validation

Request Information

URI Parameters

None.

Body Parameters

CreateSubscriberRequest
NameDescriptionTypeAdditional information
Email

string

None.

Name

string

None.

Format

string

None.

CountryCode

string

None.

PhoneNumber

string

None.

ExternalId

string

None.

MailingListId

string

None.

UpdateIfExists

string

None.

DemDataFields

Collection of Pair of string [key] and string [value]

None.

BasisbankReferenceId

BasisbankReferenceId

None.

Retailer

Retailer

None.

DynamicFields

Collection of Pair of string [key] and string [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "Email": "sample string 1",
  "Name": "sample string 2",
  "Format": "sample string 3",
  "CountryCode": "sample string 4",
  "PhoneNumber": "sample string 5",
  "ExternalId": "sample string 6",
  "MailingListId": "sample string 7",
  "UpdateIfExists": "sample string 8",
  "DemDataFields": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "BasisbankReferenceId": {
    "ReferenceId": 1
  },
  "Retailer": {
    "CompanyId": 1,
    "RetailerId": 2,
    "EntryType": 3,
    "PinCode": 0,
    "ProductId": 4,
    "ProductCode": "sample string 5",
    "Signature": "sample string 6"
  },
  "DynamicFields": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "Flags": []
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CreateSubscriberResponse
NameDescriptionTypeAdditional information
Code

integer

None.

Message

string

None.

Result

integer

None.

BasisbankReferenceId

Reference id associated with the request

BasisbankReferenceId

None.

Success

Indicates if the request was processed successfully

boolean

None.

ErrorDetails

Failure details, will be present in case of an internal error.

Exception

None.

DynamicFields

Collection of Pair of string [key] and string [value]

None.

Flags

Collection of Flag

None.

Response Formats

application/json, text/json

Sample:
{
  "Code": 1,
  "Message": "sample string 2",
  "Result": 3,
  "BasisbankReferenceId": {
    "ReferenceId": 1
  },
  "Success": false,
  "ErrorDetails": {
    "ClassName": "System.Exception",
    "Message": null,
    "Data": null,
    "InnerException": null,
    "HelpURL": "sample string 1",
    "StackTraceString": null,
    "RemoteStackTraceString": null,
    "RemoteStackIndex": 0,
    "ExceptionMethod": null,
    "HResult": 3,
    "Source": "sample string 2",
    "WatsonBuckets": null
  },
  "DynamicFields": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "Flags": [
    {
      "Name": "sample string 1",
      "FlaggedBy": "sample string 2",
      "Type": "sample string 3",
      "IsPersisted": true,
      "Flagged": "2019-05-22T17:56:58.8595136+02:00"
    },
    {
      "Name": "sample string 1",
      "FlaggedBy": "sample string 2",
      "Type": "sample string 3",
      "IsPersisted": true,
      "Flagged": "2019-05-22T17:56:58.8595136+02:00"
    }
  ]
}
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body