special-use-POST-data-schema.json

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Special use application",
    "description": "A rough sketch of the POST JSON HTTP request for a special use permit from the U.S. Forest Service ePermitting system",
    "definitions": {
      "applicant-info": {
        "type": "object",
        "properties": {
      		"firstName": { "type": "string"},
      		"lastName": {	"type": "string" },
          "dayPhone": { "$ref": "#/definitions/phone-number" },
          "eveningPhone": { "$ref": "#/definitions/phone-number" },
          "emailAddress": { "type": "string"},
          "mailingAddress": { "type": "string"},
          "mailingAddress2": { "type": "string"},
          "mailingCity": { "type": "string"},
          "mailingState": { "type": "string"},
          "mailingZIP": { "type": "integer"},
      		"organizationName": {
      			"description": "The name of the group, company, organization or event applying",
      			"type": "integer",
      		},
          "website": { "type": "string", "stored-in-middle-layer": true },
          "orgType": { "type": { "enum": [ "Association","Corporation","Education","Federal Government","State Government","Local Govt","Married Common Property","Limited Liability Company (LLC)","Limited Liability Corporation (LLP)","Trust" ] }},
        "required": ["firstName","lastName","dayPhone","emailAddress","mailingAddress","mailingCity","mailingZIP","mailingState"]
      },
      "phoneNumber": {
        "type": "object",
        "properties": {
          "areaCode": { "type": "integer"},
          "number": { "type": "integer"},
          "extension": { "type": "integer"},
          "phoneType": { "basic-api-field" : "PHONE_NUMBER_TYPE", "note" : "We should limit responses to a few options."},
        },
        "required": ["areaCode","number","type"]
      },
      "non-commercial-fields": {
        "type": "object",
        "properties": {
      		"activityDescription": { "type": "string"},
      		"locationDescription": {	"type": "string"},
          "startDateTime": { "type": "dateTime"},
          "endDateTime": { "type": "dateTime" },
          "numberParticipants" : { "type": "integer" },
          "numberSpectators" : { "type": "integer" },
          },
      },
      "temp-outfitter-fields": {
        "type": "object",
        "properties": {
          "individualIsCitizen" : { "type" : "boolean", "note" : "Required if contactType is individual."},
          "smallBusiness" : { "type" : "boolean", "note" : "Required if contactType is not individual."},
          "activityDescription": { "type": "string"},
          "advertisingURL": { "type": "URL", "note" : "Either advertisingURL or advertisingDescription must be complete."},
          "advertisingDescription": { "type": "string", "note" : "Either advertisingURL or advertisingDescription must be complete."},
          "clientCharges": { "type": "string"},
          "experienceList": { "type": "string"},
          "guideDocumentation": {
            "type": "file",
            "note": "Stored in the middle layer.",
          },
          "acknowledgementOfRiskForm": {
            "type": "file",
            "note": "Stored in the middle layer.",
          },
      		"insuranceCertificate": {
            "type": "file",
            "note": "Stored in the middle layer.",
          },
          "goodStandingEvidence": {
      			"description": "Required for all non-individual contact types. Certificate of good standing, operating agreement, or other evidence the business is in good standing",
            "note": "Stored in the middle layer.",
            "type": "file"
          },
          "operatingPlan": {
      			"description": "A completed Word or RTF operating plan template.",
            "note": "Stored in the middle layer.",
            "type": "file"
          },
         "required": ["activityDescription","clientCharges","insuranceCertificate","goodStandingEvidence","operatingPlan"]
      },
    },
    "type": "object",
    "properties": {
      "region": { "type" : "string" },
      "forest": { "type" : "string" },
      "district": { "type" : "string" },
      "authorizingOfficerName": { "type" : "string"},
      "authorizingOfficerTitle": { "type" : "string"},
      "applicant-info" : {
        "oneOf" : [
          { "$ref": "#/definitions/applicant-info" },
          { "contact-id": { "type" : "integer" } }
        ]
      },
      "type" : { "enum" : ["non-commercial","tempOutfitters"], "note" : "See the FORM_NAME fields in the blocks specific to each permit type"},
      "type-specific-fields": {
        "oneOf": [
          { "$ref": "#/definitions/non-commercial-fields" },
          { "$ref": "#/definitions/temp-outfitter-fields" },
        ]
    },
    "required" : ["region","forest","district","authorizingOfficerName","authorizingOfficerTitle","applicant-info","type","type-specific-fields"],
}