Class FaaNms

FAA NOTAM Management Service - Easy access to the NMS. You will need to obtain credentials from FAA before using this

Inheritance

object

FaaNms

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: FpAssistantCore.Faa.Nms

Assembly: FpAssistantCoreScl.dll

Syntax

public static class FaaNms

Properties

Token

Properties of the Token if a successful connection to FAA NMS

Declaration

public static Token Token { get; }

Property Value

Type	Description
Token	Token object

Remarks

If token is null then no connection has been established but connection may time out

Methods

Credentials(string, string)

Pass your credential to the static class

Declaration

public static void Credentials(string key, string secret)

Parameters

Type	Name	Description
string	key	Your key obtsain from the FAA
string	secret	Your secret obtsain from the FAA

Remarks

This must be called before you call any other class methods to query the NOTAM data

Exceptions

Type	Condition
ArgumentException	If key and/or secret is null, whitespace or empty

ObtainInitialLoad()

Downloads to a file the initial load of NOTAMS from NMS

Declaration

public static Task<(HttpStatusCode, string tmpInitialLoadFile)> ObtainInitialLoad()

Returns

Type	Description
Task<(HttpStatusCode, string tmpInitialLoadFile)>	Tuple of response.StatusCode from web API call and filename with path to initial load file

Remarks

File is compressed

ObtainLocationSeries()

Gets a list of Location Series from FAA NMS

Declaration

public static Task<(HttpStatusCode, LocationSeriesRoot)> ObtainLocationSeries()

Returns

Type	Description
Task<(HttpStatusCode, LocationSeriesRoot)>	Tuple of StatusCode from web API call and LocationSeriesRoot

ObtainNotams(string)

Gets a list of NOTAMS from FAA Portal based on selection using parameters below

Declaration

public static Task<(HttpStatusCode, Notam[])> ObtainNotams(string location = "")

Parameters

Type	Name	Description
string	location

Returns

Type	Description
Task<(HttpStatusCode, Notam[])>	Tuple of response.StatusCode from web API call and Notam