WallBee.ProductFee.Admin 0.0.0.8

Summary

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

Admin Hub provides programmatic access to several Wall Fee Api endpoints. This hub has eight different types of modules/services. Each service consists of one or more functions. All of the methods will return OperationResult<TResult>

OperationResult<TResult>

• This is a class name which is a return type of all methods 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.

Admin Hub Modules

Namespace :

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

Example : Return Services

Initialize :

• new ReturnService (Guid applicationId, string authToken, HttpClient httpClient)

Available Methods

• public async Task<OperationResult<IList<ReturnServiceVM>>> All ()
  • Gets all return services.
  • Returns: OperationResult<IList<ReturnServiceV<>>

• public async Task<OperationResult<IList<ReturnServiceVM>>> Filter (ReturnServiceVM returnServiceVM)
  • Gets filter return services as per the properties value set.
  • Params : ReturnServiceVM
    • ReturnService view model has properties which will be used as filter params.
    • Filter Properties : Name (string), CarrierId (int) and FeeTypeId (int).
  • Returns : OperationResult<IList<ReturnServiceVM>>

• public async Task<OperationResult<ReturnServiceVM>> GetById (int id)
  • Gets return service by return service id.
  • Params : id (int)
    • ReturnService id (Primary key of ReturnService).
  • Returns : OperationResult<ReturnService>

• public async Task<OperationResult<ReturnServiceVM>> GetForUpdate (int id)
  • Gets return service by return service id for update operation.
  • Params : id (int)
    • ReturnService id (Primary key of ReturnService).
  • Returns : OperationResult<ReturnService>

• public async Task<OperationResult<ReturnServiceVM>> GetForDelete (int id)
  • Gets return service by return service id for delete opeeartion.
  • Params : id (int)
    • ReturnService id (Primary key of ReturnService).
  • Returns : OperationResult<ReturnService>

• public async Task<OperationResult<ReturnServiceVM>> GetForRestore (int id)
  • Gets return service by return service id for restore operation
  • Params : id (int)
    • ReturnService id (Primary key of ReturnService).
  • Returns : OperationResult<ReturnService>

• public async Task<OperationResult<int>> Insert (ReturnServiceVM returnServiceVM)
  • Inserts return service using api with provided return service view model.
  • Params : ReturnServiceVM
  • Returns : OperationResult<int>
    • OperationResult with result representing integer with either greater than 0 when success or less than 0 or 0 when failure.

• public async Task<OperationResult<int>> Update (ReturnServiceVM returnServiceVM)
  • Updates return service using pai with provided return service view model.
  • Params : ReturnServiceVM
  • Returns : OperationResult<int>
    • OperationResult with result representing integer with either greater than 0 when success or less than 0 or 0 when failure.

• public async Task<OperationResult<int>> Delete (int returnServiceId)
  • Deletes return service using api with provided return service id. Delete operation will update DataStaus to Delete (3).
  • Params : returnServiceId (int)
  • Returns : OperationResult<int>
    • OperationResult with result representing integer with either greater than 0 when success or less than 0 or 0 when failure.

• public async Task<OperationResult<int>> Restore (int returnServiceId)
  • Restores return service using api with provied return service id. Restore operation will update DataStatus from Delete (3) to Restore (4).
  • Params : returnServiceId (int)
  • Returns : OperationResult<int>
    • OperationResult with result representing integer with either greater than 0 when success or less than 0 or 0 when failure.

• public async Task<OperationResult<IList<ReturnServiceVM>>> ReadFromCSV (FileStream content)
  • Reads data content from the filestream requested.
  • Params : FileStream
    • Filestream has the information of the file posted.
  • Returns : OperationResult<IList<ReturnServiceVM>>

• public async Task<OperationResult<IList<ReturnServiceVM>>> CheckReturnServices (IList<ReturnServiceVM> returnServices)
  • Checks collection of return services and confirms which already exists and new.
  • Params : IList<ReturnServiceVM>
    • List of return service view model.
  • Returns : OperationResult<int>
    • OperationResult with result representing integer with either greater than 0 when success or less than 0 or 0 when failure.