Home MyWinMed API Documentation

Ehr.Api.Responses.IServerResponse Interface Reference

IServerResponse Properties
ResponseStatus	Status [get, set]
	The resulting status of the operation
string	Message [get, set]
	Any message returned as a result of the operation

Property Documentation

Message

string Ehr.Api.Responses.IServerResponse.Message

getset

Any message returned as a result of the operation

Status

ResponseStatus  Ehr.Api.Responses.IServerResponse.Status

getset

The resulting status of the operation

Ehr.Api.Responses.ServerResponse Class Reference

Object used for describing a result of an operation made on the server that also returns a result

Public Member Functions
	ServerResponse (T result)
	Initializes a new instance of the ServerResponse<T> class. Status is Success by default.
	ServerResponse (T result, ResponseStatus  status)
	Initializes a new instance of the ServerResponse<T> class. Status is Success by default.
	ServerResponse (string message, ResponseStatus  status=ResponseStatus.Fail)
	Initializes a new instance of the Responses.ServerResponse<T> class. Status is Fail by default.
	ServerResponse (string message, ResponseStatus > status=ResponseStatus.Fail, T result=default(T))
	Initializes a new instance of the ServerResponse<T> class. Status is Fail by default.
	ServerResponse (Exception ex)
	Initializes a new instance of the ServerResponse<T> class. Status is Fail by default.

Properties
ResponseStatus	Status [get, set]
	Gets or sets resulting status of operation
string	Message [get, set]
	Gets or sets additional details regarding the status of the operation
T	Result [get, set]
	Gets or sets result returned by the operation
Properties inherited from Ehr.Api.Responses.IServerResponse
ResponseStatus	Status [get, set]
	The resulting status of the operation
string	Message [get, set]
	Any message returned as a result of the operation

Detailed Description

Object used for describing a result of an operation made on the server that also returns a result

Template Parameters

T	object type

Constructor & Destructor Documentation

ServerResponse() [1/6]

Ehr.Api.Responses.ServerResponse< T >.ServerResponse

(

T

result

)

Initializes a new instance of the ServerResponse<T> class. Status is Success by default.

Parameters

result

The result returned from the operation

ServerResponse() [2/6]

Ehr.Api.Responses.ServerResponse< T >.ServerResponse	(	T	result,
		ResponseStatus	status
	)

Initializes a new instance of the ServerResponse<T> class. Status is Success by default.

Parameters

result	The result returned from the operation
status	The status of the response

ServerResponse() [3/6]

Ehr.Api.Responses.ServerResponse< T >.ServerResponse	(	string	message,
		ResponseStatus	status = ResponseStatus.Fail
	)

Initializes a new instance of the Responses.ServerResponse<T> class. Status is Fail by default.

Parameters

message	Additional information about the reponse
status	The status of the response

ServerResponse() [4/6]

Ehr.Api.Responses.ServerResponse< T >.ServerResponse	(	string	message,
		ResponseStatus	status = ResponseStatus.Fail,
		T	result = default(T)
	)

Initializes a new instance of the ServerResponse<T> class. Status is Fail by default.

Parameters

message	Additional information about the reponse
status	The status of the response
result	The result returned from the operation

ServerResponse() [5/6]

Ehr.Api.Responses.ServerResponse< T >.ServerResponse	(	string	message,
	)

Initializes a new instance of the ServerResponse<T> class. Status is Fail by default.

Parameters

message

Additional information about the reponse

ServerResponse() [6/6]

Ehr.Api.Responses.ServerResponse< T >.ServerResponse

(

Exception

ex

)

Initializes a new instance of the ServerResponse<T> class. Status is Fail by default.

Parameters

ex	exception object

Property Documentation

Message

string Ehr.Api.Responses.ServerResponse< T >.Message

getset

Gets or sets additional details regarding the status of the operation

Result

T Ehr.Api.Responses.ServerResponse< T >.Result

getset

Gets or sets result returned by the operation

Status

ResponseStatus  Ehr.Api.Responses.ServerResponse< T >.Status

getset

Gets or sets resulting status of operation