HaulTech.Public.CSP 1.0.13572

HaulTech CSP

Welcome to HaulTech's Customer Service Portal (CSP) NuGet package. Use this package to integrate with a CSP instance, exposing the following capabilities:

1. Resolve Accounts
2. Resolve the Collection and Delivery Matrix
3. Create Jobs
4. Confirm Jobs
5. Search for Jobs

All activity is derived from System.Net.Http.HttpClient to handle HTTP requests and responses.

The following HttpClient implementations are defined in this package:

Pre-Requisites

In order to consume the HaulTech CSP package, an integrator needs three things from their CSP provider:

1. Credentials - these are represented by a username and password
2. API URL - this is the endpoint used to interact with CSP features
3. Authorisation URL - this is the endpoint used to request OAuth tokens

Note: Each HaulTech customer who subscribes to the CSP solution has their own dedicated instance. As such, they are considered the CSP provider, not HaulTech.

Package Flow

Getting Started

1. Install the NuGet package, for example:

Install-Package HaulTech.Public.CSP
dotnet add package HaulTech.Public.CSP

• Tip: Don't forget to add the using statement

using HaulTech.Public.CSP;
using HaulTech.Public.CSP.Models;

2. Create a Customer Service Portal Client :

var cspClient = new CustomerServicePortalClient("username", "password", "baseUrl", "apiUrl");

3. Finally, we can make our first CSP API call:

var accounts = await cspClient.GetAccountsAsync();
var matrices = await cspClient.GetServiceMatricesAsync();
var collectionServiceMatrix = matrices.First(x => x.Type == CSPGoodsMovementType.Collection);
var deliveryServiceMatrix = matrices.First(x => x.Type == CSPGoodsMovementType.Delivery);
var collectionDate = DateTime.UtcNow;
var job = new CspPortalJob()
{
	AccountId = accounts.First().AccountId,
	ServiceLevelId = collectionServiceMatrix.ServiceLevelId,
	CollectionDateTime = collectionDate,
	DeliveryDateTime = await cspClient.GetNextValidDeliveryDateForServiceMatrixAsync(collectionDate, deliveryServiceMatrix.ServiceLevelId),
	CollectionStartTime = collectionServiceMatrix.StartTime,
	CollectionEndTime = collectionServiceMatrix.EndTime,
	DeliveryStartTime = deliveryServiceMatrix.StartTime,
	DeliveryEndTime = deliveryServiceMatrix.EndTime,
	CollectionAddress1 = "CSP NuGet Demo Collection",
	DeliveryAddress1 = "CSP NuGet Demo Delivery",
	Weight = 1,
	DeliveryServiceLevelTimeId = deliveryServiceMatrix.ServiceTimeId,
	CollectionServiceLevelTimeId = collectionServiceMatrix.ServiceTimeId
};
var pendingJobId =  await cspClient.AddJobAsync(job);
var confirmedJobId = await cspClient.ConfirmJobAsync(pendingJobId);
var search = await cspClient.SearchForJobsAsync(new CspSearch()
{
	JobNo = jobApprovedId
});

Contribute

This package is closed to contributors.