yangming

package module
v1.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 11, 2022 License: LGPL-3.0 Imports: 22 Imported by: 0

README

Go API client for yangming

API specifications for the Track and Trace interface standard

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: DCSA Standard
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import yangming "github.com/buyco/go-yangming-sdk/yangming"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), yangming.ContextServerIndex, 1)
Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), yangming.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), yangming.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), yangming.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.yangming.com/open/dcsa/api/tnt

Class Method HTTP request Description
EventsApi V110GGetEvents Get /1.1.0/events Find events by Booking Reference, Bill of Lading or Equipment Reference.

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

itcs@yangming.com

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
	ContextHttpSignatureAuth = contextKey("httpsignature")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func PtrBool 

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32 

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64 

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt 

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32 

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64 

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString 

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime 

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient 

type APIClient struct {
	EventsApi EventsApi
	// contains filtered or unexported fields
}

APIClient manages communication with the Yang Ming Track and Trace API API vDCSA Standard In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type ApiV110GGetEventsRequest 

type ApiV110GGetEventsRequest struct {
	ApiService EventsApi
	// contains filtered or unexported fields
}

func (ApiV110GGetEventsRequest) BillOfLadingNumber 

func (r ApiV110GGetEventsRequest) BillOfLadingNumber(billOfLadingNumber string) ApiV110GGetEventsRequest

Bill of lading number is an identifier that links to a shipment. Bill of Lading is the legal document issued to the customer, which confirms the carrier's receipt of the cargo from the customer acknowledging goods being shipped and specifying the terms of delivery.

func (ApiV110GGetEventsRequest) BookingReference 

func (r ApiV110GGetEventsRequest) BookingReference(bookingReference string) ApiV110GGetEventsRequest

The identifier for a shipment, which is issued by and unique within each of the carriers.

func (ApiV110GGetEventsRequest) EquipmentReference 

func (r ApiV110GGetEventsRequest) EquipmentReference(equipmentReference string) ApiV110GGetEventsRequest

The unique identifier for the equipment, which should follow the BIC ISO Container Identification Number where possible.

func (ApiV110GGetEventsRequest) Execute 

func (r ApiV110GGetEventsRequest) Execute() (*Events, *http.Response, error)

func (ApiV110GGetEventsRequest) KeyId 

func (r ApiV110GGetEventsRequest) KeyId(keyId string) ApiV110GGetEventsRequest

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL 

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext 

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type EquipmentEvent 

type EquipmentEvent struct {
	// The unique identifier for the Equipment Event ID/Transport Event ID/Shipment Event ID.
	EventID string `json:"eventID"`
	// The local date and time, where the event took place, in ISO 8601 format.
	EventDateTime time.Time `json:"eventDateTime"`
	// Code for the event classifier, either PLN, ACT or EST.
	EventClassifierCode string `json:"eventClassifierCode"`
	// Unique identifier for Event Type Code.
	EventTypeCode string `json:"eventTypeCode"`
	// The unique identifier for the equipment, which should follow the BIC ISO Container Identification Number where possible. If a container is not yet assigned to a shipment, the interface cannot return any information when an equipment reference is given as input. If a container is assigned to an (active) shipment, the interface returns information on the active shipment.
	EquipmentReference string `json:"equipmentReference"`
	// The code to identify the specific type of facility.
	FacilityTypeCode string `json:"facilityTypeCode"`
	// The UN Location Code identifies a location in the sense of a city/a town/a village, being the smaller administrative area existing as defined by the competent national authority in each country.
	UNLocationCode string `json:"UNLocationCode"`
	// The code used for identifying the specific facility.
	FacilityCode string `json:"facilityCode"`
	// An alternative way to capture the facility when no standardized DCSA facility code can be found.
	OtherFacility *string `json:"otherFacility,omitempty"`
	// Code to denote whether the equipment is empty or laden.
	EmptyIndicatorCode string `json:"emptyIndicatorCode"`
}

EquipmentEvent The equipment event entity is a specialization of the event entity to support specification of data that only applies to an equipment event.

func NewEquipmentEvent 

func NewEquipmentEvent(eventID string, eventDateTime time.Time, eventClassifierCode string, eventTypeCode string, equipmentReference string, facilityTypeCode string, uNLocationCode string, facilityCode string, emptyIndicatorCode string) *EquipmentEvent

NewEquipmentEvent instantiates a new EquipmentEvent object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewEquipmentEventWithDefaults 

func NewEquipmentEventWithDefaults() *EquipmentEvent

NewEquipmentEventWithDefaults instantiates a new EquipmentEvent object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*EquipmentEvent) GetEmptyIndicatorCode 

func (o *EquipmentEvent) GetEmptyIndicatorCode() string

GetEmptyIndicatorCode returns the EmptyIndicatorCode field value

func (*EquipmentEvent) GetEmptyIndicatorCodeOk 

func (o *EquipmentEvent) GetEmptyIndicatorCodeOk() (*string, bool)

GetEmptyIndicatorCodeOk returns a tuple with the EmptyIndicatorCode field value and a boolean to check if the value has been set.

func (*EquipmentEvent) GetEquipmentReference 

func (o *EquipmentEvent) GetEquipmentReference() string

GetEquipmentReference returns the EquipmentReference field value

func (*EquipmentEvent) GetEquipmentReferenceOk 

func (o *EquipmentEvent) GetEquipmentReferenceOk() (*string, bool)

GetEquipmentReferenceOk returns a tuple with the EquipmentReference field value and a boolean to check if the value has been set.

func (*EquipmentEvent) GetEventClassifierCode 

func (o *EquipmentEvent) GetEventClassifierCode() string

GetEventClassifierCode returns the EventClassifierCode field value

func (*EquipmentEvent) GetEventClassifierCodeOk 

func (o *EquipmentEvent) GetEventClassifierCodeOk() (*string, bool)

GetEventClassifierCodeOk returns a tuple with the EventClassifierCode field value and a boolean to check if the value has been set.

func (*EquipmentEvent) GetEventDateTime 

func (o *EquipmentEvent) GetEventDateTime() time.Time

GetEventDateTime returns the EventDateTime field value

func (*EquipmentEvent) GetEventDateTimeOk 

func (o *EquipmentEvent) GetEventDateTimeOk() (*time.Time, bool)

GetEventDateTimeOk returns a tuple with the EventDateTime field value and a boolean to check if the value has been set.

func (*EquipmentEvent) GetEventID 

func (o *EquipmentEvent) GetEventID() string

GetEventID returns the EventID field value

func (*EquipmentEvent) GetEventIDOk 

func (o *EquipmentEvent) GetEventIDOk() (*string, bool)

GetEventIDOk returns a tuple with the EventID field value and a boolean to check if the value has been set.

func (*EquipmentEvent) GetEventTypeCode 

func (o *EquipmentEvent) GetEventTypeCode() string

GetEventTypeCode returns the EventTypeCode field value

func (*EquipmentEvent) GetEventTypeCodeOk 

func (o *EquipmentEvent) GetEventTypeCodeOk() (*string, bool)

GetEventTypeCodeOk returns a tuple with the EventTypeCode field value and a boolean to check if the value has been set.

func (*EquipmentEvent) GetFacilityCode 

func (o *EquipmentEvent) GetFacilityCode() string

GetFacilityCode returns the FacilityCode field value

func (*EquipmentEvent) GetFacilityCodeOk 

func (o *EquipmentEvent) GetFacilityCodeOk() (*string, bool)

GetFacilityCodeOk returns a tuple with the FacilityCode field value and a boolean to check if the value has been set.

func (*EquipmentEvent) GetFacilityTypeCode 

func (o *EquipmentEvent) GetFacilityTypeCode() string

GetFacilityTypeCode returns the FacilityTypeCode field value

func (*EquipmentEvent) GetFacilityTypeCodeOk 

func (o *EquipmentEvent) GetFacilityTypeCodeOk() (*string, bool)

GetFacilityTypeCodeOk returns a tuple with the FacilityTypeCode field value and a boolean to check if the value has been set.

func (*EquipmentEvent) GetOtherFacility 

func (o *EquipmentEvent) GetOtherFacility() string

GetOtherFacility returns the OtherFacility field value if set, zero value otherwise.

func (*EquipmentEvent) GetOtherFacilityOk 

func (o *EquipmentEvent) GetOtherFacilityOk() (*string, bool)

GetOtherFacilityOk returns a tuple with the OtherFacility field value if set, nil otherwise and a boolean to check if the value has been set.

func (*EquipmentEvent) GetUNLocationCode 

func (o *EquipmentEvent) GetUNLocationCode() string

GetUNLocationCode returns the UNLocationCode field value

func (*EquipmentEvent) GetUNLocationCodeOk 

func (o *EquipmentEvent) GetUNLocationCodeOk() (*string, bool)

GetUNLocationCodeOk returns a tuple with the UNLocationCode field value and a boolean to check if the value has been set.

func (*EquipmentEvent) HasOtherFacility 

func (o *EquipmentEvent) HasOtherFacility() bool

HasOtherFacility returns a boolean if a field has been set.

func (EquipmentEvent) MarshalJSON 

func (o EquipmentEvent) MarshalJSON() ([]byte, error)

func (*EquipmentEvent) SetEmptyIndicatorCode 

func (o *EquipmentEvent) SetEmptyIndicatorCode(v string)

SetEmptyIndicatorCode sets field value

func (*EquipmentEvent) SetEquipmentReference 

func (o *EquipmentEvent) SetEquipmentReference(v string)

SetEquipmentReference sets field value

func (*EquipmentEvent) SetEventClassifierCode 

func (o *EquipmentEvent) SetEventClassifierCode(v string)

SetEventClassifierCode sets field value

func (*EquipmentEvent) SetEventDateTime 

func (o *EquipmentEvent) SetEventDateTime(v time.Time)

SetEventDateTime sets field value

func (*EquipmentEvent) SetEventID 

func (o *EquipmentEvent) SetEventID(v string)

SetEventID sets field value

func (*EquipmentEvent) SetEventTypeCode 

func (o *EquipmentEvent) SetEventTypeCode(v string)

SetEventTypeCode sets field value

func (*EquipmentEvent) SetFacilityCode 

func (o *EquipmentEvent) SetFacilityCode(v string)

SetFacilityCode sets field value

func (*EquipmentEvent) SetFacilityTypeCode 

func (o *EquipmentEvent) SetFacilityTypeCode(v string)

SetFacilityTypeCode sets field value

func (*EquipmentEvent) SetOtherFacility 

func (o *EquipmentEvent) SetOtherFacility(v string)

SetOtherFacility gets a reference to the given string and assigns it to the OtherFacility field.

func (*EquipmentEvent) SetUNLocationCode 

func (o *EquipmentEvent) SetUNLocationCode(v string)

SetUNLocationCode sets field value

type Errors 

type Errors struct {
	// High level error message:   1.invalidQuery   2.noDataFound   3.systemException.
	Reason string `json:"reason"`
	// Detailed error message:   1.invalidQuery: The request did not contain one of the three required query parameters.   2.noDataFound: No data found for given parameters.   3.systemException: Exception occurs when calling the API.
	Message string `json:"message"`
}

Errors struct for Errors

func NewErrors 

func NewErrors(reason string, message string) *Errors

NewErrors instantiates a new Errors object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewErrorsWithDefaults 

func NewErrorsWithDefaults() *Errors

NewErrorsWithDefaults instantiates a new Errors object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Errors) GetMessage 

func (o *Errors) GetMessage() string

GetMessage returns the Message field value

func (*Errors) GetMessageOk 

func (o *Errors) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value and a boolean to check if the value has been set.

func (*Errors) GetReason 

func (o *Errors) GetReason() string

GetReason returns the Reason field value

func (*Errors) GetReasonOk 

func (o *Errors) GetReasonOk() (*string, bool)

GetReasonOk returns a tuple with the Reason field value and a boolean to check if the value has been set.

func (Errors) MarshalJSON 

func (o Errors) MarshalJSON() ([]byte, error)

func (*Errors) SetMessage 

func (o *Errors) SetMessage(v string)

SetMessage sets field value

func (*Errors) SetReason 

func (o *Errors) SetReason(v string)

SetReason sets field value

type Event 

type Event struct {
	EquipmentEvent          *EquipmentEvent
	TransportEquipmentEvent *TransportEquipmentEvent
	TransportEvent          *TransportEvent
}

Event struct for Event

func (*Event) MarshalJSON 

func (src *Event) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON

func (*Event) UnmarshalJSON 

func (dst *Event) UnmarshalJSON(data []byte) error

Unmarshal JSON data into any of the pointers in the struct

type Events 

type Events struct {
	Events []Event `json:"events"`
}

Events List of events for shipment journey.

func NewEvents 

func NewEvents(events []Event) *Events

NewEvents instantiates a new Events object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewEventsWithDefaults 

func NewEventsWithDefaults() *Events

NewEventsWithDefaults instantiates a new Events object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Events) GetEvents 

func (o *Events) GetEvents() []Event

GetEvents returns the Events field value

func (*Events) GetEventsOk 

func (o *Events) GetEventsOk() ([]Event, bool)

GetEventsOk returns a tuple with the Events field value and a boolean to check if the value has been set.

func (Events) MarshalJSON 

func (o Events) MarshalJSON() ([]byte, error)

func (*Events) SetEvents 

func (o *Events) SetEvents(v []Event)

SetEvents sets field value

type EventsApi 

type EventsApi interface {

	/*
		V110GGetEvents Find events by Booking Reference, Bill of Lading or Equipment Reference.

		Returns all events related to the query parameter. The endpoint requires at least 1 of the 3 query parameters to be used.

		 @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 @return ApiV110GGetEventsRequest
	*/
	V110GGetEvents(ctx context.Context) ApiV110GGetEventsRequest

	// V110GGetEventsExecute executes the request
	//  @return Events
	V110GGetEventsExecute(r ApiV110GGetEventsRequest) (*Events, *http.Response, error)
}

type EventsApiService 

type EventsApiService service

EventsApiService EventsApi service

func (*EventsApiService) V110GGetEvents 

func (a *EventsApiService) V110GGetEvents(ctx context.Context) ApiV110GGetEventsRequest

V110GGetEvents Find events by Booking Reference, Bill of Lading or Equipment Reference.

Returns all events related to the query parameter. The endpoint requires at least 1 of the 3 query parameters to be used. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiV110GGetEventsRequest

func (*EventsApiService) V110GGetEventsExecute 

func (a *EventsApiService) V110GGetEventsExecute(r ApiV110GGetEventsRequest) (*Events, *http.Response, error)

Execute executes the request 

@return Events

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type ModelError 

type ModelError struct {
	// The HTTP request method type.
	HttpMethod string `json:"httpMethod"`
	// The request URI.
	RequestUri string   `json:"requestUri"`
	Errors     []Errors `json:"errors"`
	// The HTTP status code.
	StatusCode int32 `json:"statusCode"`
	// The textual representation of the response status.
	StatusCodeText string `json:"statusCodeText"`
	// The date and time (in ISO 8601 format) the error occured.
	ErrorDateTime string `json:"errorDateTime"`
}

ModelError struct for ModelError

func NewModelError 

func NewModelError(httpMethod string, requestUri string, errors []Errors, statusCode int32, statusCodeText string, errorDateTime string) *ModelError

NewModelError instantiates a new ModelError object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewModelErrorWithDefaults 

func NewModelErrorWithDefaults() *ModelError

NewModelErrorWithDefaults instantiates a new ModelError object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ModelError) GetErrorDateTime 

func (o *ModelError) GetErrorDateTime() string

GetErrorDateTime returns the ErrorDateTime field value

func (*ModelError) GetErrorDateTimeOk 

func (o *ModelError) GetErrorDateTimeOk() (*string, bool)

GetErrorDateTimeOk returns a tuple with the ErrorDateTime field value and a boolean to check if the value has been set.

func (*ModelError) GetErrors 

func (o *ModelError) GetErrors() []Errors

GetErrors returns the Errors field value

func (*ModelError) GetErrorsOk 

func (o *ModelError) GetErrorsOk() ([]Errors, bool)

GetErrorsOk returns a tuple with the Errors field value and a boolean to check if the value has been set.

func (*ModelError) GetHttpMethod 

func (o *ModelError) GetHttpMethod() string

GetHttpMethod returns the HttpMethod field value

func (*ModelError) GetHttpMethodOk 

func (o *ModelError) GetHttpMethodOk() (*string, bool)

GetHttpMethodOk returns a tuple with the HttpMethod field value and a boolean to check if the value has been set.

func (*ModelError) GetRequestUri 

func (o *ModelError) GetRequestUri() string

GetRequestUri returns the RequestUri field value

func (*ModelError) GetRequestUriOk 

func (o *ModelError) GetRequestUriOk() (*string, bool)

GetRequestUriOk returns a tuple with the RequestUri field value and a boolean to check if the value has been set.

func (*ModelError) GetStatusCode 

func (o *ModelError) GetStatusCode() int32

GetStatusCode returns the StatusCode field value

func (*ModelError) GetStatusCodeOk 

func (o *ModelError) GetStatusCodeOk() (*int32, bool)

GetStatusCodeOk returns a tuple with the StatusCode field value and a boolean to check if the value has been set.

func (*ModelError) GetStatusCodeText 

func (o *ModelError) GetStatusCodeText() string

GetStatusCodeText returns the StatusCodeText field value

func (*ModelError) GetStatusCodeTextOk 

func (o *ModelError) GetStatusCodeTextOk() (*string, bool)

GetStatusCodeTextOk returns a tuple with the StatusCodeText field value and a boolean to check if the value has been set.

func (ModelError) MarshalJSON 

func (o ModelError) MarshalJSON() ([]byte, error)

func (*ModelError) SetErrorDateTime 

func (o *ModelError) SetErrorDateTime(v string)

SetErrorDateTime sets field value

func (*ModelError) SetErrors 

func (o *ModelError) SetErrors(v []Errors)

SetErrors sets field value

func (*ModelError) SetHttpMethod 

func (o *ModelError) SetHttpMethod(v string)

SetHttpMethod sets field value

func (*ModelError) SetRequestUri 

func (o *ModelError) SetRequestUri(v string)

SetRequestUri sets field value

func (*ModelError) SetStatusCode 

func (o *ModelError) SetStatusCode(v int32)

SetStatusCode sets field value

func (*ModelError) SetStatusCodeText 

func (o *ModelError) SetStatusCodeText(v string)

SetStatusCodeText sets field value

type NullableBool 

type NullableBool struct {
	// contains filtered or unexported fields
}

func NewNullableBool 

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get 

func (v NullableBool) Get() *bool

func (NullableBool) IsSet 

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON 

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set 

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON 

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset 

func (v *NullableBool) Unset()

type NullableEquipmentEvent 

type NullableEquipmentEvent struct {
	// contains filtered or unexported fields
}

func NewNullableEquipmentEvent 

func NewNullableEquipmentEvent(val *EquipmentEvent) *NullableEquipmentEvent

func (NullableEquipmentEvent) Get 

func (v NullableEquipmentEvent) Get() *EquipmentEvent

func (NullableEquipmentEvent) IsSet 

func (v NullableEquipmentEvent) IsSet() bool

func (NullableEquipmentEvent) MarshalJSON 

func (v NullableEquipmentEvent) MarshalJSON() ([]byte, error)

func (*NullableEquipmentEvent) Set 

func (v *NullableEquipmentEvent) Set(val *EquipmentEvent)

func (*NullableEquipmentEvent) UnmarshalJSON 

func (v *NullableEquipmentEvent) UnmarshalJSON(src []byte) error

func (*NullableEquipmentEvent) Unset 

func (v *NullableEquipmentEvent) Unset()

type NullableErrors 

type NullableErrors struct {
	// contains filtered or unexported fields
}

func NewNullableErrors 

func NewNullableErrors(val *Errors) *NullableErrors

func (NullableErrors) Get 

func (v NullableErrors) Get() *Errors

func (NullableErrors) IsSet 

func (v NullableErrors) IsSet() bool

func (NullableErrors) MarshalJSON 

func (v NullableErrors) MarshalJSON() ([]byte, error)

func (*NullableErrors) Set 

func (v *NullableErrors) Set(val *Errors)

func (*NullableErrors) UnmarshalJSON 

func (v *NullableErrors) UnmarshalJSON(src []byte) error

func (*NullableErrors) Unset 

func (v *NullableErrors) Unset()

type NullableEvent 

type NullableEvent struct {
	// contains filtered or unexported fields
}

func NewNullableEvent 

func NewNullableEvent(val *Event) *NullableEvent

func (NullableEvent) Get 

func (v NullableEvent) Get() *Event

func (NullableEvent) IsSet 

func (v NullableEvent) IsSet() bool

func (NullableEvent) MarshalJSON 

func (v NullableEvent) MarshalJSON() ([]byte, error)

func (*NullableEvent) Set 

func (v *NullableEvent) Set(val *Event)

func (*NullableEvent) UnmarshalJSON 

func (v *NullableEvent) UnmarshalJSON(src []byte) error

func (*NullableEvent) Unset 

func (v *NullableEvent) Unset()

type NullableEvents 

type NullableEvents struct {
	// contains filtered or unexported fields
}

func NewNullableEvents 

func NewNullableEvents(val *Events) *NullableEvents

func (NullableEvents) Get 

func (v NullableEvents) Get() *Events

func (NullableEvents) IsSet 

func (v NullableEvents) IsSet() bool

func (NullableEvents) MarshalJSON 

func (v NullableEvents) MarshalJSON() ([]byte, error)

func (*NullableEvents) Set 

func (v *NullableEvents) Set(val *Events)

func (*NullableEvents) UnmarshalJSON 

func (v *NullableEvents) UnmarshalJSON(src []byte) error

func (*NullableEvents) Unset 

func (v *NullableEvents) Unset()

type NullableFloat32 

type NullableFloat32 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat32 

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get 

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet 

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON 

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set 

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON 

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset 

func (v *NullableFloat32) Unset()

type NullableFloat64 

type NullableFloat64 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat64 

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get 

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet 

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON 

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set 

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON 

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset 

func (v *NullableFloat64) Unset()

type NullableInt 

type NullableInt struct {
	// contains filtered or unexported fields
}

func NewNullableInt 

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get 

func (v NullableInt) Get() *int

func (NullableInt) IsSet 

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON 

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set 

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON 

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset 

func (v *NullableInt) Unset()

type NullableInt32 

type NullableInt32 struct {
	// contains filtered or unexported fields
}

func NewNullableInt32 

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get 

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet 

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON 

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set 

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON 

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset 

func (v *NullableInt32) Unset()

type NullableInt64 

type NullableInt64 struct {
	// contains filtered or unexported fields
}

func NewNullableInt64 

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get 

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet 

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON 

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set 

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON 

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset 

func (v *NullableInt64) Unset()

type NullableModelError 

type NullableModelError struct {
	// contains filtered or unexported fields
}

func NewNullableModelError 

func NewNullableModelError(val *ModelError) *NullableModelError

func (NullableModelError) Get 

func (v NullableModelError) Get() *ModelError

func (NullableModelError) IsSet 

func (v NullableModelError) IsSet() bool

func (NullableModelError) MarshalJSON 

func (v NullableModelError) MarshalJSON() ([]byte, error)

func (*NullableModelError) Set 

func (v *NullableModelError) Set(val *ModelError)

func (*NullableModelError) UnmarshalJSON 

func (v *NullableModelError) UnmarshalJSON(src []byte) error

func (*NullableModelError) Unset 

func (v *NullableModelError) Unset()

type NullableString 

type NullableString struct {
	// contains filtered or unexported fields
}

func NewNullableString 

func NewNullableString(val *string) *NullableString

func (NullableString) Get 

func (v NullableString) Get() *string

func (NullableString) IsSet 

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON 

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set 

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON 

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset 

func (v *NullableString) Unset()

type NullableTime 

type NullableTime struct {
	// contains filtered or unexported fields
}

func NewNullableTime 

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get 

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet 

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON 

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set 

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON 

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset 

func (v *NullableTime) Unset()

type NullableTransportEquipmentEvent 

type NullableTransportEquipmentEvent struct {
	// contains filtered or unexported fields
}

func NewNullableTransportEquipmentEvent 

func NewNullableTransportEquipmentEvent(val *TransportEquipmentEvent) *NullableTransportEquipmentEvent

func (NullableTransportEquipmentEvent) Get 

func (v NullableTransportEquipmentEvent) Get() *TransportEquipmentEvent

func (NullableTransportEquipmentEvent) IsSet 

func (v NullableTransportEquipmentEvent) IsSet() bool

func (NullableTransportEquipmentEvent) MarshalJSON 

func (v NullableTransportEquipmentEvent) MarshalJSON() ([]byte, error)

func (*NullableTransportEquipmentEvent) Set 

func (v *NullableTransportEquipmentEvent) Set(val *TransportEquipmentEvent)

func (*NullableTransportEquipmentEvent) UnmarshalJSON 

func (v *NullableTransportEquipmentEvent) UnmarshalJSON(src []byte) error

func (*NullableTransportEquipmentEvent) Unset 

func (v *NullableTransportEquipmentEvent) Unset()

type NullableTransportEvent 

type NullableTransportEvent struct {
	// contains filtered or unexported fields
}

func NewNullableTransportEvent 

func NewNullableTransportEvent(val *TransportEvent) *NullableTransportEvent

func (NullableTransportEvent) Get 

func (v NullableTransportEvent) Get() *TransportEvent

func (NullableTransportEvent) IsSet 

func (v NullableTransportEvent) IsSet() bool

func (NullableTransportEvent) MarshalJSON 

func (v NullableTransportEvent) MarshalJSON() ([]byte, error)

func (*NullableTransportEvent) Set 

func (v *NullableTransportEvent) Set(val *TransportEvent)

func (*NullableTransportEvent) UnmarshalJSON 

func (v *NullableTransportEvent) UnmarshalJSON(src []byte) error

func (*NullableTransportEvent) Unset 

func (v *NullableTransportEvent) Unset()

type ServerConfiguration 

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations 

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL 

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type TransportEquipmentEvent 

type TransportEquipmentEvent struct {
	// The unique identifier for the Equipment Event ID/Transport Event ID/Shipment Event ID.
	EventID string `json:"eventID"`
	// The local date and time, where the event took place, in ISO 8601 format.
	EventDateTime time.Time `json:"eventDateTime"`
	// Code for the event classifier, either PLN, ACT or EST.
	EventClassifierCode string `json:"eventClassifierCode"`
	// Unique identifier for Event Type Code.
	EventTypeCode string `json:"eventTypeCode"`
	// The reference for the transport, e.g. when the mode of transport is a vessel, the transport reference will be the vessel IMO number.
	TransportReference string `json:"transportReference"`
	// The transport leg reference will be specific per mode of transport:  Vessel: Voyage number as specified by the vessel operator  Truck: Not yet specified  Rail: Not yet specified  Barge: Not yet specified.
	TransportLegReference string `json:"transportLegReference"`
	// The unique identifier for the equipment, which should follow the BIC ISO Container Identification Number where possible. If a container is not yet assigned to a shipment, the interface cannot return any information when an equipment reference is given as input. If a container is assigned to an (active) shipment, the interface returns information on the active shipment.
	EquipmentReference string `json:"equipmentReference"`
	// The code to identify the specific type of facility.
	FacilityTypeCode string `json:"facilityTypeCode"`
	// The UN Location Code identifies a location in the sense of a city/a town/a village, being the smaller administrative area existing as defined by the competent national authority in each country.
	UNLocationCode string `json:"UNLocationCode"`
	// The code used for identifying the specific facility.
	FacilityCode string `json:"facilityCode"`
	// An alternative way to capture the facility when no standardized DCSA facility code can be found.
	OtherFacility *string `json:"otherFacility,omitempty"`
	// Code to denote whether the equipment is empty or laden.
	EmptyIndicatorCode string `json:"emptyIndicatorCode"`
	// A code specifying a type of transport mode.
	ModeOfTransportCode string `json:"modeOfTransportCode"`
}

TransportEquipmentEvent The transport equipment event entity is a specialization of the event entity to support specification of data that applies to both transport and equipment events.

func NewTransportEquipmentEvent 

func NewTransportEquipmentEvent(eventID string, eventDateTime time.Time, eventClassifierCode string, eventTypeCode string, transportReference string, transportLegReference string, equipmentReference string, facilityTypeCode string, uNLocationCode string, facilityCode string, emptyIndicatorCode string, modeOfTransportCode string) *TransportEquipmentEvent

NewTransportEquipmentEvent instantiates a new TransportEquipmentEvent object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewTransportEquipmentEventWithDefaults 

func NewTransportEquipmentEventWithDefaults() *TransportEquipmentEvent

NewTransportEquipmentEventWithDefaults instantiates a new TransportEquipmentEvent object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*TransportEquipmentEvent) GetEmptyIndicatorCode 

func (o *TransportEquipmentEvent) GetEmptyIndicatorCode() string

GetEmptyIndicatorCode returns the EmptyIndicatorCode field value

func (*TransportEquipmentEvent) GetEmptyIndicatorCodeOk 

func (o *TransportEquipmentEvent) GetEmptyIndicatorCodeOk() (*string, bool)

GetEmptyIndicatorCodeOk returns a tuple with the EmptyIndicatorCode field value and a boolean to check if the value has been set.

func (*TransportEquipmentEvent) GetEquipmentReference 

func (o *TransportEquipmentEvent) GetEquipmentReference() string

GetEquipmentReference returns the EquipmentReference field value

func (*TransportEquipmentEvent) GetEquipmentReferenceOk 

func (o *TransportEquipmentEvent) GetEquipmentReferenceOk() (*string, bool)

GetEquipmentReferenceOk returns a tuple with the EquipmentReference field value and a boolean to check if the value has been set.

func (*TransportEquipmentEvent) GetEventClassifierCode 

func (o *TransportEquipmentEvent) GetEventClassifierCode() string

GetEventClassifierCode returns the EventClassifierCode field value

func (*TransportEquipmentEvent) GetEventClassifierCodeOk 

func (o *TransportEquipmentEvent) GetEventClassifierCodeOk() (*string, bool)

GetEventClassifierCodeOk returns a tuple with the EventClassifierCode field value and a boolean to check if the value has been set.

func (*TransportEquipmentEvent) GetEventDateTime 

func (o *TransportEquipmentEvent) GetEventDateTime() time.Time

GetEventDateTime returns the EventDateTime field value

func (*TransportEquipmentEvent) GetEventDateTimeOk 

func (o *TransportEquipmentEvent) GetEventDateTimeOk() (*time.Time, bool)

GetEventDateTimeOk returns a tuple with the EventDateTime field value and a boolean to check if the value has been set.

func (*TransportEquipmentEvent) GetEventID 

func (o *TransportEquipmentEvent) GetEventID() string

GetEventID returns the EventID field value

func (*TransportEquipmentEvent) GetEventIDOk 

func (o *TransportEquipmentEvent) GetEventIDOk() (*string, bool)

GetEventIDOk returns a tuple with the EventID field value and a boolean to check if the value has been set.

func (*TransportEquipmentEvent) GetEventTypeCode 

func (o *TransportEquipmentEvent) GetEventTypeCode() string

GetEventTypeCode returns the EventTypeCode field value

func (*TransportEquipmentEvent) GetEventTypeCodeOk 

func (o *TransportEquipmentEvent) GetEventTypeCodeOk() (*string, bool)

GetEventTypeCodeOk returns a tuple with the EventTypeCode field value and a boolean to check if the value has been set.

func (*TransportEquipmentEvent) GetFacilityCode 

func (o *TransportEquipmentEvent) GetFacilityCode() string

GetFacilityCode returns the FacilityCode field value

func (*TransportEquipmentEvent) GetFacilityCodeOk 

func (o *TransportEquipmentEvent) GetFacilityCodeOk() (*string, bool)

GetFacilityCodeOk returns a tuple with the FacilityCode field value and a boolean to check if the value has been set.

func (*TransportEquipmentEvent) GetFacilityTypeCode 

func (o *TransportEquipmentEvent) GetFacilityTypeCode() string

GetFacilityTypeCode returns the FacilityTypeCode field value

func (*TransportEquipmentEvent) GetFacilityTypeCodeOk 

func (o *TransportEquipmentEvent) GetFacilityTypeCodeOk() (*string, bool)

GetFacilityTypeCodeOk returns a tuple with the FacilityTypeCode field value and a boolean to check if the value has been set.

func (*TransportEquipmentEvent) GetModeOfTransportCode 

func (o *TransportEquipmentEvent) GetModeOfTransportCode() string

GetModeOfTransportCode returns the ModeOfTransportCode field value

func (*TransportEquipmentEvent) GetModeOfTransportCodeOk 

func (o *TransportEquipmentEvent) GetModeOfTransportCodeOk() (*string, bool)

GetModeOfTransportCodeOk returns a tuple with the ModeOfTransportCode field value and a boolean to check if the value has been set.

func (*TransportEquipmentEvent) GetOtherFacility 

func (o *TransportEquipmentEvent) GetOtherFacility() string

GetOtherFacility returns the OtherFacility field value if set, zero value otherwise.

func (*TransportEquipmentEvent) GetOtherFacilityOk 

func (o *TransportEquipmentEvent) GetOtherFacilityOk() (*string, bool)

GetOtherFacilityOk returns a tuple with the OtherFacility field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TransportEquipmentEvent) GetTransportLegReference 

func (o *TransportEquipmentEvent) GetTransportLegReference() string

GetTransportLegReference returns the TransportLegReference field value

func (*TransportEquipmentEvent) GetTransportLegReferenceOk 

func (o *TransportEquipmentEvent) GetTransportLegReferenceOk() (*string, bool)

GetTransportLegReferenceOk returns a tuple with the TransportLegReference field value and a boolean to check if the value has been set.

func (*TransportEquipmentEvent) GetTransportReference 

func (o *TransportEquipmentEvent) GetTransportReference() string

GetTransportReference returns the TransportReference field value

func (*TransportEquipmentEvent) GetTransportReferenceOk 

func (o *TransportEquipmentEvent) GetTransportReferenceOk() (*string, bool)

GetTransportReferenceOk returns a tuple with the TransportReference field value and a boolean to check if the value has been set.

func (*TransportEquipmentEvent) GetUNLocationCode 

func (o *TransportEquipmentEvent) GetUNLocationCode() string

GetUNLocationCode returns the UNLocationCode field value

func (*TransportEquipmentEvent) GetUNLocationCodeOk 

func (o *TransportEquipmentEvent) GetUNLocationCodeOk() (*string, bool)

GetUNLocationCodeOk returns a tuple with the UNLocationCode field value and a boolean to check if the value has been set.

func (*TransportEquipmentEvent) HasOtherFacility 

func (o *TransportEquipmentEvent) HasOtherFacility() bool

HasOtherFacility returns a boolean if a field has been set.

func (TransportEquipmentEvent) MarshalJSON 

func (o TransportEquipmentEvent) MarshalJSON() ([]byte, error)

func (*TransportEquipmentEvent) SetEmptyIndicatorCode 

func (o *TransportEquipmentEvent) SetEmptyIndicatorCode(v string)

SetEmptyIndicatorCode sets field value

func (*TransportEquipmentEvent) SetEquipmentReference 

func (o *TransportEquipmentEvent) SetEquipmentReference(v string)

SetEquipmentReference sets field value

func (*TransportEquipmentEvent) SetEventClassifierCode 

func (o *TransportEquipmentEvent) SetEventClassifierCode(v string)

SetEventClassifierCode sets field value

func (*TransportEquipmentEvent) SetEventDateTime 

func (o *TransportEquipmentEvent) SetEventDateTime(v time.Time)

SetEventDateTime sets field value

func (*TransportEquipmentEvent) SetEventID 

func (o *TransportEquipmentEvent) SetEventID(v string)

SetEventID sets field value

func (*TransportEquipmentEvent) SetEventTypeCode 

func (o *TransportEquipmentEvent) SetEventTypeCode(v string)

SetEventTypeCode sets field value

func (*TransportEquipmentEvent) SetFacilityCode 

func (o *TransportEquipmentEvent) SetFacilityCode(v string)

SetFacilityCode sets field value

func (*TransportEquipmentEvent) SetFacilityTypeCode 

func (o *TransportEquipmentEvent) SetFacilityTypeCode(v string)

SetFacilityTypeCode sets field value

func (*TransportEquipmentEvent) SetModeOfTransportCode 

func (o *TransportEquipmentEvent) SetModeOfTransportCode(v string)

SetModeOfTransportCode sets field value

func (*TransportEquipmentEvent) SetOtherFacility 

func (o *TransportEquipmentEvent) SetOtherFacility(v string)

SetOtherFacility gets a reference to the given string and assigns it to the OtherFacility field.

func (*TransportEquipmentEvent) SetTransportLegReference 

func (o *TransportEquipmentEvent) SetTransportLegReference(v string)

SetTransportLegReference sets field value

func (*TransportEquipmentEvent) SetTransportReference 

func (o *TransportEquipmentEvent) SetTransportReference(v string)

SetTransportReference sets field value

func (*TransportEquipmentEvent) SetUNLocationCode 

func (o *TransportEquipmentEvent) SetUNLocationCode(v string)

SetUNLocationCode sets field value

type TransportEvent 

type TransportEvent struct {
	// The unique identifier for the Equipment Event ID/Transport Event ID/Shipment Event ID.
	EventID string `json:"eventID"`
	// The local date and time, where the event took place, in ISO 8601 format.
	EventDateTime time.Time `json:"eventDateTime"`
	// Code for the event classifier, either PLN, ACT or EST.
	EventClassifierCode string `json:"eventClassifierCode"`
	// Unique identifier for Event Type Code.
	EventTypeCode string `json:"eventTypeCode"`
	// The reference for the transport, e.g. when the mode of transport is a vessel, the transport reference will be the vessel IMO number.
	TransportReference string `json:"transportReference"`
	// The transport leg reference will be specific per mode of transport:  Vessel: Voyage number as specified by the vessel operator  Truck: Not yet specified  Rail: Not yet specified  Barge: Not yet specified.
	TransportLegReference string `json:"transportLegReference"`
	// The code to identify the specific type of facility.
	FacilityTypeCode string `json:"facilityTypeCode"`
	// The UN Location Code identifies a location in the sense of a city/a town/a village, being the smaller administrative area existing as defined by the competent national authority in each country.
	UNLocationCode string `json:"UNLocationCode"`
	// The code used for identifying the specific facility.
	FacilityCode string `json:"facilityCode"`
	// An alternative way to capture the facility when no standardized DCSA facility code can be found.
	OtherFacility *string `json:"otherFacility,omitempty"`
	// A code specifying a type of transport mode.
	ModeOfTransportCode string `json:"modeOfTransportCode"`
}

TransportEvent The transport event entity is a specialization of the event entity to support specification of data that only applies to a transport event.

func NewTransportEvent 

func NewTransportEvent(eventID string, eventDateTime time.Time, eventClassifierCode string, eventTypeCode string, transportReference string, transportLegReference string, facilityTypeCode string, uNLocationCode string, facilityCode string, modeOfTransportCode string) *TransportEvent

NewTransportEvent instantiates a new TransportEvent object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewTransportEventWithDefaults 

func NewTransportEventWithDefaults() *TransportEvent

NewTransportEventWithDefaults instantiates a new TransportEvent object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*TransportEvent) GetEventClassifierCode 

func (o *TransportEvent) GetEventClassifierCode() string

GetEventClassifierCode returns the EventClassifierCode field value

func (*TransportEvent) GetEventClassifierCodeOk 

func (o *TransportEvent) GetEventClassifierCodeOk() (*string, bool)

GetEventClassifierCodeOk returns a tuple with the EventClassifierCode field value and a boolean to check if the value has been set.

func (*TransportEvent) GetEventDateTime 

func (o *TransportEvent) GetEventDateTime() time.Time

GetEventDateTime returns the EventDateTime field value

func (*TransportEvent) GetEventDateTimeOk 

func (o *TransportEvent) GetEventDateTimeOk() (*time.Time, bool)

GetEventDateTimeOk returns a tuple with the EventDateTime field value and a boolean to check if the value has been set.

func (*TransportEvent) GetEventID 

func (o *TransportEvent) GetEventID() string

GetEventID returns the EventID field value

func (*TransportEvent) GetEventIDOk 

func (o *TransportEvent) GetEventIDOk() (*string, bool)

GetEventIDOk returns a tuple with the EventID field value and a boolean to check if the value has been set.

func (*TransportEvent) GetEventTypeCode 

func (o *TransportEvent) GetEventTypeCode() string

GetEventTypeCode returns the EventTypeCode field value

func (*TransportEvent) GetEventTypeCodeOk 

func (o *TransportEvent) GetEventTypeCodeOk() (*string, bool)

GetEventTypeCodeOk returns a tuple with the EventTypeCode field value and a boolean to check if the value has been set.

func (*TransportEvent) GetFacilityCode 

func (o *TransportEvent) GetFacilityCode() string

GetFacilityCode returns the FacilityCode field value

func (*TransportEvent) GetFacilityCodeOk 

func (o *TransportEvent) GetFacilityCodeOk() (*string, bool)

GetFacilityCodeOk returns a tuple with the FacilityCode field value and a boolean to check if the value has been set.

func (*TransportEvent) GetFacilityTypeCode 

func (o *TransportEvent) GetFacilityTypeCode() string

GetFacilityTypeCode returns the FacilityTypeCode field value

func (*TransportEvent) GetFacilityTypeCodeOk 

func (o *TransportEvent) GetFacilityTypeCodeOk() (*string, bool)

GetFacilityTypeCodeOk returns a tuple with the FacilityTypeCode field value and a boolean to check if the value has been set.

func (*TransportEvent) GetModeOfTransportCode 

func (o *TransportEvent) GetModeOfTransportCode() string

GetModeOfTransportCode returns the ModeOfTransportCode field value

func (*TransportEvent) GetModeOfTransportCodeOk 

func (o *TransportEvent) GetModeOfTransportCodeOk() (*string, bool)

GetModeOfTransportCodeOk returns a tuple with the ModeOfTransportCode field value and a boolean to check if the value has been set.

func (*TransportEvent) GetOtherFacility 

func (o *TransportEvent) GetOtherFacility() string

GetOtherFacility returns the OtherFacility field value if set, zero value otherwise.

func (*TransportEvent) GetOtherFacilityOk 

func (o *TransportEvent) GetOtherFacilityOk() (*string, bool)

GetOtherFacilityOk returns a tuple with the OtherFacility field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TransportEvent) GetTransportLegReference 

func (o *TransportEvent) GetTransportLegReference() string

GetTransportLegReference returns the TransportLegReference field value

func (*TransportEvent) GetTransportLegReferenceOk 

func (o *TransportEvent) GetTransportLegReferenceOk() (*string, bool)

GetTransportLegReferenceOk returns a tuple with the TransportLegReference field value and a boolean to check if the value has been set.

func (*TransportEvent) GetTransportReference 

func (o *TransportEvent) GetTransportReference() string

GetTransportReference returns the TransportReference field value

func (*TransportEvent) GetTransportReferenceOk 

func (o *TransportEvent) GetTransportReferenceOk() (*string, bool)

GetTransportReferenceOk returns a tuple with the TransportReference field value and a boolean to check if the value has been set.

func (*TransportEvent) GetUNLocationCode 

func (o *TransportEvent) GetUNLocationCode() string

GetUNLocationCode returns the UNLocationCode field value

func (*TransportEvent) GetUNLocationCodeOk 

func (o *TransportEvent) GetUNLocationCodeOk() (*string, bool)

GetUNLocationCodeOk returns a tuple with the UNLocationCode field value and a boolean to check if the value has been set.

func (*TransportEvent) HasOtherFacility 

func (o *TransportEvent) HasOtherFacility() bool

HasOtherFacility returns a boolean if a field has been set.

func (TransportEvent) MarshalJSON 

func (o TransportEvent) MarshalJSON() ([]byte, error)

func (*TransportEvent) SetEventClassifierCode 

func (o *TransportEvent) SetEventClassifierCode(v string)

SetEventClassifierCode sets field value

func (*TransportEvent) SetEventDateTime 

func (o *TransportEvent) SetEventDateTime(v time.Time)

SetEventDateTime sets field value

func (*TransportEvent) SetEventID 

func (o *TransportEvent) SetEventID(v string)

SetEventID sets field value

func (*TransportEvent) SetEventTypeCode 

func (o *TransportEvent) SetEventTypeCode(v string)

SetEventTypeCode sets field value

func (*TransportEvent) SetFacilityCode 

func (o *TransportEvent) SetFacilityCode(v string)

SetFacilityCode sets field value

func (*TransportEvent) SetFacilityTypeCode 

func (o *TransportEvent) SetFacilityTypeCode(v string)

SetFacilityTypeCode sets field value

func (*TransportEvent) SetModeOfTransportCode 

func (o *TransportEvent) SetModeOfTransportCode(v string)

SetModeOfTransportCode sets field value

func (*TransportEvent) SetOtherFacility 

func (o *TransportEvent) SetOtherFacility(v string)

SetOtherFacility gets a reference to the given string and assigns it to the OtherFacility field.

func (*TransportEvent) SetTransportLegReference 

func (o *TransportEvent) SetTransportLegReference(v string)

SetTransportLegReference sets field value

func (*TransportEvent) SetTransportReference 

func (o *TransportEvent) SetTransportReference(v string)

SetTransportReference sets field value

func (*TransportEvent) SetUNLocationCode 

func (o *TransportEvent) SetUNLocationCode(v string)

SetUNLocationCode sets field value

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.