Show / Hide Table of Contents

Class All

Parameters for API calls.

Inheritance
System.Object
BaseParameters<Tracker>
BaseAllParameters<Tracker>
All
Implements
IBaseParameters
Inherited Members
BaseParameters<Tracker>.MatchFunction
BaseParameters<Tracker>.Matches(Tracker)
BaseParameters<Tracker>.ToDictionary()
BaseParameters<Tracker>.ToSubDictionary(Type)
Namespace: EasyPost.Parameters.Tracker
Assembly: EasyPost.dll
Syntax
public class All : BaseAllParameters<Tracker>, IBaseParameters

Properties

| Improve this Doc View Source

AfterId

Only records created after the given ID will be included. May not be used with BeforeId.

Declaration
public string? AfterId { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

BeforeId

Only records created before the given ID will be included. May not be used with AfterId.

Declaration
public string? BeforeId { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Carrier

Only return trackers with the given carrier.

Declaration
public string? Carrier { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

EndDatetime

Only return records created before this timestamp. Defaults to 1 month ago, or 1 month before a passed StartDatetime.

Declaration
public string? EndDatetime { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

PageSize

The number of records to return on each page. The maximum value is 100, and default is 20.

Declaration
public int? PageSize { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

StartDatetime

Only return records created after this timestamp. Defaults to 1 month ago, or 1 month before a passed EndDatetime.

Declaration
public string? StartDatetime { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

TrackingCode

Only return trackers with the given tracking code.

Declaration
public string? TrackingCode { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

TrackingCodes

Only return trackers with the given tracking codes.

Declaration
public List<string>? TrackingCodes { get; set; }
Property Value
Type Description
System.Nullable<List<System.String>>

Methods

| Improve this Doc View Source

FromDictionary(Nullable<Dictionary<String, Object>>)

Convert a dictionary into this parameter set.

Declaration
public static All FromDictionary(Dictionary<string, object>? dictionary)
Parameters
Type Name Description
System.Nullable<Dictionary<System.String, System.Object>> dictionary

Dictionary to parse.

Returns
Type Description
All

An All parameters set.

Implements

IBaseParameters
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX