POST Api/Customer/ListByAccount

Searches for existing enrolled customers in the system by using Reference Number and Other Data.

Request Information

URI Parameters

None.

Body Parameters

APICustomerListRequestModel
NameDescriptionTypeAdditional information
OtherData

string

Required

ReferenceNumber

string

Required

Request Formats

application/json, text/json

Sample:
{
  "ReferenceNumber": "sample string 1",
  "OtherData": "sample string 2"
}

Response Information

Resource Description

Searches for existing enrolled customers in the system by using Reference Number and Other Data.

APICustomerListResponseModel
NameDescriptionTypeAdditional information
ErrorCode

Name of the error condition. See ErrorCode model for details.

ErrorCode

None.

ErrorID

Internal error identification number that uniquely identifies this specific error that occurred.

string

None.

ErrorNum

Numeric value of the ErrorCode

int

None.

Errors

List of errors that occurred when performing the customer operation.

Collection of string

None.

Result

Collection of CustomerListResponseModel

None.

Success

Indicates sucess or failure of the REST request.

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "ErrorCode": "None",
  "ErrorID": "sample string 1",
  "ErrorNum": 0,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Result": [
    {
      "Address": "sample string 1",
      "Address2": "sample string 2",
      "City": "sample string 3",
      "CompanyName": "sample string 4",
      "Country": "sample string 5",
      "CustomerToken": "sample string 6",
      "DisplayName": "sample string 7",
      "Email": "sample string 8",
      "FirstName": "sample string 9",
      "ID": 10,
      "LastName": "sample string 11",
      "LinkStatus": "Principal",
      "MobilePhone": "sample string 12",
      "Phone": "sample string 13",
      "State": "sample string 14",
      "Zip": "sample string 15"
    },
    {
      "Address": "sample string 1",
      "Address2": "sample string 2",
      "City": "sample string 3",
      "CompanyName": "sample string 4",
      "Country": "sample string 5",
      "CustomerToken": "sample string 6",
      "DisplayName": "sample string 7",
      "Email": "sample string 8",
      "FirstName": "sample string 9",
      "ID": 10,
      "LastName": "sample string 11",
      "LinkStatus": "Principal",
      "MobilePhone": "sample string 12",
      "Phone": "sample string 13",
      "State": "sample string 14",
      "Zip": "sample string 15"
    }
  ],
  "Success": true
}