GET //v1/types/fos
get a list of all fields of science

Examples

GET /v1/types/fos
{
   "message":null,
   "result":[
      {
         "fosTypeId":1,
         "fosName":"Mathematical and Physical Sciences",
         "fosAbbr":"MPS",
         "fosNum":100,
         "fosTypeParentId":null,
         "isActive":true
      },
      {
         "fosTypeId":2,
         "fosName":"Mathematical Sciences",
         "fosAbbr":"DMS",
         "fosNum":110,
         "fosTypeParentId":1,
         "isActive":true
      },
      {
         "fosTypeId":3,
         "fosName":"Classical Analysis",
         "fosAbbr":null,
         "fosNum":111,
         "fosTypeParentId":2,
         "isActive":true
      },
      {
         "fosTypeId":4,
         "fosName":"Modern Analysis",
         "fosAbbr":null,
         "fosNum":112,
         "fosTypeParentId":2,
         "isActive":true
      },
      {
         "fosTypeId":5,
         "fosName":"Geometric Analysis",
         "fosAbbr":null,
         "fosNum":113,
         "fosTypeParentId":2,
         "isActive":true
      },
      {
         "fosTypeId":6,
         "fosName":"Topology and Foundations",
         "fosAbbr":null,
         "fosNum":114,
         "fosTypeParentId":2,
         "isActive":true
      },
      {
         "fosTypeId":7,
         "fosName":"Algebra and Number Theory",
         "fosAbbr":null,
         "fosNum":115,
         "fosTypeParentId":2,
         "isActive":true
      },
      {
         "fosTypeId":8,
         "fosName":"Applied Mathematics",
         "fosAbbr":null,
         "fosNum":116,
         "fosTypeParentId":2,
         "isActive":true
      },
      {
         "fosTypeId":9,
         "fosName":"Statistics and Probability",
         "fosAbbr":null,
         "fosNum":117,
         "fosTypeParentId":2,
         "isActive":true
      },
      {
         "fosTypeId":10,
         "fosName":"Computational Mathematics",
         "fosAbbr":null,
         "fosNum":118,
         "fosTypeParentId":2,
         "isActive":true
      },
      {
         "fosTypeId":11,
         "fosName":"Astronomical Sciences",
         "fosAbbr":"AST",
         "fosNum":120,
         "fosTypeParentId":1,
         "isActive":true
      },
      {
         "fosTypeId":12,
         "fosName":"Extragalactic Astronomy and Cosmology",
         "fosAbbr":null,
         "fosNum":121,
         "fosTypeParentId":11,
         "isActive":true
      },
      {
         "fosTypeId":13,
         "fosName":"Planetary Astronomy",
         "fosAbbr":null,
         "fosNum":122,
         "fosTypeParentId":11,
         "isActive":true
      },
      {
         "fosTypeId":14,
         "fosName":"Stellar Astronomy and Astrophysics",
         "fosAbbr":null,
         "fosNum":123,
         "fosTypeParentId":11,
         "isActive":true
      },
      {
         "fosTypeId":15,
         "fosName":"Galactic Astronomy",
         "fosAbbr":null,
         "fosNum":124,
         "fosTypeParentId":11,
         "isActive":true
      },
      {
         "fosTypeId":16,
         "fosName":"Physics",
         "fosAbbr":"PHY",
         "fosNum":130,
         "fosTypeParentId":1,
         "isActive":true
      },
      {
         "fosTypeId":17,
         "fosName":"Elementary Particle Physics",
         "fosAbbr":null,
         "fosNum":131,
         "fosTypeParentId":16,
         "isActive":true
      },
      {
         "fosTypeId":18,
         "fosName":"Nuclear Physics",
         "fosAbbr":null,
         "fosNum":132,
         "fosTypeParentId":16,
         "isActive":true
      },
      {
         "fosTypeId":19,
         "fosName":"Atomic, Molecular, and Optical Physics",
         "fosAbbr":null,
         "fosNum":133,
         "fosTypeParentId":16,
         "isActive":true
      },
      {
         "fosTypeId":20,
         "fosName":"Theoretical Physics",
         "fosAbbr":null,
         "fosNum":134,
         "fosTypeParentId":16,
         "isActive":true
      },
      {
         "fosTypeId":21,
         "fosName":"Gravitational Physics",
         "fosAbbr":null,
         "fosNum":135,
         "fosTypeParentId":16,
         "isActive":true
      },
      {
         "fosTypeId":22,
         "fosName":"Chemistry",
         "fosAbbr":"CHE",
         "fosNum":140,
         "fosTypeParentId":1,
         "isActive":true
      },
      {
         "fosTypeId":23,
         "fosName":"Analytical and Surface Chemistry",
         "fosAbbr":null,
         "fosNum":141,
         "fosTypeParentId":22,
         "isActive":true
      },
      {
         "fosTypeId":24,
         "fosName":"Inorganic, Bioinorganic, and Organometallic Chemistry",
         "fosAbbr":null,
         "fosNum":142,
         "fosTypeParentId":22,
         "isActive":true
      },
      {
         "fosTypeId":25,
         "fosName":"Organic and Macromolecular Chemistry",
         "fosAbbr":null,
         "fosNum":143,
         "fosTypeParentId":22,
         "isActive":true
      },
      {
         "fosTypeId":26,
         "fosName":"Physical Chemistry",
         "fosAbbr":null,
         "fosNum":144,
         "fosTypeParentId":22,
         "isActive":true
      },
      {
         "fosTypeId":27,
         "fosName":"Materials Research",
         "fosAbbr":"DMR",
         "fosNum":150,
         "fosTypeParentId":1,
         "isActive":true
      },
      {
         "fosTypeId":28,
         "fosName":"Solid State Chemistry and Polymers",
         "fosAbbr":null,
         "fosNum":152,
         "fosTypeParentId":27,
         "isActive":true
      },
      {
         "fosTypeId":29,
         "fosName":"Condensed Matter Physics",
         "fosAbbr":null,
         "fosNum":154,
         "fosTypeParentId":27,
         "isActive":true
      },
      {
         "fosTypeId":30,
         "fosName":"Metals, Ceramics, and Electronic Materials",
         "fosAbbr":null,
         "fosNum":156,
         "fosTypeParentId":27,
         "isActive":true
      },
      {
         "fosTypeId":31,
         "fosName":"Computer and Information Science and Engineering",
         "fosAbbr":"CIE",
         "fosNum":300,
         "fosTypeParentId":null,
         "isActive":true
      },
      {
         "fosTypeId":32,
         "fosName":"Computer and Computation Research",
         "fosAbbr":"CCR",
         "fosNum":310,
         "fosTypeParentId":31,
         "isActive":true
      },
      {
         "fosTypeId":33,
         "fosName":"Computer and Computation Theory",
         "fosAbbr":null,
         "fosNum":311,
         "fosTypeParentId":32,
         "isActive":true
      },
      {
         "fosTypeId":34,
         "fosName":"Numeric and Symbolic Computation",
         "fosAbbr":null,
         "fosNum":312,
         "fosTypeParentId":32,
         "isActive":true
      },
      {
         "fosTypeId":35,
         "fosName":"Computer Systems Architecture",
         "fosAbbr":null,
         "fosNum":313,
         "fosTypeParentId":32,
         "isActive":true
      },
      {
         "fosTypeId":36,
         "fosName":"Software Systems",
         "fosAbbr":null,
         "fosNum":314,
         "fosTypeParentId":32,
         "isActive":true
      },
      {
         "fosTypeId":37,
         "fosName":"Software Engineering",
         "fosAbbr":null,
         "fosNum":315,
         "fosTypeParentId":32,
         "isActive":true
      },
      {
         "fosTypeId":38,
         "fosName":"Information, Robotics, and Intelligent Systems",
         "fosAbbr":"IRI",
         "fosNum":320,
         "fosTypeParentId":31,
         "isActive":true
      },
      {
         "fosTypeId":39,
         "fosName":"Knowledge Models and Cognitive Systems",
         "fosAbbr":null,
         "fosNum":321,
         "fosTypeParentId":38,
         "isActive":true
      },
      {
         "fosTypeId":40,
         "fosName":"Robotics and Machine Intelligence",
         "fosAbbr":null,
         "fosNum":322,
         "fosTypeParentId":38,
         "isActive":true
      },
      {
         "fosTypeId":41,
         "fosName":"Interactive Systems",
         "fosAbbr":null,
         "fosNum":323,
         "fosTypeParentId":38,
         "isActive":true
      },
      {
         "fosTypeId":42,
         "fosName":"Information Technology and Organizations",
         "fosAbbr":null,
         "fosNum":324,
         "fosTypeParentId":38,
         "isActive":true
      },
      {
         "fosTypeId":43,
         "fosName":"Microelectronic Information Processing Systems",
         "fosAbbr":"MIP",
         "fosNum":330,
         "fosTypeParentId":31,
         "isActive":true
      },
      {
         "fosTypeId":44,
         "fosName":"Microelectronic Systems Architecture",
         "fosAbbr":null,
         "fosNum":331,
         "fosTypeParentId":43,
         "isActive":true
      },
      {
         "fosTypeId":45,
         "fosName":"Circuits and Signal Processing",
         "fosAbbr":null,
         "fosNum":332,
         "fosTypeParentId":43,
         "isActive":true
      },
      {
         "fosTypeId":46,
         "fosName":"Experimental Systems",
         "fosAbbr":null,
         "fosNum":333,
         "fosTypeParentId":43,
         "isActive":true
      },
      {
         "fosTypeId":47,
         "fosName":"Systems Prototyping and Fabrication",
         "fosAbbr":null,
         "fosNum":334,
         "fosTypeParentId":43,
         "isActive":true
      },
      {
         "fosTypeId":48,
         "fosName":"Design, Tools, and Test",
         "fosAbbr":null,
         "fosNum":335,
         "fosTypeParentId":43,
         "isActive":true
      },
      {
         "fosTypeId":49,
         "fosName":"Advanced Scientific Computing",
         "fosAbbr":"ASC",
         "fosNum":340,
         "fosTypeParentId":31,
         "isActive":true
      },
      {
         "fosTypeId":50,
         "fosName":"Performance Evaluation and Benchmarking",
         "fosAbbr":null,
         "fosNum":341,
         "fosTypeParentId":49,
         "isActive":true
      },
      {
         "fosTypeId":51,
         "fosName":"Algorithm Development",
         "fosAbbr":null,
         "fosNum":342,
         "fosTypeParentId":49,
         "isActive":true
      },
      {
         "fosTypeId":52,
         "fosName":"Visualization, Graphics, and Image Processing",
         "fosAbbr":null,
         "fosNum":343,
         "fosTypeParentId":49,
         "isActive":true
      },
      {
         "fosTypeId":53,
         "fosName":"Software Development",
         "fosAbbr":null,
         "fosNum":344,
         "fosTypeParentId":49,
         "isActive":true
      },
      {
         "fosTypeId":54,
         "fosName":"Distributed and Parallel Processing, Vectorization",
         "fosAbbr":null,
         "fosNum":345,
         "fosTypeParentId":49,
         "isActive":true
      },
      {
         "fosTypeId":55,
         "fosName":"Networking and Communications Research",
         "fosAbbr":"NCR",
         "fosNum":350,
         "fosTypeParentId":31,
         "isActive":true
      },
      {
         "fosTypeId":56,
         "fosName":"Cross-Disciplinary Activities",
         "fosAbbr":"CDA",
         "fosNum":360,
         "fosTypeParentId":31,
         "isActive":true
      },
      {
         "fosTypeId":57,
         "fosName":"Research Instrumentation",
         "fosAbbr":null,
         "fosNum":361,
         "fosTypeParentId":56,
         "isActive":true
      },
      {
         "fosTypeId":58,
         "fosName":"Institutional Infrastructure",
         "fosAbbr":null,
         "fosNum":362,
         "fosTypeParentId":56,
         "isActive":true
      },
      {
         "fosTypeId":59,
         "fosName":"Educational Infrastructure",
         "fosAbbr":null,
         "fosNum":363,
         "fosTypeParentId":56,
         "isActive":true
      },
      {
         "fosTypeId":60,
         "fosName":"Cross-Directorate Activities",
         "fosAbbr":null,
         "fosNum":364,
         "fosTypeParentId":56,
         "isActive":true
      },
      {
         "fosTypeId":61,
         "fosName":"Special Projects",
         "fosAbbr":null,
         "fosNum":365,
         "fosTypeParentId":56,
         "isActive":true
      },
      {
         "fosTypeId":62,
         "fosName":"Biological Sciences",
         "fosAbbr":"BIO",
         "fosNum":401,
         "fosTypeParentId":null,
         "isActive":true
      },
      {
         "fosTypeId":63,
         "fosName":"Social, Behavioral, and Economic Sciences",
         "fosAbbr":"SBE",
         "fosNum":402,
         "fosTypeParentId":null,
         "isActive":true
      },
      {
         "fosTypeId":64,
         "fosName":"Molecular Biosciences",
         "fosAbbr":"MCB",
         "fosNum":410,
         "fosTypeParentId":62,
         "isActive":true
      },
      {
         "fosTypeId":65,
         "fosName":"Biochemistry and Molecular Structure and Function",
         "fosAbbr":null,
         "fosNum":411,
         "fosTypeParentId":64,
         "isActive":true
      },
      {
         "fosTypeId":66,
         "fosName":"Biophysics",
         "fosAbbr":null,
         "fosNum":412,
         "fosTypeParentId":64,
         "isActive":true
      },
      {
         "fosTypeId":67,
         "fosName":"Genetics and Nucleic Acids",
         "fosAbbr":null,
         "fosNum":413,
         "fosTypeParentId":64,
         "isActive":true
      },
      {
         "fosTypeId":68,
         "fosName":"Cell Biology",
         "fosAbbr":null,
         "fosNum":414,
         "fosTypeParentId":64,
         "isActive":true
      },
      {
         "fosTypeId":69,
         "fosName":"Environmental Biology",
         "fosAbbr":"DEB",
         "fosNum":430,
         "fosTypeParentId":62,
         "isActive":true
      },
      {
         "fosTypeId":70,
         "fosName":"Ecological Studies",
         "fosAbbr":null,
         "fosNum":431,
         "fosTypeParentId":69,
         "isActive":true
      },
      {
         "fosTypeId":71,
         "fosName":"Systematic and Population Biology",
         "fosAbbr":null,
         "fosNum":433,
         "fosTypeParentId":69,
         "isActive":true
      },
      {
         "fosTypeId":72,
         "fosName":"Behavioral and Neural Sciences",
         "fosAbbr":"BNS",
         "fosNum":440,
         "fosTypeParentId":63,
         "isActive":true
      },
      {
         "fosTypeId":73,
         "fosName":"Anthropology",
         "fosAbbr":null,
         "fosNum":441,
         "fosTypeParentId":72,
         "isActive":true
      },
      {
         "fosTypeId":74,
         "fosName":"Language, Cognition, and Social Behavior",
         "fosAbbr":null,
         "fosNum":442,
         "fosTypeParentId":72,
         "isActive":true
      },
      {
         "fosTypeId":75,
         "fosName":"Social and Economic Science",
         "fosAbbr":"SES",
         "fosNum":450,
         "fosTypeParentId":63,
         "isActive":true
      },
      {
         "fosTypeId":76,
         "fosName":"Economics",
         "fosAbbr":null,
         "fosNum":451,
         "fosTypeParentId":75,
         "isActive":true
      },
      {
         "fosTypeId":77,
         "fosName":"Geography and Regional Science",
         "fosAbbr":null,
         "fosNum":452,
         "fosTypeParentId":75,
         "isActive":true
      },
      {
         "fosTypeId":78,
         "fosName":"Sociology",
         "fosAbbr":null,
         "fosNum":453,
         "fosTypeParentId":75,
         "isActive":true
      },
      {
         "fosTypeId":79,
         "fosName":"Methodology, Measurement, and Statistics",
         "fosAbbr":null,
         "fosNum":454,
         "fosTypeParentId":75,
         "isActive":true
      },
      {
         "fosTypeId":80,
         "fosName":"Political Science",
         "fosAbbr":null,
         "fosNum":455,
         "fosTypeParentId":75,
         "isActive":true
      },
      {
         "fosTypeId":81,
         "fosName":"Law and Social Sciences",
         "fosAbbr":null,
         "fosNum":456,
         "fosTypeParentId":75,
         "isActive":true
      },
      {
         "fosTypeId":82,
         "fosName":"Decision, Risk, and Management Science",
         "fosAbbr":null,
         "fosNum":457,
         "fosTypeParentId":75,
         "isActive":true
      },
      {
         "fosTypeId":83,
         "fosName":"Biological Instrumentation and Resources",
         "fosAbbr":"BIR",
         "fosNum":460,
         "fosTypeParentId":62,
         "isActive":true
      },
      {
         "fosTypeId":84,
         "fosName":"Integrative Biology and Neuroscience",
         "fosAbbr":"IBN",
         "fosNum":470,
         "fosTypeParentId":62,
         "isActive":true
      },
      {
         "fosTypeId":85,
         "fosName":"Developmental Biology",
         "fosAbbr":null,
         "fosNum":471,
         "fosTypeParentId":84,
         "isActive":true
      },
      {
         "fosTypeId":86,
         "fosName":"Neuroscience Biology",
         "fosAbbr":null,
         "fosNum":472,
         "fosTypeParentId":84,
         "isActive":true
      },
      {
         "fosTypeId":87,
         "fosName":"Physiology and Behavior",
         "fosAbbr":null,
         "fosNum":473,
         "fosTypeParentId":84,
         "isActive":true
      },
      {
         "fosTypeId":88,
         "fosName":"Science Resources Studies",
         "fosAbbr":"SRS",
         "fosNum":480,
         "fosTypeParentId":63,
         "isActive":true
      },
      {
         "fosTypeId":89,
         "fosName":"International Programs",
         "fosAbbr":"INT",
         "fosNum":490,
         "fosTypeParentId":63,
         "isActive":true
      },
      {
         "fosTypeId":90,
         "fosName":"Geosciences",
         "fosAbbr":"GEO",
         "fosNum":500,
         "fosTypeParentId":null,
         "isActive":true
      },
      {
         "fosTypeId":91,
         "fosName":"Atmospheric Sciences",
         "fosAbbr":"ATM",
         "fosNum":510,
         "fosTypeParentId":90,
         "isActive":true
      },
      {
         "fosTypeId":92,
         "fosName":"Meteorology",
         "fosAbbr":null,
         "fosNum":511,
         "fosTypeParentId":91,
         "isActive":true
      },
      {
         "fosTypeId":93,
         "fosName":"Atmospheric Chemistry",
         "fosAbbr":null,
         "fosNum":512,
         "fosTypeParentId":91,
         "isActive":true
      },
      {
         "fosTypeId":94,
         "fosName":"Climate Dynamics",
         "fosAbbr":null,
         "fosNum":514,
         "fosTypeParentId":91,
         "isActive":true
      },
      {
         "fosTypeId":95,
         "fosName":"Global Atmospheric Research",
         "fosAbbr":null,
         "fosNum":515,
         "fosTypeParentId":91,
         "isActive":true
      },
      {
         "fosTypeId":96,
         "fosName":"Aeronomy",
         "fosAbbr":null,
         "fosNum":516,
         "fosTypeParentId":91,
         "isActive":true
      },
      {
         "fosTypeId":97,
         "fosName":"Magnetospheric Physics",
         "fosAbbr":null,
         "fosNum":517,
         "fosTypeParentId":91,
         "isActive":true
      },
      {
         "fosTypeId":98,
         "fosName":"Solar Terrestrial Research",
         "fosAbbr":null,
         "fosNum":518,
         "fosTypeParentId":91,
         "isActive":true
      },
      {
         "fosTypeId":99,
         "fosName":"Earth Sciences",
         "fosAbbr":"EAR",
         "fosNum":520,
         "fosTypeParentId":90,
         "isActive":true
      },
      {
         "fosTypeId":100,
         "fosName":"Geology and Paleontology",
         "fosAbbr":null,
         "fosNum":521,
         "fosTypeParentId":99,
         "isActive":true
      },
      {
         "fosTypeId":101,
         "fosName":"Surficial Processes",
         "fosAbbr":null,
         "fosNum":522,
         "fosTypeParentId":99,
         "isActive":true
      },
      {
         "fosTypeId":102,
         "fosName":"Tectonics",
         "fosAbbr":null,
         "fosNum":523,
         "fosTypeParentId":99,
         "isActive":true
      },
      {
         "fosTypeId":103,
         "fosName":"Seismology",
         "fosAbbr":null,
         "fosNum":524,
         "fosTypeParentId":99,
         "isActive":true
      },
      {
         "fosTypeId":104,
         "fosName":"Geophysics",
         "fosAbbr":null,
         "fosNum":525,
         "fosTypeParentId":99,
         "isActive":true
      },
      {
         "fosTypeId":105,
         "fosName":"Petrogenesis and Mineral Resources",
         "fosAbbr":null,
         "fosNum":526,
         "fosTypeParentId":99,
         "isActive":true
      },
      {
         "fosTypeId":106,
         "fosName":"Volcanology and Mantle Geochemistry",
         "fosAbbr":null,
         "fosNum":527,
         "fosTypeParentId":99,
         "isActive":true
      },
      {
         "fosTypeId":107,
         "fosName":"Experimental and Theoretical Geochemistry",
         "fosAbbr":null,
         "fosNum":528,
         "fosTypeParentId":99,
         "isActive":true
      },
      {
         "fosTypeId":108,
         "fosName":"Ocean Sciences",
         "fosAbbr":"OCE",
         "fosNum":530,
         "fosTypeParentId":90,
         "isActive":true
      },
      {
         "fosTypeId":109,
         "fosName":"Biological Oceanography",
         "fosAbbr":null,
         "fosNum":531,
         "fosTypeParentId":108,
         "isActive":true
      },
      {
         "fosTypeId":110,
         "fosName":"Chemical Oceanography",
         "fosAbbr":null,
         "fosNum":532,
         "fosTypeParentId":108,
         "isActive":true
      },
      {
         "fosTypeId":111,
         "fosName":"Physical Oceanography",
         "fosAbbr":null,
         "fosNum":533,
         "fosTypeParentId":108,
         "isActive":true
      },
      {
         "fosTypeId":112,
         "fosName":"Marine Geology and Geophysics",
         "fosAbbr":null,
         "fosNum":534,
         "fosTypeParentId":108,
         "isActive":true
      },
      {
         "fosTypeId":113,
         "fosName":"Polar Programs",
         "fosAbbr":"DPP",
         "fosNum":540,
         "fosTypeParentId":90,
         "isActive":true
      },
      {
         "fosTypeId":114,
         "fosName":"Polar Glaciology",
         "fosAbbr":null,
         "fosNum":541,
         "fosTypeParentId":113,
         "isActive":true
      },
      {
         "fosTypeId":115,
         "fosName":"Polar Aeronomy and Astrophysics",
         "fosAbbr":null,
         "fosNum":542,
         "fosTypeParentId":113,
         "isActive":true
      },
      {
         "fosTypeId":116,
         "fosName":"Polar Biology and Medicine",
         "fosAbbr":null,
         "fosNum":543,
         "fosTypeParentId":113,
         "isActive":true
      },
      {
         "fosTypeId":117,
         "fosName":"Polar Earth Sciences",
         "fosAbbr":null,
         "fosNum":544,
         "fosTypeParentId":113,
         "isActive":true
      },
      {
         "fosTypeId":118,
         "fosName":"Polar Meteorology",
         "fosAbbr":null,
         "fosNum":545,
         "fosTypeParentId":113,
         "isActive":true
      },
      {
         "fosTypeId":119,
         "fosName":"Polar Ocean and Climate Systems",
         "fosAbbr":null,
         "fosNum":546,
         "fosTypeParentId":113,
         "isActive":true
      },
      {
         "fosTypeId":120,
         "fosName":"Engineering",
         "fosAbbr":"ENG",
         "fosNum":600,
         "fosTypeParentId":null,
         "isActive":true
      },
      {
         "fosTypeId":121,
         "fosName":"Chemical, Thermal Systems",
         "fosAbbr":"CTS",
         "fosNum":610,
         "fosTypeParentId":120,
         "isActive":true
      },
      {
         "fosTypeId":122,
         "fosName":"Chemical and Reaction Processes",
         "fosAbbr":null,
         "fosNum":611,
         "fosTypeParentId":121,
         "isActive":true
      },
      {
         "fosTypeId":123,
         "fosName":"Interfacial, Transport, and Separations Processes",
         "fosAbbr":null,
         "fosNum":612,
         "fosTypeParentId":121,
         "isActive":true
      },
      {
         "fosTypeId":124,
         "fosName":"Thermal Systems",
         "fosAbbr":null,
         "fosNum":613,
         "fosTypeParentId":121,
         "isActive":true
      },
      {
         "fosTypeId":125,
         "fosName":"Fluid, Particulate, and Hydraulic Systems",
         "fosAbbr":null,
         "fosNum":614,
         "fosTypeParentId":121,
         "isActive":true
      },
      {
         "fosTypeId":126,
         "fosName":"Mechanical and Structural Systems",
         "fosAbbr":"MSS",
         "fosNum":620,
         "fosTypeParentId":120,
         "isActive":true
      },
      {
         "fosTypeId":127,
         "fosName":"Dynamic Systems and Control",
         "fosAbbr":null,
         "fosNum":621,
         "fosTypeParentId":126,
         "isActive":true
      },
      {
         "fosTypeId":128,
         "fosName":"Structures and Building Systems",
         "fosAbbr":null,
         "fosNum":622,
         "fosTypeParentId":126,
         "isActive":true
      },
      {
         "fosTypeId":129,
         "fosName":"Mechanics and Materials",
         "fosAbbr":null,
         "fosNum":623,
         "fosTypeParentId":126,
         "isActive":true
      },
      {
         "fosTypeId":130,
         "fosName":"Surface Engineering and Tribology",
         "fosAbbr":null,
         "fosNum":625,
         "fosTypeParentId":126,
         "isActive":true
      },
      {
         "fosTypeId":131,
         "fosName":"Electrical and Communication Systems",
         "fosAbbr":"ECS",
         "fosNum":630,
         "fosTypeParentId":120,
         "isActive":true
      },
      {
         "fosTypeId":132,
         "fosName":"Quantum Electronics, Waves, and Beams",
         "fosAbbr":null,
         "fosNum":631,
         "fosTypeParentId":131,
         "isActive":true
      },
      {
         "fosTypeId":133,
         "fosName":"Solid-State and Microstructures",
         "fosAbbr":null,
         "fosNum":632,
         "fosTypeParentId":131,
         "isActive":true
      },
      {
         "fosTypeId":134,
         "fosName":"Communications and Computational Systems",
         "fosAbbr":null,
         "fosNum":633,
         "fosTypeParentId":131,
         "isActive":true
      },
      {
         "fosTypeId":135,
         "fosName":"Engineering Systems",
         "fosAbbr":null,
         "fosNum":634,
         "fosTypeParentId":131,
         "isActive":true
      },
      {
         "fosTypeId":136,
         "fosName":"Emerging Technologies Initiation",
         "fosAbbr":null,
         "fosNum":635,
         "fosTypeParentId":131,
         "isActive":true
      },
      {
         "fosTypeId":137,
         "fosName":"Design and Manufacturing Systems",
         "fosAbbr":"DDM",
         "fosNum":640,
         "fosTypeParentId":120,
         "isActive":true
      },
      {
         "fosTypeId":138,
         "fosName":"Operations Research and Production Systems",
         "fosAbbr":null,
         "fosNum":641,
         "fosTypeParentId":137,
         "isActive":true
      },
      {
         "fosTypeId":139,
         "fosName":"Design and Computer-Integrated Engineering",
         "fosAbbr":null,
         "fosNum":642,
         "fosTypeParentId":137,
         "isActive":true
      },
      {
         "fosTypeId":140,
         "fosName":"Manufacturing Processes and Equipment",
         "fosAbbr":null,
         "fosNum":643,
         "fosTypeParentId":137,
         "isActive":true
      },
      {
         "fosTypeId":141,
         "fosName":"Biological and Critical Systems",
         "fosAbbr":"BCS",
         "fosNum":650,
         "fosTypeParentId":120,
         "isActive":true
      },
      {
         "fosTypeId":142,
         "fosName":"Bioengineering Aiding the Disabled",
         "fosAbbr":null,
         "fosNum":651,
         "fosTypeParentId":141,
         "isActive":true
      },
      {
         "fosTypeId":143,
         "fosName":"Environmental and Ocean Systems",
         "fosAbbr":null,
         "fosNum":652,
         "fosTypeParentId":141,
         "isActive":true
      },
      {
         "fosTypeId":144,
         "fosName":"Earthquake Hazard Mitigation",
         "fosAbbr":null,
         "fosNum":653,
         "fosTypeParentId":141,
         "isActive":true
      },
      {
         "fosTypeId":145,
         "fosName":"Natural and Man-Made Hazard Mitigation",
         "fosAbbr":null,
         "fosNum":654,
         "fosTypeParentId":141,
         "isActive":true
      },
      {
         "fosTypeId":146,
         "fosName":"Engineering Centers",
         "fosAbbr":"ECD",
         "fosNum":660,
         "fosTypeParentId":120,
         "isActive":true
      },
      {
         "fosTypeId":147,
         "fosName":"Engineering Infrastructure Development",
         "fosAbbr":"EId",
         "fosNum":670,
         "fosTypeParentId":120,
         "isActive":true
      },
      {
         "fosTypeId":148,
         "fosName":"Industrial Science and Technological Innovation",
         "fosAbbr":"ISI",
         "fosNum":680,
         "fosTypeParentId":120,
         "isActive":true
      },
      {
         "fosTypeId":149,
         "fosName":"Other",
         "fosAbbr":null,
         "fosNum":900,
         "fosTypeParentId":null,
         "isActive":true
      },
      {
         "fosTypeId":150,
         "fosName":"Science and Engineering Education",
         "fosAbbr":"SEE",
         "fosNum":910,
         "fosTypeParentId":149,
         "isActive":true
      },
      {
         "fosTypeId":151,
         "fosName":"Small Business Innovation Research",
         "fosAbbr":"SBR",
         "fosNum":920,
         "fosTypeParentId":149,
         "isActive":true
      },
      {
         "fosTypeId":152,
         "fosName":"Industrial Partners Research",
         "fosAbbr":"IND",
         "fosNum":930,
         "fosTypeParentId":149,
         "isActive":true
      },
      {
         "fosTypeId":153,
         "fosName":"Center Systems Staff",
         "fosAbbr":"STA",
         "fosNum":940,
         "fosTypeParentId":149,
         "isActive":true
      },
      {
         "fosTypeId":154,
         "fosName":"Training",
         "fosAbbr":"TRA",
         "fosNum":950,
         "fosTypeParentId":149,
         "isActive":true
      },
      {
         "fosTypeId":155,
         "fosName":"Block Grants",
         "fosAbbr":null,
         "fosNum":960,
         "fosTypeParentId":149,
         "isActive":true
      }
   ]
}

Returns

Code: 200

Description:

OK

Param name Description
fosTypeId
required

Validations:

  • Must be a Integer

fosName
required

Validations:

  • Must be a String

fosAbbr
required

Validations:

  • Must be a String

fosNum
required

Validations:

  • Must be a Integer

fosTypeParentId
required

Validations:

  • Must be one of: Integer, nil.

isActive
required

Validations:

  • Must be one of: true, false.


GET //v1/types/grants
get a list of grant types

Examples

GET /v1/types/grants
{
   "message": null,
   "result": [
      {
         "grantTypeId": 1,
         "grantType": "Campus Champions",
         "displayGrantType": "Campus Champions",
         "isActive": true,
         "relativeOrder": 1
      },
      {
         "grantTypeId": 3,
         "grantType": "Education",
         "displayGrantType": "Education",
         "isActive": true,
         "relativeOrder": 2
      }
   ]
}

Returns

Code: 200

Description:

OK

Param name Description
grantTypeId
required

Validations:

  • Must be a Integer

grantType
required

Validations:

  • Must be a String

displayGrantType
required

Validations:

  • Must be a String

isActive
required

Validations:

  • Must be one of: true, false.

relativeOrder
required

Validations:

  • Must be one of: Integer, null.


GET //v1/types/documents
get a list of document types

Examples

GET /v1/types/documents
{
   "message":null,
   "result":[
      {
         "documentTypeId":5,
         "documentType":"XSEDE_Publications",
         "displayDocumentType":"List of Publications Resulting from XSEDE Support",
         "isActive":false,
         "allocationActionTypes":[

         ]
      },
      {
         "documentTypeId":1,
         "documentType":"MainDoc",
         "displayDocumentType":"Main Document",
         "isActive":true,
         "allocationActionTypes":[
            {
               "allocationTypeId":500016,
               "actionTypes":[
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":15,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":15,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":5,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            },
            {
               "allocationTypeId":500018,
               "actionTypes":[
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":15,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":15,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":5,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            },
            {
               "allocationTypeId":500007,
               "actionTypes":[
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":15,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            }
         ]
      },
      {
         "documentTypeId":3,
         "documentType":"CV_CoPI",
         "displayDocumentType":"CoPI CV",
         "isActive":true,
         "allocationActionTypes":[
            {
               "allocationTypeId":500019,
               "actionTypes":[
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":true
                  }
               ]
            },
            {
               "allocationTypeId":500014,
               "actionTypes":[
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":true
                  }
               ]
            },
            {
               "allocationTypeId":500016,
               "actionTypes":[
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":500003,
                     "actionType":"Multi-year Annual Report",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":true
                  }
               ]
            },
            {
               "allocationTypeId":500018,
               "actionTypes":[
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":500003,
                     "actionType":"Multi-year Annual Report",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":true
                  }
               ]
            },
            {
               "allocationTypeId":500020,
               "actionTypes":[
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":true
                  }
               ]
            },
            {
               "allocationTypeId":500013,
               "actionTypes":[
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":true
                  }
               ]
            }
         ]
      },
      {
         "documentTypeId":4,
         "documentType":"Prog_Report",
         "displayDocumentType":"Progress Report",
         "isActive":true,
         "allocationActionTypes":[
            {
               "allocationTypeId":500018,
               "actionTypes":[
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":3,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":3,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":3,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            },
            {
               "allocationTypeId":500019,
               "actionTypes":[
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":3,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            },
            {
               "allocationTypeId":500013,
               "actionTypes":[
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":3,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            },
            {
               "allocationTypeId":500016,
               "actionTypes":[
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":3,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":3,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            },
            {
               "allocationTypeId":500020,
               "actionTypes":[
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":3,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            },
            {
               "allocationTypeId":500014,
               "actionTypes":[
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":3,
                     "isRequired":false,
                     "allowMany":false
                  }
               ]
            }
         ]
      },
      {
         "documentTypeId":6,
         "documentType":"Special_Reqs",
         "displayDocumentType":"Special Requirements",
         "isActive":true,
         "allocationActionTypes":[
            {
               "allocationTypeId":500016,
               "actionTypes":[
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":500003,
                     "actionType":"Multi-year Annual Report",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":1,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":1,
                     "isRequired":false,
                     "allowMany":false
                  }
               ]
            },
            {
               "allocationTypeId":500018,
               "actionTypes":[
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":500003,
                     "actionType":"Multi-year Annual Report",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":1,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":1,
                     "isRequired":false,
                     "allowMany":false
                  }
               ]
            }
         ]
      },
      {
         "documentTypeId":7,
         "documentType":"Code_Perf_Scale",
         "displayDocumentType":"Code Perf \u0026 Scaling",
         "isActive":true,
         "allocationActionTypes":[
            {
               "allocationTypeId":500018,
               "actionTypes":[
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":5,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":500003,
                     "actionType":"Multi-year Annual Report",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":5,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":5,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            },
            {
               "allocationTypeId":500016,
               "actionTypes":[
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":500003,
                     "actionType":"Multi-year Annual Report",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":5,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":5,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            }
         ]
      },
      {
         "documentTypeId":8,
         "documentType":"Multiyr_Annl_Rpt",
         "displayDocumentType":"Multi-year Annual Report",
         "isActive":true,
         "allocationActionTypes":[
            {
               "allocationTypeId":500016,
               "actionTypes":[
                  {
                     "actionTypeId":500003,
                     "actionType":"Multi-year Annual Report",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            },
            {
               "allocationTypeId":500018,
               "actionTypes":[
                  {
                     "actionTypeId":500003,
                     "actionType":"Multi-year Annual Report",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            }
         ]
      },
      {
         "documentTypeId":9,
         "documentType":"References",
         "displayDocumentType":"References",
         "isActive":true,
         "allocationActionTypes":[
            {
               "allocationTypeId":500016,
               "actionTypes":[
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":500003,
                     "actionType":"Multi-year Annual Report",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  }
               ]
            },
            {
               "allocationTypeId":500018,
               "actionTypes":[
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":500003,
                     "actionType":"Multi-year Annual Report",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  }
               ]
            }
         ]
      },
      {
         "documentTypeId":10,
         "documentType":"Other",
         "displayDocumentType":"Other",
         "isActive":true,
         "allocationActionTypes":[
            {
               "allocationTypeId":500007,
               "actionTypes":[
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  }
               ]
            },
            {
               "allocationTypeId":500013,
               "actionTypes":[
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  }
               ]
            },
            {
               "allocationTypeId":500014,
               "actionTypes":[
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  }
               ]
            },
            {
               "allocationTypeId":500015,
               "actionTypes":[
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  }
               ]
            },
            {
               "allocationTypeId":500016,
               "actionTypes":[
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":500003,
                     "actionType":"Multi-year Annual Report",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  }
               ]
            },
            {
               "allocationTypeId":500017,
               "actionTypes":[
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  }
               ]
            },
            {
               "allocationTypeId":500018,
               "actionTypes":[
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":500003,
                     "actionType":"Multi-year Annual Report",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  }
               ]
            },
            {
               "allocationTypeId":500019,
               "actionTypes":[
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  }
               ]
            },
            {
               "allocationTypeId":500020,
               "actionTypes":[
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  },
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":true
                  }
               ]
            }
         ]
      },
      {
         "documentTypeId":11,
         "documentType":"NSF_Fellow",
         "displayDocumentType":"NSF Fellowship Award Letter",
         "isActive":true,
         "allocationActionTypes":[
            {
               "allocationTypeId":500013,
               "actionTypes":[
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            },
            {
               "allocationTypeId":500014,
               "actionTypes":[
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  }
               ]
            },
            {
               "allocationTypeId":500019,
               "actionTypes":[
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  }
               ]
            },
            {
               "allocationTypeId":500020,
               "actionTypes":[
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  }
               ]
            }
         ]
      },
      {
         "documentTypeId":12,
         "documentType":"Email_Confirmation",
         "displayDocumentType":"Email Confirmation",
         "isActive":true,
         "allocationActionTypes":[
            {
               "allocationTypeId":500019,
               "actionTypes":[
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  }
               ]
            }
         ]
      },
      {
         "documentTypeId":13,
         "documentType":"Resource_Just",
         "displayDocumentType":"Resource Justification",
         "isActive":true,
         "allocationActionTypes":[
            {
               "allocationTypeId":500014,
               "actionTypes":[
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            }
         ]
      },
      {
         "documentTypeId":14,
         "documentType":"Syllabus",
         "displayDocumentType":"Syllabus",
         "isActive":true,
         "allocationActionTypes":[
            {
               "allocationTypeId":500014,
               "actionTypes":[
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            }
         ]
      },
      {
         "documentTypeId":2,
         "documentType":"CV_PI",
         "displayDocumentType":"PI CV (2 pages limit)",
         "isActive":true,
         "allocationActionTypes":[
            {
               "allocationTypeId":500019,
               "actionTypes":[
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            },
            {
               "allocationTypeId":500014,
               "actionTypes":[
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            },
            {
               "allocationTypeId":500016,
               "actionTypes":[
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":500003,
                     "actionType":"Multi-year Annual Report",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            },
            {
               "allocationTypeId":500018,
               "actionTypes":[
                  {
                     "actionTypeId":5,
                     "actionType":"Appeal",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":500003,
                     "actionType":"Multi-year Annual Report",
                     "hardPageLimit":null,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            },
            {
               "allocationTypeId":500020,
               "actionTypes":[
                  {
                     "actionTypeId":4,
                     "actionType":"Supplement",
                     "hardPageLimit":null,
                     "isRequired":false,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            },
            {
               "allocationTypeId":500013,
               "actionTypes":[
                  {
                     "actionTypeId":2,
                     "actionType":"New",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":false
                  },
                  {
                     "actionTypeId":3,
                     "actionType":"Renewal",
                     "hardPageLimit":2,
                     "isRequired":true,
                     "allowMany":false
                  }
               ]
            }
         ]
      }
   ]
}

Returns

Code: 200

Description:

OK

Param name Description
documentTypeId
required

Validations:

  • Must be a Integer

documentType
required

Validations:

  • Must be a String

displayDocumentType
required

Validations:

  • Must be a String

isActive
required

Validations:

  • Must be one of: true, false.

allocationActionTypes
required

Validations:

  • Must be an Array of nested elements

allocationActionTypes[allocationTypeId]
required

Validations:

  • Must be a Integer

allocationActionTypes[actionTypes]
required

Validations:

  • Must be an Array of nested elements

allocationActionTypes[actionTypes][actionTypeId]
required

Validations:

  • Must be a Integer

allocationActionTypes[actionTypes][actionType]
required

Validations:

  • Must be a String

allocationActionTypes[actionTypes][hardPageLimit]
required

Validations:

  • Must be one of: Integer, nil.

allocationActionTypes[actionTypes][isRequired]
required

Validations:

  • Must be one of: true, false.

allocationActionTypes[actionTypes][allowMany]
required

Validations:

  • Must be one of: true, false.


GET //v1/types/actions
get a list of action types

Examples

get /v1/types/actions
{
   "message":null,
   "result":[
      {
         "actionTypeId":1,
         "actionType":"New",
         "displayActionType":"New"
      },
      {
         "actionTypeId":2,
         "actionType":"Renewal",
         "displayActionType":"Renewal"
      },
      {
         "actionTypeId":3,
         "actionType":"Justification",
         "displayActionType":"Justification"
      },
      {
         "actionTypeId":4,
         "actionType":"Transfer",
         "displayActionType":"Transfer"
      },
      {
         "actionTypeId":5,
         "actionType":"Extension",
         "displayActionType":"Extension"
      },
      {
         "actionTypeId":6,
         "actionType":"Advance",
         "displayActionType":"Advance"
      }
   ]
}

Returns

Code: 200

Description:

OK

Param name Description
actionTypeId
required

Validations:

  • Must be a Integer

actionType
required

Validations:

  • Must be a String

displayActionType
required

Validations:

  • Must be a String


GET //v1/types/roles
get a list of role types

Examples

get /v1/types/roles
{
   "message":null,
   "result":[
      {
         "roleTypeId":1,
         "roleType":"CoPI",
         "displayRoleType":"CoPI"
      },
      {
         "roleTypeId":2,
         "roleType":"PI",
         "displayRoleType":"PI"
      },
      {
         "roleTypeId":3,
         "roleType":"Allocation Manager",
         "displayRoleType":"Allocation Manager"
      },
      {
         "roleTypeId":4,
         "roleType":"Reviewer",
         "displayRoleType":"Reviewer"
      },
      {
          "roleTypeId":8,
          "roleType":"NSF Fellow",
          "displayRoleType":"NSF Fellow"
      },
      {
          "roleTypeId":9,
          "roleType":"User",
          "displayRoleType":"User"
      }
   ]
}

Returns

Code: 200

Description:

OK

Param name Description
roleTypeId
required

Validations:

  • Must be a Integer

roleType
required

Validations:

  • Must be a String

displayRoleType
required

Validations:

  • Must be a String


GET //v1/types/person_statuses
get a list of person status types

Examples

GET /v1/types/person_statuses
{
    "message": null,
    "result": [
        {
            "displayPersonStatusType": "Nonprofit User",
            "isActive": true,
            "personStatusType": "Nonprofit User",
            "personStatusTypeId": 3
        },
        {
            "displayPersonStatusType": "Faculty",
            "isActive": true,
            "personStatusType": "Faculty",
            "personStatusTypeId": 4
        },
        {
            "displayPersonStatusType": "Industrial User",
            "isActive": true,
            "personStatusType": "Industrial User",
            "personStatusTypeId": 6
        },
        {
            "displayPersonStatusType": "Staff",
            "isActive": true,
            "personStatusType": "Staff",
            "personStatusTypeId": 7
        },
        {
            "displayPersonStatusType": "Other User",
            "isActive": true,
            "personStatusType": "Other User",
            "personStatusTypeId": 8
        },
        {
            "displayPersonStatusType": "Unaffiliated User",
            "isActive": true,
            "personStatusType": "Unaffiliated User",
            "personStatusTypeId": 9
        },
        {
            "displayPersonStatusType": "Government User",
            "isActive": true,
            "personStatusType": "Government User",
            "personStatusTypeId": 10
        },
        {
            "displayPersonStatusType": "Unknown",
            "isActive": true,
            "personStatusType": "Unknown",
            "personStatusTypeId": 11
        },
        {
            "displayPersonStatusType": "High School Teacher",
            "isActive": true,
            "personStatusType": "High School Teacher",
            "personStatusTypeId": 12
        },
        {
            "displayPersonStatusType": "Postdoctorate",
            "isActive": true,
            "personStatusType": "Postdoctorate",
            "personStatusTypeId": 14
        },
        {
            "displayPersonStatusType": "High School Student",
            "isActive": true,
            "personStatusType": "High School Student",
            "personStatusTypeId": 16
        },
        {
            "displayPersonStatusType": "Undergraduate Student",
            "isActive": true,
            "personStatusType": "Undergraduate Student",
            "personStatusTypeId": 18
        },
        {
            "displayPersonStatusType": "Reporter",
            "isActive": true,
            "personStatusType": "Reporter",
            "personStatusTypeId": 19
        },
        {
            "displayPersonStatusType": "Graduate Student",
            "isActive": true,
            "personStatusType": "Graduate Student",
            "personStatusTypeId": 20
        },
        {
            "displayPersonStatusType": "Center Researcher Staff",
            "isActive": true,
            "personStatusType": "Center Researcher Staff",
            "personStatusTypeId": 1
        },
        {
            "displayPersonStatusType": "University Research Staff (excluding postdoctorates)",
            "isActive": true,
            "personStatusType": "University Research Staff (excluding postdoctorates)",
            "personStatusTypeId": 2
        },
        {
            "displayPersonStatusType": "Center Non-Researcher Staff",
            "isActive": true,
            "personStatusType": "Center Non-Researcher Staff",
            "personStatusTypeId": 15
        },
        {
            "displayPersonStatusType": "University Non-Research Staff",
            "isActive": true,
            "personStatusType": "University Non-Research Staff",
            "personStatusTypeId": 17
        }
    ]
}

Returns

Code: 200

Description:

OK

Param name Description
displayPersonStatusType
required

Validations:

  • Must be a String

isActive
required

Validations:

  • Must be one of: true, false.

personStatusType
required

Validations:

  • Must be a String

personStatusTypeId
required

Validations:

  • Must be a Integer


GET //v1/types/permissions
get a list of permission types

Examples

get /v1/types/permissions
{
   "message":null,
   "result":[
      {
         "permissionTypeId":1,
         "permissionType":"allocations_process_manager",
         "displayPermissionType":"Allocations Process Manager"
      },
      {
         "permissionTypeId":2,
         "permissionType":"service_provider",
         "displayPermissionType":"Service Provider"
      }
   ]
}

Returns

Code: 200

Description:

OK

Param name Description
permissionTypeId
required

Validations:

  • Must be a Integer

permissionType
required

Validations:

  • Must be a String

displayPermissionType
required

Validations:

  • Must be a String


GET //v1/types/requests
get a list of request types

Examples

GET /v1/types/requests
{
   "message":null,
   "result":[
      {
         "requestTypeId":1,
         "requestType":"New",
         "displayRequestType":"New"
      },
      {
         "requestTypeId":2,
         "requestType":"Renewal",
         "displayRequestType":"Renewal"
      },
      {
         "requestTypeId":3,
         "requestType":"Justification",
         "displayRequestType":"Justification"
      },
      {
         "requestTypeId":4,
         "requestType":"Extension",
         "displayRequestType":"Extension"
      }
   ]
}

Returns

Code: 200

Description:

OK

Param name Description
requestTypeId
required

Validations:

  • Must be a Integer

requestType
required

Validations:

  • Must be a String

displayRequestType
required

Validations:

  • Must be a String


GET //v1/types/request_status
get a list of request status types

Examples

GET /v1/types/request_status
{
   "message":null,
   "result":[
      {
         "requestStatusTypeId":1,
         "requestStatusType":"Complete",
         "displayRequestStatusType":"Complete"
      },
      {
         "requestStatusTypeId":2,
         "requestStatusType":"Incomplete",
         "displayRequestStatusType":"Incomplete"
      },
      {
         "requestStatusTypeId":3,
         "requestStatusType":"Submitted",
         "displayRequestStatusType":"Submitted"
      },
      {
         "requestStatusTypeId":4,
         "requestStatusType":"Under Review",
         "displayRequestStatusType":"Under Review"
      },
      {
         "requestStatusTypeId":5,
         "requestStatusType":"Pending",
         "displayRequestStatusType":"Pending"
      },
      {
         "requestStatusTypeId":6,
         "requestStatusType":"Awarded",
         "displayRequestStatusType":"Awarded"
      },
      {
         "requestStatusTypeId":7,
         "requestStatusType":"Rejected",
         "displayRequestStatusType":"Rejected"
      }
   ]
}

Returns

Code: 200

Description:

OK

Param name Description
requestStatusTypeId
required

Validations:

  • Must be a Integer

requestStatusType
required

Validations:

  • Must be a String

displayRequestStatusType
required

Validations:

  • Must be a String


GET //v1/types/units
get a list of unit types

Examples

GET /v1/types/units
{
   "message":null,
   "result":[
      {
         "unitTypeId":1,
         "unitType":"Dollars",
         "displayUnitType":"Dollars"
      },
      {
         "unitTypeId":2,
         "unitType":"SUs",
         "displayUnitType":"Service Units"
      },
      {
         "unitTypeId":4,
         "unitType":"FTE",
         "displayUnitType":"FTE"
      },
      {
         "unitTypeId":5,
         "unitType":"GigaBytes",
         "displayUnitType":"GigaBytes"
      }
   ]
}

Returns

Code: 200

Description:

OK

Param name Description
unitTypeId
required

Validations:

  • Must be a Integer

unitType
required

Validations:

  • Must be a String

displayUnitType
required

Validations:

  • Must be a String


POST //v1/types/units

Params

Param name Description
unit_type
required

Validations:

  • Must be a String

unit_display_type
required

Validations:

  • Must be a String

Returns

Code: 400

Description:

unit_type not specified AND/OR unit_display_type not specified

Param name Description

Code: 200

Description:

OK

Param name Description
unitTypeId
required

Validations:

  • Must be a Integer

unitType
required

Validations:

  • Must be a String

displayUnitType
required

Validations:

  • Must be a String


GET //v1/types/attribute_sets
get a list of attribute set types

Examples

GET /v1/types/attribute_sets
{
   "message":null,
   "result":[
      {
         "attributeSetTypeId":1,
         "attributeSetType":"numeric_range",
         "displayAttributeSetType":"Numeric Range"
      },
      {
         "attributeSetTypeId":2,
         "attributeSetType":"yes_no",
         "displayAttributeSetType":"Yes/No"
      },
      {
         "attributeSetTypeId":3,
         "attributeSetType":"simpleString",
         "displayAttributeSetType":"Simple String"
      },
      {
         "attributeSetTypeId":4,
         "attributeSetType":"multipleStrings",
         "displayAttributeSetType":"Multiple Strings"
      }
   ]
}

Returns

Code: 200

Description:

OK

Param name Description
attributeSetTypeId
required

Validations:

  • Must be a Integer

attributeSetType
required

Validations:

  • Must be a String

displayAttributeSetType
required

Validations:

  • Must be a String


GET //v1/types/attribute_set_relations
get a list of attribute set relation types

Examples

GET /v1/types/attribute_set_relations
{
   "message":null,
   "result":[
      {
         "attributeSetRelationTypeId":1,
         "attributeSetRelationType":"singleSel",
         "displayAttributeSetRelationType":"Single Select"
      },
      {
         "attributeSetRelationTypeId":2,
         "attributeSetRelationType":"multiSel",
         "displayAttributeSetRelationType":"Multiple Select"
      },
      {
         "attributeSetRelationTypeId":3,
         "attributeSetRelationType":"text",
         "displayAttributeSetRelationType":"Text Field"
      },
      {
         "attributeSetRelationTypeId":4,
         "attributeSetRelationType":"textarea",
         "displayAttributeSetRelationType":"Text Area Field"
      }
   ]
}

Returns

Code: 200

Description:

OK

Param name Description
attributeSetRelationTypeId
required

Validations:

  • Must be a Integer

attributeSetRelationType
required

Validations:

  • Must be a String

displayAttributeSetRelationType
required

Validations:

  • Must be a String


GET //v1/types/allocation_dates
get a list of allocation date types

Examples

GET /v1/types/allocation_dates
{
   "message":null,
   "result":[
      {
         "allocationDateTypeId":1,
         "allocationDateType":"Submitted",
         "displayAllocationDateType":"Submitted"
      },
      {
         "allocationDateTypeId":2,
         "allocationDateType":"Suggested",
         "displayAllocationDateType":"Suggested"
      },
      {
         "allocationDateTypeId":3,
         "allocationDateType":"Awarded",
         "displayAllocationDateType":"Awarded"
      }
   ]
}

Returns

Code: 200

Description:

OK

Param name Description
allocationDateTypeId
required

Validations:

  • Must be a Integer

allocationDateType
required

Validations:

  • Must be a String

displayAllocationDateType
required

Validations:

  • Must be a String


GET //v1/types/resource_numbers
get a list of resource number types

Examples

GET /v1/types/resource_numbers
{
   "message":null,
   "result":[
      {
         "resourceNumberTypeId":1,
         "resourceNumberType":"Available Service Units",
         "displayResourceNumberType":"Available Service Units"
      },
      {
         "resourceNumberTypeId":2,
         "resourceNumberType":"Default Amount",
         "displayResourceNumberType":"Default Amount"
      },
      {
         "resourceNumberTypeId":3,
         "resourceNumberType":"Maximum Amount",
         "displayResourceNumberType":"Maximum Amount"
      },
      {
         "resourceNumberTypeId":4,
         "resourceNumberType":"Minimum Amount",
         "displayResourceNumberType":"Minimum Amount"
      }
   ]
}

Returns

Code: 200

Description:

OK

Param name Description
resourceNumberTypeId
required

Validations:

  • Must be a Integer

resourceNumberType
required

Validations:

  • Must be a String

displayResourceNumberType
required

Validations:

  • Must be a String


GET //v1/types/resources
get a list of resource types

Examples

GET /v1/types/resources
{
   "message":null,
   "result":[
      {
         "resourceTypeId":1,
         "resourceType":"Compute",
         "displayResourceType":"Compute",
         "description":"Compute Resource"
      },
      {
         "resourceTypeId":2,
         "resourceType":"Storage",
         "displayResourceType":"Storage",
         "description":"Storage Resource"
      },
      {
         "resourceTypeId":3,
         "resourceType":"Program",
         "displayResourceType":"Program",
         "description":"Advanced Support Program Allocations"
      }
   ]
}

Returns

Code: 200

Description:

OK

Param name Description
resourceTypeId
required

Validations:

  • Must be a Integer

resourceType
required

Validations:

  • Must be a String

displayResourceType
required

Validations:

  • Must be a String

description
required

Validations:

  • Must be a String


GET //v1/types/opportunity_states
get a list of opportunity state types

Examples

GET /v1/types/opportunity_states
{
   "message":null,
   "result":[
      {
         "opportunityStateTypeId":1,
         "opportunityStateType":"Override On",
         "displayOpportunityStateType":"Override On"
      },
      {
         "opportunityStateTypeId":2,
         "opportunityStateType":"Review Assignments Visible",
         "displayOpportunityStateType":"Review Assignments Visible"
      },
      {
         "opportunityStateTypeId":3,
         "opportunityStateType":"Reviews Viewable",
         "displayOpportunityStateType":"Reviews Viewable"
      },
      {
         "opportunityStateTypeId":4,
         "opportunityStateType":"Ready",
         "displayOpportunityStateType":"Ready"
      },
      {
         "opportunityStateTypeId":5,
         "opportunityStateType":"Upcoming",
         "displayOpportunityStateType":"Upcoming"
      }
   ]
}

Returns

Code: 200

Description:

OK

Param name Description
opportunityStateTypeId
required

Validations:

  • Must be a Integer

opportunityStateType
required

Validations:

  • Must be a String

displayOpportunityStateType
required

Validations:

  • Must be a String


GET //v1/types/all
get a JSON of all types

Examples

get /v1/types/actions
{
    "message": null,
    "result": {
        "fosTypes": [...
        ],
        "documentTypes": [...
        ],
        "actionTypes": [...
        ],
        "roleTypes": [...
        ],
        "personStatusTypes": [...
        ],
        "permissionTypes": [...
        ],
        "requestTypes":[...
        ],
        "requestStatusTypes": [...
        ],
        "unitTypes": [...
        ],
        "attributeSetTypes": [...
        ],
        "attributeSetRelationTypes": [...
        ],
        "allocationDateTypes": [...
        ],
        "resourceNumberTypes": [...
        ],
        "resourceTypes":[...
        ],
        "opportunityStateTypes":[...
        ],
    }
}

Returns

Code: 200

Description:

OK

Param name Description
fosTypes
required

Validations:

  • Must be an Array of nested elements

fosTypes[fosTypeId]
required

Validations:

  • Must be a Integer

fosTypes[fosName]
required

Validations:

  • Must be a String

fosTypes[fosAbbr]
required

Validations:

  • Must be a String

fosTypes[fosNum]
required

Validations:

  • Must be a Integer

fosTypes[fosTypeParentId]
required

Validations:

  • Must be one of: Integer, nil.

fosTypes[isActive]
required

Validations:

  • Must be one of: true, false.

documentTypes
required

Validations:

  • Must be an Array of nested elements

documentTypes[documentTypeId]
required

Validations:

  • Must be a Integer

documentTypes[documentType]
required

Validations:

  • Must be a String

documentTypes[displayDocumentType]
required

Validations:

  • Must be a String

documentTypes[isActive]
required

Validations:

  • Must be one of: true, false.

documentTypes[allocationActionTypes]
required

Validations:

  • Must be an Array of nested elements

documentTypes[allocationActionTypes][allocationTypeId]
required

Validations:

  • Must be a Integer

documentTypes[allocationActionTypes][actionTypes]
required

Validations:

  • Must be an Array of nested elements

documentTypes[allocationActionTypes][actionTypes][actionTypeId]
required

Validations:

  • Must be a Integer

documentTypes[allocationActionTypes][actionTypes][actionType]
required

Validations:

  • Must be a String

documentTypes[allocationActionTypes][actionTypes][hardPageLimit]
required

Validations:

  • Must be one of: Integer, nil.

documentTypes[allocationActionTypes][actionTypes][isRequired]
required

Validations:

  • Must be one of: true, false.

documentTypes[allocationActionTypes][actionTypes][allowMany]
required

Validations:

  • Must be one of: true, false.

actionTypes
required

Validations:

  • Must be an Array of nested elements

actionTypes[actionTypeId]
required

Validations:

  • Must be a Integer

actionTypes[actionType]
required

Validations:

  • Must be a String

actionTypes[displayActionType]
required

Validations:

  • Must be a String

roleTypes
required

Validations:

  • Must be an Array of nested elements

roleTypes[roleTypeId]
required

Validations:

  • Must be a Integer

roleTypes[roleType]
required

Validations:

  • Must be a String

roleTypes[displayRoleType]
required

Validations:

  • Must be a String

personStatusTypes
required

Validations:

  • Must be an Array of nested elements

personStatusTypes[displayPersonStatusType]
required

Validations:

  • Must be a String

personStatusTypes[isActive]
required

Validations:

  • Must be one of: true, false.

personStatusTypes[personStatusType]
required

Validations:

  • Must be a String

personStatusTypes[personStatusTypeId]
required

Validations:

  • Must be a Integer

permissionTypes
required

Validations:

  • Must be an Array of nested elements

permissionTypes[permissionTypeId]
required

Validations:

  • Must be a Integer

permissionTypes[permissionType]
required

Validations:

  • Must be a String

permissionTypes[displayPermissionType]
required

Validations:

  • Must be a String

requestTypes
required

Validations:

  • Must be an Array of nested elements

requestTypes[requestTypeId]
required

Validations:

  • Must be a Integer

requestTypes[requestType]
required

Validations:

  • Must be a String

requestTypes[displayRequestType]
required

Validations:

  • Must be a String

requestStatusTypes
required

Validations:

  • Must be an Array of nested elements

requestStatusTypes[requestStatusTypeId]
required

Validations:

  • Must be a Integer

requestStatusTypes[requestStatusType]
required

Validations:

  • Must be a String

requestStatusTypes[displayRequestStatusType]
required

Validations:

  • Must be a String

unitTypes
required

Validations:

  • Must be an Array of nested elements

unitTypes[unitTypeId]
required

Validations:

  • Must be a Integer

unitTypes[unitType]
required

Validations:

  • Must be a String

unitTypes[displayUnitType]
required

Validations:

  • Must be a String

attributeSetTypes
required

Validations:

  • Must be an Array of nested elements

attributeSetTypes[attributeSetTypeId]
required

Validations:

  • Must be a Integer

attributeSetTypes[attributeSetType]
required

Validations:

  • Must be a String

attributeSetTypes[displayAttributeSetType]
required

Validations:

  • Must be a String

attributeSetRelationTypes
required

Validations:

  • Must be an Array of nested elements

attributeSetRelationTypes[attributeSetRelationTypeId]
required

Validations:

  • Must be a Integer

attributeSetRelationTypes[attributeSetRelationType]
required

Validations:

  • Must be a String

attributeSetRelationTypes[displayAttributeSetRelationType]
required

Validations:

  • Must be a String

allocationDateTypes
required

Validations:

  • Must be an Array of nested elements

allocationDateTypes[allocationDateTypeId]
required

Validations:

  • Must be a Integer

allocationDateTypes[allocationDateType]
required

Validations:

  • Must be a String

allocationDateTypes[displayAllocationDateType]
required

Validations:

  • Must be a String

resourceNumberTypes
required

Validations:

  • Must be an Array of nested elements

resourceNumberTypes[resourceNumberTypeId]
required

Validations:

  • Must be a Integer

resourceNumberTypes[resourceNumberType]
required

Validations:

  • Must be a String

resourceNumberTypes[displayResourceNumberType]
required

Validations:

  • Must be a String

resourceTypes
required

Validations:

  • Must be an Array of nested elements

resourceTypes[resourceTypeId]
required

Validations:

  • Must be a Integer

resourceTypes[resourceType]
required

Validations:

  • Must be a String

resourceTypes[displayResourceType]
required

Validations:

  • Must be a String

resourceTypes[description]
required

Validations:

  • Must be a String

opportunityStateTypes
required

Validations:

  • Must be an Array of nested elements

opportunityStateTypes[opportunityStateTypeId]
required

Validations:

  • Must be a Integer

opportunityStateTypes[opportunityStateType]
required

Validations:

  • Must be a String

opportunityStateTypes[displayOpportunityStateType]
required

Validations:

  • Must be a String