Class EnrolRequest

Represents a request to allow a device to request the client id and secret required to request authorisation tokens.

Inheritance

Object

ZipRequestOptionsBase

EnrolRequest

Inherited Members

ZipRequestOptionsBase.GetCustomHttpHeaders()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Yort.Zip.InStore

Assembly: Yort.Zip.InStore.dll

Syntax

public class EnrolRequest : ZipRequestOptionsBase

Properties

ActivationCode

The activation code generated in the Zip merchant portal. Required.

Declaration

public string ActivationCode { get; set; }

Property Value

Type	Description
String

Secret

The secret used when generating the activation code in the Zip merchant portal. Required.

Declaration

public string Secret { get; set; }

Property Value

Type	Description
String

Terminal

The name of the terminal being enroled. Required.

Declaration

public string Terminal { get; set; }

Property Value

Type	Description
String

Methods

ApplyDefaults(ZipClientConfiguration)

Applies the default store id, terminal id and operator if appropriate.

Declaration

public override void ApplyDefaults(ZipClientConfiguration config)

Parameters

Type	Name	Description
ZipClientConfiguration	config	A ZipClientConfiguration instance containing the default values to use.

Overrides

ZipRequestOptionsBase.ApplyDefaults(ZipClientConfiguration)

Validate()

Validates this request as much as possible prior to sending it to the Zip API.

Declaration

public override void Validate()

Overrides

ZipRequestOptionsBase.Validate()

Exceptions

Type	Condition
ArgumentNullException	Thrown if any required properties are null.
ArgumentException	Thrown if any of request properties are invalid.