WallBee.ProductFee.Client 0.0.0.4

Summary

Client Hub is under active development. Functionality and documentation may change without notice.

Client Hub provides programmatic access to several Wall Fee Api endpoints. This hub has eight different modules/services where each of them consists of one or more methods. All methods of every services return OperationResult<TResult>

OperationResult<TResult>

This class is a return type for all functions in each services.

• Class Structure
  • public Exception Exception { get; set; }
    • Exception will be set if there is any exception occurred during the operation.
  • public HttpStatusCode Status { get; set; }
    • Status will be either 202 (Accepted) or 503 (ServiceUnavailable)
  • public TResult Result { get; set; }
    • Result will be set to required data values if operation is succeeded or set to either null or empty data type value if error occurred.

Client Hub Modules

Namespace :

• Client.ProductFee.Hub
• Initialize Parameters :
• new Carrier (Guid applicationId, string authToken, HttpClient httpClient);
  • applicationId → Application Id of the current client application. Value cannot be null or empty GUID.
  • authToken → Authentication token to get access to carrier endpoints. Value cannot be null or empty string.
  • httpClient → Object of HttpClient. Client has control over http client object. Value cannot be null.
• Modules
  • Carrier
  • Dangerous Goods
  • Email
  • Fee
  • Fee Types
  • Price Line
  • Product
  • Return Services

Example : Return Services

Initialize

• new ReturnService (Guid applicationId, string authToken, HttpClient httpClient)
  • applicationId → Application Id of the current client application. Value cannot be null or empty GUID.
  • authToken → Authentication token to get access to ReturnService endpoints. Value cannot be null or empty string.
  • httpClient → Object of HttpClient. Client has control over http client object. Value cannot be null.

Available Methods

• public async Task<OperationResult<IList<ReturnServiceVM>>> All ()
  • Gets all Return Service data
  • Returns : OperationResult<IList<ReturnServiceVM>>
    • OperationResult with list of ReturnService models
• public async Task<OperationResult<ReturnServiceVM>> GetById (int id)
  • Gets ReturnService data from ReturnService Id provided
  • Params : id (int)
    • ReturnServiceId (primary key of ReturnService)
  • Returns : OperationResult<ReturnServiceVM>
    • OperationResult with ReturnService model