GET /v1/requests/request/<requestNumber>
Get a request.

Examples

GET /v1/requests/request/<requestNumber>
GET /v1/requests/role/pi/<username>
GET /v1/requests/role/co_pi/<username>
GET /v1/requests/role/allocation_manager/<username>
GET /v1/requests/user/<username>

PARAMS: accounts (optional), other (optional)

{
    "message": null
    "result":
        {
             "projectIdLabel": <label>   -- eg, GrantNumber
             "masters": 
             [
              {
               "requestNumber": <requestNumber>
               "requests": 
               [
                {
                 "requestType":      <type>
                 "requestBeginDate": <date>
                 "requestEndDate":   <date>
                 "allocationType":   <type>
                 "projectTitle":     <title>
                 "projectId":        <id>    -- eg, STA000011S
                 "xrasActionIds":   [ <action_id> ]
                 "fos": 
                 [
                  { 
                   "xrasFosTypeId": <fos_type_id>
                   "isPrimary":     true|false
                  }
                 ]
                 "allocations": 
                 [
                  { 
                   "actionType":            <type>
                   "allocationBeginDate":   <date>
                   "allocationEndDate":     <date>
                   "allocatedAmount":       <amount>
                   "remainingAmount":       <amount>
                   "resourceRepositoryKey": <resource-repository-key>
                   "projectStates": 
                   [
                    {
                      "date":  <datetime>
                      "state": <state>      -- Active|Inactive
                    }
                   ]
                   "allocationOther":            -- if other param is specified
                   {
                     "allocationId":
                     "accountId":
                     "requestId":
                     "resourceId":
                     "resourceName":              <xsede-resource-name>
                     "chargeNumber":
                     "grantNumber":
                     "proposalNumber":
                     "siteResources":
                     [
                      { 
                        "resourceId":
                        "resourceName":            <xsede-resource-name>
                        "resourceIsActive":        true|false
                        "projectOnResourceState":
                      }
                     ]
                   }
                   "xrasActionId":          <action_id>
                   "xrasActionResourceId":  <action_resource_id>
                   "actions":
                   [
                    {
                     "orderApplied":         <sequenceNumber>   -- 1,2,3...
                     "actionType":           <type>             -- Adjustment|Advance|Extension|New|Renewal|Supplemental|Transfer
                     "amount":               <amount>
                     "endDate":              <date>
                     "dateApplied":          <datetime>
                     "xrasActionId":         <action_id>
                     "xrasActionResourceId": <action_resource_id>
                    }
                   ]
                   "accounts":                                 -- if accounts param is specified
                   [          
                    {
                     "usernames":        [ <username> ]
                     "firstName":        <firstName>
                     "middleName":       <middleName>
                     "lastName":         <lastName>
                     "roles":            [ <type> ]         -- AllocationManager|CoPI|PI
                     "usage":            <amount>
                     "accountStates":
                     [
                      {
                        "date":  <datetime>
                        "state": <state>  -- Active|Inactive
                      }
                     ]
                     "accountOther":                        -- if other param is specified
                         {
                           "personId":
                           "siteResources":
                           [
                            {
                              "resourceId":
                              "resourceName":            <xsede-resource-name>
                              "resourceIsActive":        true|false
                              "accountOnResourceState":
                            }
                           ]
                         }
                    }
                   ]
                  }
                 ]
                }
               ]
              }
             ]
        }
}

NOTE: the GET routes for requests with a username that does not exist will return 404 Not Found:
GET v1/requests/user/bozo
404 Not Found
{
    "message": "username=bozo not found",
    "result": null
}


NOTE: if there are no projects for any of the routes, then the masters will be an empty array (and the return code will be 200)
GET v1/requests/pi/mshapiro
200 OK
{
    "message": null,
    "result": {
        "projectIdLabel": "GrantNumber",
        "masters": [
        ]
    }
}

The projectIdLabel is always present, even if the masters array is empty.

Params

Param name	Description
requestNumber required	Request ID Validations: Must be a Integer

Returns

Code: 200

Description:

Success.

Param name	Description