Skip to main content

​
Class PluginResponse

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for PluginResponse. PluginResponse exists to be able to respond with more than just a true/false, but also an explanation. Such an explanation can be displayed on for instance a disabled “Place Order” button.

​
Inheritance

object ← Carrier ← PluginResponse

​
Inherited Members

Carrier.TableRight, Carrier.FieldProperties, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

​
Constructors

​
PluginResponse()

Default constructor - defaults any enum props to 0.

​
Properties

​
Changes

Tablename/recordid of data changed by this method, that the client may need to reload

​
Property Value

ChangedData

​
ErrorCode

An error code, if available.

​
Property Value

string

​
IsOk

Answer to the question / An indication if the operation went well. Equivalent to Status != Error

​
Property Value

bool

​
Status

QuoteStatus = Ok / OkWithInfo / Warn / Error. Error implies IsOk = false. NULL if unknown enum value.

​
Property Value

QuoteStatus?

​
See Also

PluginResponse.Status_String

​
Status_String

QuoteStatus = Ok / OkWithInfo / Warn / Error. Error implies IsOk = false. Raw string enum value.

​
Property Value

string

​
See Also

PluginResponse.Status

​
TechExplanation

Always in English

​
Property Value

string

​
UserExplanation

A localized explanation to the answer. Text here is displayed to the user.

​
Property Value

string

​
See Also

QuoteAgent

Related topics

WebAPI changes in SuperOffice 12.0WebAPI changes in SuperOffice 12.1WebAPI changes in SuperOffice 12.2SuperOffice WebApiHow to use SuperOffice.WebApiReject Quote VersionApprove Quote Version