GET api/v1/Points?contactId={contactId}&type={type}&datetimeFrom={datetimeFrom}&datetimeTo={datetimeTo}

Retrieve array of points for specified contact.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
contactId

Id of contact to retrieve points for

integer

Required

type

Type of points to retrieve

string

None.

datetimeFrom

Start datetime of points to retrieve

date

None.

datetimeTo

End datetime of points to retrieve

date

None.

Body Parameters

None.

Response Information

Resource Description

Collection of ReadPointDto
NameDescriptionTypeAdditional information
Id

Unique id of the point

integer

None.

ContactId

Id of contact

integer

None.

ContactCompanyId

Id of ContactCompany. Applies only if the contact is associated with a company.

integer

None.

Type

Type of point

string

Max length: 32

Amount

Amount of point

decimal number

None.

Sum

The sum of all the points with the same contact id and type when the point was created

decimal number

None.

DateTime

Creation datetime of the point

date

None.

Description

Description of point

string

None.

SourceId

Id of source

string

Max length: 255

SourceDescription

Description of source

string

None.

StoreId

Id of store for the point

integer

None.

AdministratorId

Id of administrator who created the point

integer

None.

BookValue

Value of the point for bookkeeping

decimal number

None.

SubType

SubType of point

string

Max length: 32

PointCalculationBase

The original value the point value was calculated from

decimal number

None.

ConverterTransactionId

The transaction id of a converter

integer

None.

IsCanceller

Idicates if this point is a canceller point

boolean

None.

CancellerPointId

An id of the point that cancelled this point

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "ContactId": 1,
    "ContactCompanyId": 1,
    "Type": "sample string 2",
    "Amount": 3.0,
    "Sum": 4.0,
    "DateTime": "2024-07-19T06:21:09.1841728+00:00",
    "Description": "sample string 6",
    "SourceId": "sample string 7",
    "SourceDescription": "sample string 8",
    "StoreId": 1,
    "AdministratorId": 1,
    "BookValue": 1.0,
    "SubType": "sample string 9",
    "PointCalculationBase": 1.0,
    "ConverterTransactionId": 1,
    "IsCanceller": true,
    "CancellerPointId": 1
  },
  {
    "Id": 1,
    "ContactId": 1,
    "ContactCompanyId": 1,
    "Type": "sample string 2",
    "Amount": 3.0,
    "Sum": 4.0,
    "DateTime": "2024-07-19T06:21:09.1841728+00:00",
    "Description": "sample string 6",
    "SourceId": "sample string 7",
    "SourceDescription": "sample string 8",
    "StoreId": 1,
    "AdministratorId": 1,
    "BookValue": 1.0,
    "SubType": "sample string 9",
    "PointCalculationBase": 1.0,
    "ConverterTransactionId": 1,
    "IsCanceller": true,
    "CancellerPointId": 1
  }
]