Holder update

Update the user associated to a coupon.

Request


PUT https://api.domec.tools/v1.0/cp/{couponCode:string}/holder

Request Body


{
  "Email": "",
  "Password": "",
  "FirstName": "",
  "LastName": "",
  "AuthorizationPin": "",
  "Approvals": "",
  "SecurityActivationToken": "",
  "BirthDate": "",
  "FiscalCode": "",
  "BirthPlace": "",
  "Gender": {},
  "Address": "",
  "City": "",
  "Zip": "",
  "District": "",
  "BirthAddress": "",
  "BirthCity": "",
  "BirthZip": "",
  "BirthDistrict": "",
  "DomicileAddress": "",
  "DomicileCity": "",
  "DomicileZip": "",
  "DomicileDistrict": "",
  "PartnerCode": "",
  "AssociationCode": "",
  "Device": {
    "Token": "",
    "Os": "",
    "DeviceIdiom": "",
    "DeviceUniqueID": ""
  }
}

Parameters

The Holder update receive the following parameters in the input.

Name	Type	Data Type	Mandatory
couponCode	path	string
model	body	ExtendedCardDataViewModel

Responses

The following HTTP status codes may be returned, optionally with a response resource

Status code	Description	Response body
200	OK Success	View body
400	BadRequest The input request contains errors which prevents executing the request	View body
404	NotFound Endpoint not found	View body

{
  "StartDate": "",
  "EndDate": "",
  "Value": 0.0,
  "UsageCount": 0,
  "ServiceType": 0,
  "CouponImage": "",
  "Holder": {
    "Email": "",
    "Password": "",
    "FirstName": "",
    "LastName": "",
    "AuthorizationPin": "",
    "Approvals": "",
    "SecurityActivationToken": "",
    "BirthDate": "",
    "FiscalCode": "",
    "BirthPlace": "",
    "Gender": {},
    "Address": "",
    "City": "",
    "Zip": "",
    "District": "",
    "BirthAddress": "",
    "BirthCity": "",
    "BirthZip": "",
    "BirthDistrict": "",
    "DomicileAddress": "",
    "DomicileCity": "",
    "DomicileZip": "",
    "DomicileDistrict": "",
    "PartnerCode": "",
    "AssociationCode": "",
    "Device": {
      "Token": "",
      "Os": "",
      "DeviceIdiom": "",
      "DeviceUniqueID": ""
    }
  },
  "Status": 0,
  "CurrentUsage": 0,
  "IsValid": false,
  "ResultStatus": "",
  "ResultMessage": "",
  "ResultCode": 0
}

The CouponInfoResultViewModel has the following properties

Name	Data Type	Description
StartDate	string	Begin date of the couponing campaign
EndDate	string	End date of the couponing campaign
Value	decimal	Discount value of the couponing campaign
UsageCount	integer	Number of uses of a coupon
ServiceType	integer	ServiceType
CouponImage	string	Image of a coupon
Holder	ExtendedCardDataViewModel	Coupon Holder
Status	integer	Coupon Status
CurrentUsage	integer	CurrentUsage
IsValid	boolean	If the coupon is valid
ResultStatus	string	Result status of the operation. It can assume the following values OKNOK
ResultMessage	string	Contains a descriptive message of the problem occurred in case of error.
ResultCode	integer	Contains a numeric error code useful to understand the specific error occurred. Have a look at APIError for further details.

{
  "StartDate": "",
  "EndDate": "",
  "Value": 0.0,
  "UsageCount": 0,
  "ServiceType": 0,
  "CouponImage": "",
  "Holder": {
    "Email": "",
    "Password": "",
    "FirstName": "",
    "LastName": "",
    "AuthorizationPin": "",
    "Approvals": "",
    "SecurityActivationToken": "",
    "BirthDate": "",
    "FiscalCode": "",
    "BirthPlace": "",
    "Gender": {},
    "Address": "",
    "City": "",
    "Zip": "",
    "District": "",
    "BirthAddress": "",
    "BirthCity": "",
    "BirthZip": "",
    "BirthDistrict": "",
    "DomicileAddress": "",
    "DomicileCity": "",
    "DomicileZip": "",
    "DomicileDistrict": "",
    "PartnerCode": "",
    "AssociationCode": "",
    "Device": {
      "Token": "",
      "Os": "",
      "DeviceIdiom": "",
      "DeviceUniqueID": ""
    }
  },
  "Status": 0,
  "CurrentUsage": 0,
  "IsValid": false,
  "ResultStatus": "",
  "ResultMessage": "",
  "ResultCode": 0
}

The CouponInfoResultViewModel has the following properties

Name	Data Type	Description
StartDate	string	Begin date of the couponing campaign
EndDate	string	End date of the couponing campaign
Value	decimal	Discount value of the couponing campaign
UsageCount	integer	Number of uses of a coupon
ServiceType	integer	ServiceType
CouponImage	string	Image of a coupon
Holder	ExtendedCardDataViewModel	Coupon Holder
Status	integer	Coupon Status
CurrentUsage	integer	CurrentUsage
IsValid	boolean	If the coupon is valid
ResultStatus	string	Result status of the operation. It can assume the following values OKNOK
ResultMessage	string	Contains a descriptive message of the problem occurred in case of error.
ResultCode	integer	Contains a numeric error code useful to understand the specific error occurred. Have a look at APIError for further details.

{
  "StartDate": "",
  "EndDate": "",
  "Value": 0.0,
  "UsageCount": 0,
  "ServiceType": 0,
  "CouponImage": "",
  "Holder": {
    "Email": "",
    "Password": "",
    "FirstName": "",
    "LastName": "",
    "AuthorizationPin": "",
    "Approvals": "",
    "SecurityActivationToken": "",
    "BirthDate": "",
    "FiscalCode": "",
    "BirthPlace": "",
    "Gender": {},
    "Address": "",
    "City": "",
    "Zip": "",
    "District": "",
    "BirthAddress": "",
    "BirthCity": "",
    "BirthZip": "",
    "BirthDistrict": "",
    "DomicileAddress": "",
    "DomicileCity": "",
    "DomicileZip": "",
    "DomicileDistrict": "",
    "PartnerCode": "",
    "AssociationCode": "",
    "Device": {
      "Token": "",
      "Os": "",
      "DeviceIdiom": "",
      "DeviceUniqueID": ""
    }
  },
  "Status": 0,
  "CurrentUsage": 0,
  "IsValid": false,
  "ResultStatus": "",
  "ResultMessage": "",
  "ResultCode": 0
}

The CouponInfoResultViewModel has the following properties

Name	Data Type	Description
StartDate	string	Begin date of the couponing campaign
EndDate	string	End date of the couponing campaign
Value	decimal	Discount value of the couponing campaign
UsageCount	integer	Number of uses of a coupon
ServiceType	integer	ServiceType
CouponImage	string	Image of a coupon
Holder	ExtendedCardDataViewModel	Coupon Holder
Status	integer	Coupon Status
CurrentUsage	integer	CurrentUsage
IsValid	boolean	If the coupon is valid
ResultStatus	string	Result status of the operation. It can assume the following values OKNOK
ResultMessage	string	Contains a descriptive message of the problem occurred in case of error.
ResultCode	integer	Contains a numeric error code useful to understand the specific error occurred. Have a look at APIError for further details.

Holder update

Request

Request Body

Parameters

Responses

200 - CouponInfoResultViewModel

400 - CouponInfoResultViewModel

404 - CouponInfoResultViewModel