GET //v1/opportunities
get submission opportunities

Also see GET /v1/opportunities/<opportunityId>.

Examples

GET /v1/opportunities
{
   "message":null,
   "result":[ <opportunity> ]
}

Returns

Code: 200

Description:

OK

Param name Description
opportunityId
required

Validations:

  • Must be a Integer
opportunityName
required

Validations:

  • Must be a String
displayOpportunityName
required

Validations:

  • Must be a String
opportunityType
required

Validations:

  • Must be a String
announcementDate
required

Validations:

  • Must be a String
submissionBeginDate
required

Validations:

  • Must be a DateTime
submissionEndDate
required

Validations:

  • Must be one of: DateTime, nil.
submissionURL
required

Validations:

  • Must be one of: String, nil.
submissionNotes
required

Validations:

  • Must be a String
defaultAllocationAwardPeriod
required

Validations:

  • Must be one of: Integer, nil.
adminComments
required

Validations:

  • Must be a String
resources
required

Validations:

  • Must be a Hash
resources[resourceId]
required

Validations:

  • Must be a Integer
resources[resourceName]
required

Validations:

  • Must be a String
resources[displayResourceName]
required

Validations:

  • Must be a String
resources[resourceType]
required

Validations:

  • Must be a String
resources[resourceActualType]
required

Validations:

  • Must be a String
resources[resourceUnits]
required

Validations:

  • Must be a String
resources[resourceUnitType]
required

Validations:

  • Must be a String
resources[resourceState]
required

Validations:

  • Must be a String
resources[siteProviderComments]
required

Validations:

  • Must be a String
resources[relativeOrder]
required

Validations:

  • Must be a Integer
resources[requiredResources]
required

Validations:

  • Must be a Hash
resources[requiredResources][resourceId]
required

Validations:

  • Must be a Integer
resources[requiredResources][resourceName]
required

Validations:

  • Must be a String
resources[requiredResources][displayResourceName]
required

Validations:

  • Must be a String
resources[requiredResources][beginDate]
required

Validations:

  • Must be a DateTime
resources[requiredResources][endDate]
required

Validations:

  • Must be a DateTime
resources[numbers]
required

Validations:

  • Must be a Hash
resources[numbers][source]
required

Validations:

  • Must be one of: opportunity, allocationType.
resources[numbers][amount]
required

Validations:

  • Must be a Integer
resources[numbers][beginDate]
required

Validations:

  • Must be a DateTime
resources[numbers][endDate]
required

Validations:

  • Must be a DateTime
resources[numbers][resourceNumberTypeId]
required

Validations:

  • Must be a Integer
resources[numbers][resourceNumberType]
required

Validations:

  • Must be a String
resources[numbers][displayResourceNumberType]
required

Validations:

  • Must be a String
resources[allocationType]
required

Validations:

  • Must be a String
resources[allocationTypeInfo]
required

Validations:

  • Must be a Hash
resources[allocationTypeId]
required

Validations:

  • Must be a Integer
resources[description]
required

Validations:

  • Must be a String
resources[numSubmissions]
required

Validations:

  • Must be one of: Integer, nil.
resources[isActive]
required

Validations:

  • Must be one of: true, false.
panels
required

Validations:

  • Must be a Hash
panels[panelId]
required

Validations:

  • Must be a Integer
panels[isPrimary]
required

Validations:

  • Must be one of: true, false.
opportunityStates
required

Validations:

  • Must be an array of String
attributeSets
required

Validations:

  • Must be a Hash
attributeSets[resourceAttributeId]
required

Validations:

  • Must be a Integer
attributeSets[attributeValue]
required

Validations:

  • Must be one of: String, nil.
terminatingOpportunity
required

Validations:

  • Must be a Hash
terminatingOpportunity[awardDate]
required

Validations:

  • Must be one of: DateTime, nil.
terminatingOpportunity[reviewDate]
required

Validations:

  • Must be one of: DateTime, nil.
terminatingOpportunity[gracePeriod]
required

Validations:

  • Must be one of: Integer, nil.
terminatingOpportunity[reviewsDueByDate]
required

Validations:

  • Must be one of: DateTime, nil.
rules
required

Validations:

  • Must be a Hash
rules[opportunityId]
required

Validations:

  • Must be a Integer
rules[canSubmitNewRequest]
required

Validations:

  • Must be one of: true, false.
rules[noAvailableActionsReason]
required

Validations:

  • Must be an array of String
rules[resourceIdsAvailableForNewRequest]
required

Validations:

  • Must be an array of String
rules[gracePeriod]
required

Validations:

  • Must be a Integer