DecodeCard

Request


GET https://api.domec.tools/v1.0/decoder/{card:string}?type=<integer>

Parameters

The DecodeCard receive the following parameters in the input.

Name	Type	Data Type	Mandatory
card	path	string
type	query	DecodeCodeType

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

{
  "SerialNumber": "",
  "WebSerialNumber": "",
  "ExternalSerialNumber": "",
  "PartnerAssociationCode": "",
  "Email": "",
  "ResultStatus": "",
  "ResultMessage": "",
  "ResultCode": 0
}

The DecodeResultViewModel has the following properties

Name	Data Type	Description
SerialNumber	string	The serial Number of the decoded card. This is the 34 cipher identifier of the Domec Card
WebSerialNumber	string	The serial Number of the decoded card. This is the 34 cipher identifier of the Domec Card
ExternalSerialNumber	string	The serial Number of the decoded card. This is the 34 cipher identifier of the Domec Card
PartnerAssociationCode	string	The Partner association code for the card. This field is empty if the card is not referenced by any partner
Email	string	The Email associated with the card. This field is empty if the card is not associated to any email
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.

{
  "ResultStatus": "",
  "ResultMessage": "",
  "ResultCode": 0
}

The ResultWithMessage has the following properties

Name	Data Type	Description
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.

{
  "ResultStatus": "",
  "ResultMessage": "",
  "ResultCode": 0
}

The ResultWithMessage has the following properties

Name	Data Type	Description
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.

DecodeCard

Request

Parameters

Responses

200 - DecodeResultViewModel

400 - ResultWithMessage

404 - ResultWithMessage