API Documentation

< Back

Kuali Research REST APIs - Awards

Research Awards ¶

Awards ¶

Get Awards by Key
GET`/award/api/v1/awards/(key)`

Example URI

GET /award/api/v1/awards/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "sponsorCode": "(val)",
  "statusCode": "(val)",
  "templateCode": "(val)",
  "accountNumber": "(val)",
  "approvedEquipmentIndicator": "(val)",
  "approvedForeignTripIndicator": "(val)",
  "subContractIndicator": "(val)",
  "awardEffectiveDate": "(val)",
  "awardExecutionDate": "(val)",
  "beginDate": "(val)",
  "costSharingIndicator": "(val)",
  "indirectCostIndicator": "(val)",
  "modificationNumber": "(val)",
  "nsfSequenceNumber": "(val)",
  "paymentScheduleIndicator": "(val)",
  "scienceCodeIndicator": "(val)",
  "specialReviewIndicator": "(val)",
  "sponsorAwardNumber": "(val)",
  "transferSponsorIndicator": "(val)",
  "accountTypeCode": "(val)",
  "activityTypeCode": "(val)",
  "awardTypeCode": "(val)",
  "primeSponsorCode": "(val)",
  "awardId": "(val)",
  "basisOfPaymentCode": "(val)",
  "documentFundingId": "(val)",
  "methodOfPaymentCode": "(val)",
  "preAwardAuthorizedAmount": "(val)",
  "preAwardEffectiveDate": "(val)",
  "preAwardInstitutionalAuthorizedAmount": "(val)",
  "preAwardInstitutionalEffectiveDate": "(val)",
  "procurementPriorityCode": "(val)",
  "proposalNumber": "(val)",
  "specialEbRateOffCampus": "(val)",
  "specialEbRateOnCampus": "(val)",
  "subPlanFlag": "(val)",
  "title": "(val)",
  "archiveLocation": "(val)",
  "closeoutDate": "(val)",
  "awardTransactionTypeCode": "(val)",
  "noticeDate": "(val)",
  "unitNumber": "(val)",
  "financialAccountDocumentNumber": "(val)",
  "financialAccountCreationDate": "(val)",
  "financialChartOfAccountsCode": "(val)",
  "syncChild": "(val)",
  "awardSequenceStatus": "(val)",
  "fainId": "(val)",
  "fedAwardYear": "(val)",
  "fedAwardDate": "(val)",
  "awardDocument.documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Awards
GET`/award/api/v1/awards/`

Example URI

GET /award/api/v1/awards/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "sponsorCode": "(val)",
    "statusCode": "(val)",
    "templateCode": "(val)",
    "accountNumber": "(val)",
    "approvedEquipmentIndicator": "(val)",
    "approvedForeignTripIndicator": "(val)",
    "subContractIndicator": "(val)",
    "awardEffectiveDate": "(val)",
    "awardExecutionDate": "(val)",
    "beginDate": "(val)",
    "costSharingIndicator": "(val)",
    "indirectCostIndicator": "(val)",
    "modificationNumber": "(val)",
    "nsfSequenceNumber": "(val)",
    "paymentScheduleIndicator": "(val)",
    "scienceCodeIndicator": "(val)",
    "specialReviewIndicator": "(val)",
    "sponsorAwardNumber": "(val)",
    "transferSponsorIndicator": "(val)",
    "accountTypeCode": "(val)",
    "activityTypeCode": "(val)",
    "awardTypeCode": "(val)",
    "primeSponsorCode": "(val)",
    "awardId": "(val)",
    "basisOfPaymentCode": "(val)",
    "documentFundingId": "(val)",
    "methodOfPaymentCode": "(val)",
    "preAwardAuthorizedAmount": "(val)",
    "preAwardEffectiveDate": "(val)",
    "preAwardInstitutionalAuthorizedAmount": "(val)",
    "preAwardInstitutionalEffectiveDate": "(val)",
    "procurementPriorityCode": "(val)",
    "proposalNumber": "(val)",
    "specialEbRateOffCampus": "(val)",
    "specialEbRateOnCampus": "(val)",
    "subPlanFlag": "(val)",
    "title": "(val)",
    "archiveLocation": "(val)",
    "closeoutDate": "(val)",
    "awardTransactionTypeCode": "(val)",
    "noticeDate": "(val)",
    "unitNumber": "(val)",
    "financialAccountDocumentNumber": "(val)",
    "financialAccountCreationDate": "(val)",
    "financialChartOfAccountsCode": "(val)",
    "syncChild": "(val)",
    "awardSequenceStatus": "(val)",
    "fainId": "(val)",
    "fedAwardYear": "(val)",
    "fedAwardDate": "(val)",
    "awardDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "sponsorCode": "(val)",
    "statusCode": "(val)",
    "templateCode": "(val)",
    "accountNumber": "(val)",
    "approvedEquipmentIndicator": "(val)",
    "approvedForeignTripIndicator": "(val)",
    "subContractIndicator": "(val)",
    "awardEffectiveDate": "(val)",
    "awardExecutionDate": "(val)",
    "beginDate": "(val)",
    "costSharingIndicator": "(val)",
    "indirectCostIndicator": "(val)",
    "modificationNumber": "(val)",
    "nsfSequenceNumber": "(val)",
    "paymentScheduleIndicator": "(val)",
    "scienceCodeIndicator": "(val)",
    "specialReviewIndicator": "(val)",
    "sponsorAwardNumber": "(val)",
    "transferSponsorIndicator": "(val)",
    "accountTypeCode": "(val)",
    "activityTypeCode": "(val)",
    "awardTypeCode": "(val)",
    "primeSponsorCode": "(val)",
    "awardId": "(val)",
    "basisOfPaymentCode": "(val)",
    "documentFundingId": "(val)",
    "methodOfPaymentCode": "(val)",
    "preAwardAuthorizedAmount": "(val)",
    "preAwardEffectiveDate": "(val)",
    "preAwardInstitutionalAuthorizedAmount": "(val)",
    "preAwardInstitutionalEffectiveDate": "(val)",
    "procurementPriorityCode": "(val)",
    "proposalNumber": "(val)",
    "specialEbRateOffCampus": "(val)",
    "specialEbRateOnCampus": "(val)",
    "subPlanFlag": "(val)",
    "title": "(val)",
    "archiveLocation": "(val)",
    "closeoutDate": "(val)",
    "awardTransactionTypeCode": "(val)",
    "noticeDate": "(val)",
    "unitNumber": "(val)",
    "financialAccountDocumentNumber": "(val)",
    "financialAccountCreationDate": "(val)",
    "financialChartOfAccountsCode": "(val)",
    "syncChild": "(val)",
    "awardSequenceStatus": "(val)",
    "fainId": "(val)",
    "fedAwardYear": "(val)",
    "fedAwardDate": "(val)",
    "awardDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Awards with Filtering
GET`/award/api/v1/awards/`

Example URI

GET /award/api/v1/awards/

URI Parameters

HideShow

awardNumber: string (optional)
Award ID. Maximum length is 12.
sequenceNumber: string (optional)
Sequence Number. Maximum length is 4.
sponsorCode: string (optional)
The identification number of the organization or agency that is providing support for the sponsored project. Maximum length is 20.
statusCode: string (optional)
Award Status. Maximum length is 3.
templateCode: string (optional)
Pre-defined Sponsor Template to sync. Maximum length is 6.
accountNumber: string (optional)
Account ID. Maximum length is 25.
approvedEquipmentIndicator: string (optional)
approvedForeignTripIndicator: string (optional)
subContractIndicator: string (optional)
awardEffectiveDate: string (optional)
Project Start Date. Maximum length is 10.
awardExecutionDate: string (optional)
The Execution Date of the Budget. Maximum length is 10.
beginDate: string (optional)
Modification Date. Maximum length is 10.
costSharingIndicator: string (optional)
indirectCostIndicator: string (optional)
modificationNumber: string (optional)
Modification ID. Maximum length is 50.
nsfSequenceNumber: string (optional)
A number used to indicate the type of research activity as defined by the National Science Foundation. NSF codes are not specific for NSF proposals and/or awards. Maximum length is 12.
paymentScheduleIndicator: string (optional)
scienceCodeIndicator: string (optional)
specialReviewIndicator: string (optional)
sponsorAwardNumber: string (optional)
Sponsor Award ID. Maximum length is 70.
transferSponsorIndicator: string (optional)
accountTypeCode: string (optional)
Account Type. Maximum length is 3.
activityTypeCode: string (optional)
The type of activity proposed, e.g. organized research, instruction, etc. Maximum length is 3.
awardTypeCode: string (optional)
Award Type. Maximum length is 3.
primeSponsorCode: string (optional)
The identification number of the organization or agency that is providing support for the sponsored project. Maximum length is 20.
awardId: string (optional)
Award Id. Maximum length is 12.
basisOfPaymentCode: string (optional)
Payment Basis. Maximum length is 3.
documentFundingId: string (optional)
Document Funding ID. Maximum length is 20.
methodOfPaymentCode: string (optional)
Payment Method. Maximum length is 3.
preAwardAuthorizedAmount: string (optional)
Pre Award Sponsor Authorized Amount. Maximum length is 12.
preAwardEffectiveDate: string (optional)
Pre Award Sponsor Effective Date. Maximum length is 21.
preAwardInstitutionalAuthorizedAmount: string (optional)
Pre Award Institutional Authorized Amount. Maximum length is 12.
preAwardInstitutionalEffectiveDate: string (optional)
Pre Award Institutional Effective Date. Maximum length is 21.
procurementPriorityCode: string (optional)
Competing Renewal. Maximum length is 6.
proposalNumber: string (optional)
specialEbRateOffCampus: string (optional)
Special EB Rate Off CampusContract. Maximum length is 10.
specialEbRateOnCampus: string (optional)
Special EB Rate On CampusContract. Maximum length is 10.
subPlanFlag: string (optional)
Small Business Subcontracting Plan. Maximum length is 1.
title: string (optional)
The proposed title of the project. Maximum length is 200.
archiveLocation: string (optional)
Archive Location. Maximum length is 500.
closeoutDate: string (optional)
Archive Date. Maximum length is 21.
awardTransactionTypeCode: string (optional)
Transaction Type. Maximum length is 3.
noticeDate: string (optional)
Notice Date. Maximum length is 21.
unitNumber: string (optional)
The lead unit number for the Award. Maximum length is 20.
financialAccountDocumentNumber: string (optional)
Document number returned by financial service when an account is created. Maximum length is 20.
financialAccountCreationDate: string (optional)
Financial account creation date. Maximum length is 20.
financialChartOfAccountsCode: string (optional)
Chart of accounts for a Financial Account. Maximum length is 45.
syncChild: string (optional)
awardSequenceStatus: string (optional)
Document Status. Maximum length is 20.
fainId: string (optional)
FAIN ID. Maximum length is 32.
fedAwardYear: string (optional)
Federal Award Year. Maximum length is 4.
fedAwardDate: string (optional)
Federal Award Date. Maximum length is 21.
awardDocument.documentNumber: string (optional)
The document id is generated by the workflow environment and is unique to each installation of Kuali… Maximum length is 14.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "sponsorCode": "(val)",
    "statusCode": "(val)",
    "templateCode": "(val)",
    "accountNumber": "(val)",
    "approvedEquipmentIndicator": "(val)",
    "approvedForeignTripIndicator": "(val)",
    "subContractIndicator": "(val)",
    "awardEffectiveDate": "(val)",
    "awardExecutionDate": "(val)",
    "beginDate": "(val)",
    "costSharingIndicator": "(val)",
    "indirectCostIndicator": "(val)",
    "modificationNumber": "(val)",
    "nsfSequenceNumber": "(val)",
    "paymentScheduleIndicator": "(val)",
    "scienceCodeIndicator": "(val)",
    "specialReviewIndicator": "(val)",
    "sponsorAwardNumber": "(val)",
    "transferSponsorIndicator": "(val)",
    "accountTypeCode": "(val)",
    "activityTypeCode": "(val)",
    "awardTypeCode": "(val)",
    "primeSponsorCode": "(val)",
    "awardId": "(val)",
    "basisOfPaymentCode": "(val)",
    "documentFundingId": "(val)",
    "methodOfPaymentCode": "(val)",
    "preAwardAuthorizedAmount": "(val)",
    "preAwardEffectiveDate": "(val)",
    "preAwardInstitutionalAuthorizedAmount": "(val)",
    "preAwardInstitutionalEffectiveDate": "(val)",
    "procurementPriorityCode": "(val)",
    "proposalNumber": "(val)",
    "specialEbRateOffCampus": "(val)",
    "specialEbRateOnCampus": "(val)",
    "subPlanFlag": "(val)",
    "title": "(val)",
    "archiveLocation": "(val)",
    "closeoutDate": "(val)",
    "awardTransactionTypeCode": "(val)",
    "noticeDate": "(val)",
    "unitNumber": "(val)",
    "financialAccountDocumentNumber": "(val)",
    "financialAccountCreationDate": "(val)",
    "financialChartOfAccountsCode": "(val)",
    "syncChild": "(val)",
    "awardSequenceStatus": "(val)",
    "fainId": "(val)",
    "fedAwardYear": "(val)",
    "fedAwardDate": "(val)",
    "awardDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "sponsorCode": "(val)",
    "statusCode": "(val)",
    "templateCode": "(val)",
    "accountNumber": "(val)",
    "approvedEquipmentIndicator": "(val)",
    "approvedForeignTripIndicator": "(val)",
    "subContractIndicator": "(val)",
    "awardEffectiveDate": "(val)",
    "awardExecutionDate": "(val)",
    "beginDate": "(val)",
    "costSharingIndicator": "(val)",
    "indirectCostIndicator": "(val)",
    "modificationNumber": "(val)",
    "nsfSequenceNumber": "(val)",
    "paymentScheduleIndicator": "(val)",
    "scienceCodeIndicator": "(val)",
    "specialReviewIndicator": "(val)",
    "sponsorAwardNumber": "(val)",
    "transferSponsorIndicator": "(val)",
    "accountTypeCode": "(val)",
    "activityTypeCode": "(val)",
    "awardTypeCode": "(val)",
    "primeSponsorCode": "(val)",
    "awardId": "(val)",
    "basisOfPaymentCode": "(val)",
    "documentFundingId": "(val)",
    "methodOfPaymentCode": "(val)",
    "preAwardAuthorizedAmount": "(val)",
    "preAwardEffectiveDate": "(val)",
    "preAwardInstitutionalAuthorizedAmount": "(val)",
    "preAwardInstitutionalEffectiveDate": "(val)",
    "procurementPriorityCode": "(val)",
    "proposalNumber": "(val)",
    "specialEbRateOffCampus": "(val)",
    "specialEbRateOnCampus": "(val)",
    "subPlanFlag": "(val)",
    "title": "(val)",
    "archiveLocation": "(val)",
    "closeoutDate": "(val)",
    "awardTransactionTypeCode": "(val)",
    "noticeDate": "(val)",
    "unitNumber": "(val)",
    "financialAccountDocumentNumber": "(val)",
    "financialAccountCreationDate": "(val)",
    "financialChartOfAccountsCode": "(val)",
    "syncChild": "(val)",
    "awardSequenceStatus": "(val)",
    "fainId": "(val)",
    "fedAwardYear": "(val)",
    "fedAwardDate": "(val)",
    "awardDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Awards
GET`/award/api/v1/awards/`

Example URI

GET /award/api/v1/awards/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardNumber",
    "sequenceNumber",
    "sponsorCode",
    "statusCode",
    "templateCode",
    "accountNumber",
    "approvedEquipmentIndicator",
    "approvedForeignTripIndicator",
    "subContractIndicator",
    "awardEffectiveDate",
    "awardExecutionDate",
    "beginDate",
    "costSharingIndicator",
    "indirectCostIndicator",
    "modificationNumber",
    "nsfSequenceNumber",
    "paymentScheduleIndicator",
    "scienceCodeIndicator",
    "specialReviewIndicator",
    "sponsorAwardNumber",
    "transferSponsorIndicator",
    "accountTypeCode",
    "activityTypeCode",
    "awardTypeCode",
    "primeSponsorCode",
    "awardId",
    "basisOfPaymentCode",
    "documentFundingId",
    "methodOfPaymentCode",
    "preAwardAuthorizedAmount",
    "preAwardEffectiveDate",
    "preAwardInstitutionalAuthorizedAmount",
    "preAwardInstitutionalEffectiveDate",
    "procurementPriorityCode",
    "proposalNumber",
    "specialEbRateOffCampus",
    "specialEbRateOnCampus",
    "subPlanFlag",
    "title",
    "archiveLocation",
    "closeoutDate",
    "awardTransactionTypeCode",
    "noticeDate",
    "unitNumber",
    "financialAccountDocumentNumber",
    "financialAccountCreationDate",
    "financialChartOfAccountsCode",
    "syncChild",
    "awardSequenceStatus",
    "fainId",
    "fedAwardYear",
    "fedAwardDate",
    "awardDocument.documentNumber"
  ],
  "primaryKey": "awardId"
}

Get Blueprint API specification for Awards
GET`/award/api/v1/awards/`

Example URI

GET /award/api/v1/awards/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Awards.md"
transfer-encoding: chunked

Update Awards
PUT`/award/api/v1/awards/(key)`

Example URI

PUT /award/api/v1/awards/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "sponsorCode": "(val)",
  "statusCode": "(val)",
  "templateCode": "(val)",
  "accountNumber": "(val)",
  "approvedEquipmentIndicator": "(val)",
  "approvedForeignTripIndicator": "(val)",
  "subContractIndicator": "(val)",
  "awardEffectiveDate": "(val)",
  "awardExecutionDate": "(val)",
  "beginDate": "(val)",
  "costSharingIndicator": "(val)",
  "indirectCostIndicator": "(val)",
  "modificationNumber": "(val)",
  "nsfSequenceNumber": "(val)",
  "paymentScheduleIndicator": "(val)",
  "scienceCodeIndicator": "(val)",
  "specialReviewIndicator": "(val)",
  "sponsorAwardNumber": "(val)",
  "transferSponsorIndicator": "(val)",
  "accountTypeCode": "(val)",
  "activityTypeCode": "(val)",
  "awardTypeCode": "(val)",
  "primeSponsorCode": "(val)",
  "awardId": "(val)",
  "basisOfPaymentCode": "(val)",
  "documentFundingId": "(val)",
  "methodOfPaymentCode": "(val)",
  "preAwardAuthorizedAmount": "(val)",
  "preAwardEffectiveDate": "(val)",
  "preAwardInstitutionalAuthorizedAmount": "(val)",
  "preAwardInstitutionalEffectiveDate": "(val)",
  "procurementPriorityCode": "(val)",
  "proposalNumber": "(val)",
  "specialEbRateOffCampus": "(val)",
  "specialEbRateOnCampus": "(val)",
  "subPlanFlag": "(val)",
  "title": "(val)",
  "archiveLocation": "(val)",
  "closeoutDate": "(val)",
  "awardTransactionTypeCode": "(val)",
  "noticeDate": "(val)",
  "unitNumber": "(val)",
  "financialAccountDocumentNumber": "(val)",
  "financialAccountCreationDate": "(val)",
  "financialChartOfAccountsCode": "(val)",
  "syncChild": "(val)",
  "awardSequenceStatus": "(val)",
  "fainId": "(val)",
  "fedAwardYear": "(val)",
  "fedAwardDate": "(val)",
  "awardDocument.documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Awards
PUT`/award/api/v1/awards/`

Example URI

PUT /award/api/v1/awards/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "sponsorCode": "(val)",
    "statusCode": "(val)",
    "templateCode": "(val)",
    "accountNumber": "(val)",
    "approvedEquipmentIndicator": "(val)",
    "approvedForeignTripIndicator": "(val)",
    "subContractIndicator": "(val)",
    "awardEffectiveDate": "(val)",
    "awardExecutionDate": "(val)",
    "beginDate": "(val)",
    "costSharingIndicator": "(val)",
    "indirectCostIndicator": "(val)",
    "modificationNumber": "(val)",
    "nsfSequenceNumber": "(val)",
    "paymentScheduleIndicator": "(val)",
    "scienceCodeIndicator": "(val)",
    "specialReviewIndicator": "(val)",
    "sponsorAwardNumber": "(val)",
    "transferSponsorIndicator": "(val)",
    "accountTypeCode": "(val)",
    "activityTypeCode": "(val)",
    "awardTypeCode": "(val)",
    "primeSponsorCode": "(val)",
    "awardId": "(val)",
    "basisOfPaymentCode": "(val)",
    "documentFundingId": "(val)",
    "methodOfPaymentCode": "(val)",
    "preAwardAuthorizedAmount": "(val)",
    "preAwardEffectiveDate": "(val)",
    "preAwardInstitutionalAuthorizedAmount": "(val)",
    "preAwardInstitutionalEffectiveDate": "(val)",
    "procurementPriorityCode": "(val)",
    "proposalNumber": "(val)",
    "specialEbRateOffCampus": "(val)",
    "specialEbRateOnCampus": "(val)",
    "subPlanFlag": "(val)",
    "title": "(val)",
    "archiveLocation": "(val)",
    "closeoutDate": "(val)",
    "awardTransactionTypeCode": "(val)",
    "noticeDate": "(val)",
    "unitNumber": "(val)",
    "financialAccountDocumentNumber": "(val)",
    "financialAccountCreationDate": "(val)",
    "financialChartOfAccountsCode": "(val)",
    "syncChild": "(val)",
    "awardSequenceStatus": "(val)",
    "fainId": "(val)",
    "fedAwardYear": "(val)",
    "fedAwardDate": "(val)",
    "awardDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "sponsorCode": "(val)",
    "statusCode": "(val)",
    "templateCode": "(val)",
    "accountNumber": "(val)",
    "approvedEquipmentIndicator": "(val)",
    "approvedForeignTripIndicator": "(val)",
    "subContractIndicator": "(val)",
    "awardEffectiveDate": "(val)",
    "awardExecutionDate": "(val)",
    "beginDate": "(val)",
    "costSharingIndicator": "(val)",
    "indirectCostIndicator": "(val)",
    "modificationNumber": "(val)",
    "nsfSequenceNumber": "(val)",
    "paymentScheduleIndicator": "(val)",
    "scienceCodeIndicator": "(val)",
    "specialReviewIndicator": "(val)",
    "sponsorAwardNumber": "(val)",
    "transferSponsorIndicator": "(val)",
    "accountTypeCode": "(val)",
    "activityTypeCode": "(val)",
    "awardTypeCode": "(val)",
    "primeSponsorCode": "(val)",
    "awardId": "(val)",
    "basisOfPaymentCode": "(val)",
    "documentFundingId": "(val)",
    "methodOfPaymentCode": "(val)",
    "preAwardAuthorizedAmount": "(val)",
    "preAwardEffectiveDate": "(val)",
    "preAwardInstitutionalAuthorizedAmount": "(val)",
    "preAwardInstitutionalEffectiveDate": "(val)",
    "procurementPriorityCode": "(val)",
    "proposalNumber": "(val)",
    "specialEbRateOffCampus": "(val)",
    "specialEbRateOnCampus": "(val)",
    "subPlanFlag": "(val)",
    "title": "(val)",
    "archiveLocation": "(val)",
    "closeoutDate": "(val)",
    "awardTransactionTypeCode": "(val)",
    "noticeDate": "(val)",
    "unitNumber": "(val)",
    "financialAccountDocumentNumber": "(val)",
    "financialAccountCreationDate": "(val)",
    "financialChartOfAccountsCode": "(val)",
    "syncChild": "(val)",
    "awardSequenceStatus": "(val)",
    "fainId": "(val)",
    "fedAwardYear": "(val)",
    "fedAwardDate": "(val)",
    "awardDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Awards
PATCH`/award/api/v1/awards/(key)`

Example URI

PATCH /award/api/v1/awards/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "sponsorCode": "(val)",
  "statusCode": "(val)",
  "templateCode": "(val)",
  "accountNumber": "(val)",
  "approvedEquipmentIndicator": "(val)",
  "approvedForeignTripIndicator": "(val)",
  "subContractIndicator": "(val)",
  "awardEffectiveDate": "(val)",
  "awardExecutionDate": "(val)",
  "beginDate": "(val)",
  "costSharingIndicator": "(val)",
  "indirectCostIndicator": "(val)",
  "modificationNumber": "(val)",
  "nsfSequenceNumber": "(val)",
  "paymentScheduleIndicator": "(val)",
  "scienceCodeIndicator": "(val)",
  "specialReviewIndicator": "(val)",
  "sponsorAwardNumber": "(val)",
  "transferSponsorIndicator": "(val)",
  "accountTypeCode": "(val)",
  "activityTypeCode": "(val)",
  "awardTypeCode": "(val)",
  "primeSponsorCode": "(val)",
  "awardId": "(val)",
  "basisOfPaymentCode": "(val)",
  "documentFundingId": "(val)",
  "methodOfPaymentCode": "(val)",
  "preAwardAuthorizedAmount": "(val)",
  "preAwardEffectiveDate": "(val)",
  "preAwardInstitutionalAuthorizedAmount": "(val)",
  "preAwardInstitutionalEffectiveDate": "(val)",
  "procurementPriorityCode": "(val)",
  "proposalNumber": "(val)",
  "specialEbRateOffCampus": "(val)",
  "specialEbRateOnCampus": "(val)",
  "subPlanFlag": "(val)",
  "title": "(val)",
  "archiveLocation": "(val)",
  "closeoutDate": "(val)",
  "awardTransactionTypeCode": "(val)",
  "noticeDate": "(val)",
  "unitNumber": "(val)",
  "financialAccountDocumentNumber": "(val)",
  "financialAccountCreationDate": "(val)",
  "financialChartOfAccountsCode": "(val)",
  "syncChild": "(val)",
  "awardSequenceStatus": "(val)",
  "fainId": "(val)",
  "fedAwardYear": "(val)",
  "fedAwardDate": "(val)",
  "awardDocument.documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "sponsorCode": "(val)",
  "statusCode": "(val)",
  "templateCode": "(val)",
  "accountNumber": "(val)",
  "approvedEquipmentIndicator": "(val)",
  "approvedForeignTripIndicator": "(val)",
  "subContractIndicator": "(val)",
  "awardEffectiveDate": "(val)",
  "awardExecutionDate": "(val)",
  "beginDate": "(val)",
  "costSharingIndicator": "(val)",
  "indirectCostIndicator": "(val)",
  "modificationNumber": "(val)",
  "nsfSequenceNumber": "(val)",
  "paymentScheduleIndicator": "(val)",
  "scienceCodeIndicator": "(val)",
  "specialReviewIndicator": "(val)",
  "sponsorAwardNumber": "(val)",
  "transferSponsorIndicator": "(val)",
  "accountTypeCode": "(val)",
  "activityTypeCode": "(val)",
  "awardTypeCode": "(val)",
  "primeSponsorCode": "(val)",
  "awardId": "(val)",
  "basisOfPaymentCode": "(val)",
  "documentFundingId": "(val)",
  "methodOfPaymentCode": "(val)",
  "preAwardAuthorizedAmount": "(val)",
  "preAwardEffectiveDate": "(val)",
  "preAwardInstitutionalAuthorizedAmount": "(val)",
  "preAwardInstitutionalEffectiveDate": "(val)",
  "procurementPriorityCode": "(val)",
  "proposalNumber": "(val)",
  "specialEbRateOffCampus": "(val)",
  "specialEbRateOnCampus": "(val)",
  "subPlanFlag": "(val)",
  "title": "(val)",
  "archiveLocation": "(val)",
  "closeoutDate": "(val)",
  "awardTransactionTypeCode": "(val)",
  "noticeDate": "(val)",
  "unitNumber": "(val)",
  "financialAccountDocumentNumber": "(val)",
  "financialAccountCreationDate": "(val)",
  "financialChartOfAccountsCode": "(val)",
  "syncChild": "(val)",
  "awardSequenceStatus": "(val)",
  "fainId": "(val)",
  "fedAwardYear": "(val)",
  "fedAwardDate": "(val)",
  "awardDocument.documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Awards
POST`/award/api/v1/awards/`

Example URI

POST /award/api/v1/awards/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "sponsorCode": "(val)",
  "statusCode": "(val)",
  "templateCode": "(val)",
  "accountNumber": "(val)",
  "approvedEquipmentIndicator": "(val)",
  "approvedForeignTripIndicator": "(val)",
  "subContractIndicator": "(val)",
  "awardEffectiveDate": "(val)",
  "awardExecutionDate": "(val)",
  "beginDate": "(val)",
  "costSharingIndicator": "(val)",
  "indirectCostIndicator": "(val)",
  "modificationNumber": "(val)",
  "nsfSequenceNumber": "(val)",
  "paymentScheduleIndicator": "(val)",
  "scienceCodeIndicator": "(val)",
  "specialReviewIndicator": "(val)",
  "sponsorAwardNumber": "(val)",
  "transferSponsorIndicator": "(val)",
  "accountTypeCode": "(val)",
  "activityTypeCode": "(val)",
  "awardTypeCode": "(val)",
  "primeSponsorCode": "(val)",
  "awardId": "(val)",
  "basisOfPaymentCode": "(val)",
  "documentFundingId": "(val)",
  "methodOfPaymentCode": "(val)",
  "preAwardAuthorizedAmount": "(val)",
  "preAwardEffectiveDate": "(val)",
  "preAwardInstitutionalAuthorizedAmount": "(val)",
  "preAwardInstitutionalEffectiveDate": "(val)",
  "procurementPriorityCode": "(val)",
  "proposalNumber": "(val)",
  "specialEbRateOffCampus": "(val)",
  "specialEbRateOnCampus": "(val)",
  "subPlanFlag": "(val)",
  "title": "(val)",
  "archiveLocation": "(val)",
  "closeoutDate": "(val)",
  "awardTransactionTypeCode": "(val)",
  "noticeDate": "(val)",
  "unitNumber": "(val)",
  "financialAccountDocumentNumber": "(val)",
  "financialAccountCreationDate": "(val)",
  "financialChartOfAccountsCode": "(val)",
  "syncChild": "(val)",
  "awardSequenceStatus": "(val)",
  "fainId": "(val)",
  "fedAwardYear": "(val)",
  "fedAwardDate": "(val)",
  "awardDocument.documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "sponsorCode": "(val)",
  "statusCode": "(val)",
  "templateCode": "(val)",
  "accountNumber": "(val)",
  "approvedEquipmentIndicator": "(val)",
  "approvedForeignTripIndicator": "(val)",
  "subContractIndicator": "(val)",
  "awardEffectiveDate": "(val)",
  "awardExecutionDate": "(val)",
  "beginDate": "(val)",
  "costSharingIndicator": "(val)",
  "indirectCostIndicator": "(val)",
  "modificationNumber": "(val)",
  "nsfSequenceNumber": "(val)",
  "paymentScheduleIndicator": "(val)",
  "scienceCodeIndicator": "(val)",
  "specialReviewIndicator": "(val)",
  "sponsorAwardNumber": "(val)",
  "transferSponsorIndicator": "(val)",
  "accountTypeCode": "(val)",
  "activityTypeCode": "(val)",
  "awardTypeCode": "(val)",
  "primeSponsorCode": "(val)",
  "awardId": "(val)",
  "basisOfPaymentCode": "(val)",
  "documentFundingId": "(val)",
  "methodOfPaymentCode": "(val)",
  "preAwardAuthorizedAmount": "(val)",
  "preAwardEffectiveDate": "(val)",
  "preAwardInstitutionalAuthorizedAmount": "(val)",
  "preAwardInstitutionalEffectiveDate": "(val)",
  "procurementPriorityCode": "(val)",
  "proposalNumber": "(val)",
  "specialEbRateOffCampus": "(val)",
  "specialEbRateOnCampus": "(val)",
  "subPlanFlag": "(val)",
  "title": "(val)",
  "archiveLocation": "(val)",
  "closeoutDate": "(val)",
  "awardTransactionTypeCode": "(val)",
  "noticeDate": "(val)",
  "unitNumber": "(val)",
  "financialAccountDocumentNumber": "(val)",
  "financialAccountCreationDate": "(val)",
  "financialChartOfAccountsCode": "(val)",
  "syncChild": "(val)",
  "awardSequenceStatus": "(val)",
  "fainId": "(val)",
  "fedAwardYear": "(val)",
  "fedAwardDate": "(val)",
  "awardDocument.documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Awards
POST`/award/api/v1/awards/`

Example URI

POST /award/api/v1/awards/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "sponsorCode": "(val)",
    "statusCode": "(val)",
    "templateCode": "(val)",
    "accountNumber": "(val)",
    "approvedEquipmentIndicator": "(val)",
    "approvedForeignTripIndicator": "(val)",
    "subContractIndicator": "(val)",
    "awardEffectiveDate": "(val)",
    "awardExecutionDate": "(val)",
    "beginDate": "(val)",
    "costSharingIndicator": "(val)",
    "indirectCostIndicator": "(val)",
    "modificationNumber": "(val)",
    "nsfSequenceNumber": "(val)",
    "paymentScheduleIndicator": "(val)",
    "scienceCodeIndicator": "(val)",
    "specialReviewIndicator": "(val)",
    "sponsorAwardNumber": "(val)",
    "transferSponsorIndicator": "(val)",
    "accountTypeCode": "(val)",
    "activityTypeCode": "(val)",
    "awardTypeCode": "(val)",
    "primeSponsorCode": "(val)",
    "awardId": "(val)",
    "basisOfPaymentCode": "(val)",
    "documentFundingId": "(val)",
    "methodOfPaymentCode": "(val)",
    "preAwardAuthorizedAmount": "(val)",
    "preAwardEffectiveDate": "(val)",
    "preAwardInstitutionalAuthorizedAmount": "(val)",
    "preAwardInstitutionalEffectiveDate": "(val)",
    "procurementPriorityCode": "(val)",
    "proposalNumber": "(val)",
    "specialEbRateOffCampus": "(val)",
    "specialEbRateOnCampus": "(val)",
    "subPlanFlag": "(val)",
    "title": "(val)",
    "archiveLocation": "(val)",
    "closeoutDate": "(val)",
    "awardTransactionTypeCode": "(val)",
    "noticeDate": "(val)",
    "unitNumber": "(val)",
    "financialAccountDocumentNumber": "(val)",
    "financialAccountCreationDate": "(val)",
    "financialChartOfAccountsCode": "(val)",
    "syncChild": "(val)",
    "awardSequenceStatus": "(val)",
    "fainId": "(val)",
    "fedAwardYear": "(val)",
    "fedAwardDate": "(val)",
    "awardDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "sponsorCode": "(val)",
    "statusCode": "(val)",
    "templateCode": "(val)",
    "accountNumber": "(val)",
    "approvedEquipmentIndicator": "(val)",
    "approvedForeignTripIndicator": "(val)",
    "subContractIndicator": "(val)",
    "awardEffectiveDate": "(val)",
    "awardExecutionDate": "(val)",
    "beginDate": "(val)",
    "costSharingIndicator": "(val)",
    "indirectCostIndicator": "(val)",
    "modificationNumber": "(val)",
    "nsfSequenceNumber": "(val)",
    "paymentScheduleIndicator": "(val)",
    "scienceCodeIndicator": "(val)",
    "specialReviewIndicator": "(val)",
    "sponsorAwardNumber": "(val)",
    "transferSponsorIndicator": "(val)",
    "accountTypeCode": "(val)",
    "activityTypeCode": "(val)",
    "awardTypeCode": "(val)",
    "primeSponsorCode": "(val)",
    "awardId": "(val)",
    "basisOfPaymentCode": "(val)",
    "documentFundingId": "(val)",
    "methodOfPaymentCode": "(val)",
    "preAwardAuthorizedAmount": "(val)",
    "preAwardEffectiveDate": "(val)",
    "preAwardInstitutionalAuthorizedAmount": "(val)",
    "preAwardInstitutionalEffectiveDate": "(val)",
    "procurementPriorityCode": "(val)",
    "proposalNumber": "(val)",
    "specialEbRateOffCampus": "(val)",
    "specialEbRateOnCampus": "(val)",
    "subPlanFlag": "(val)",
    "title": "(val)",
    "archiveLocation": "(val)",
    "closeoutDate": "(val)",
    "awardTransactionTypeCode": "(val)",
    "noticeDate": "(val)",
    "unitNumber": "(val)",
    "financialAccountDocumentNumber": "(val)",
    "financialAccountCreationDate": "(val)",
    "financialChartOfAccountsCode": "(val)",
    "syncChild": "(val)",
    "awardSequenceStatus": "(val)",
    "fainId": "(val)",
    "fedAwardYear": "(val)",
    "fedAwardDate": "(val)",
    "awardDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "sponsorCode": "(val)",
    "statusCode": "(val)",
    "templateCode": "(val)",
    "accountNumber": "(val)",
    "approvedEquipmentIndicator": "(val)",
    "approvedForeignTripIndicator": "(val)",
    "subContractIndicator": "(val)",
    "awardEffectiveDate": "(val)",
    "awardExecutionDate": "(val)",
    "beginDate": "(val)",
    "costSharingIndicator": "(val)",
    "indirectCostIndicator": "(val)",
    "modificationNumber": "(val)",
    "nsfSequenceNumber": "(val)",
    "paymentScheduleIndicator": "(val)",
    "scienceCodeIndicator": "(val)",
    "specialReviewIndicator": "(val)",
    "sponsorAwardNumber": "(val)",
    "transferSponsorIndicator": "(val)",
    "accountTypeCode": "(val)",
    "activityTypeCode": "(val)",
    "awardTypeCode": "(val)",
    "primeSponsorCode": "(val)",
    "awardId": "(val)",
    "basisOfPaymentCode": "(val)",
    "documentFundingId": "(val)",
    "methodOfPaymentCode": "(val)",
    "preAwardAuthorizedAmount": "(val)",
    "preAwardEffectiveDate": "(val)",
    "preAwardInstitutionalAuthorizedAmount": "(val)",
    "preAwardInstitutionalEffectiveDate": "(val)",
    "procurementPriorityCode": "(val)",
    "proposalNumber": "(val)",
    "specialEbRateOffCampus": "(val)",
    "specialEbRateOnCampus": "(val)",
    "subPlanFlag": "(val)",
    "title": "(val)",
    "archiveLocation": "(val)",
    "closeoutDate": "(val)",
    "awardTransactionTypeCode": "(val)",
    "noticeDate": "(val)",
    "unitNumber": "(val)",
    "financialAccountDocumentNumber": "(val)",
    "financialAccountCreationDate": "(val)",
    "financialChartOfAccountsCode": "(val)",
    "syncChild": "(val)",
    "awardSequenceStatus": "(val)",
    "fainId": "(val)",
    "fedAwardYear": "(val)",
    "fedAwardDate": "(val)",
    "awardDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "sponsorCode": "(val)",
    "statusCode": "(val)",
    "templateCode": "(val)",
    "accountNumber": "(val)",
    "approvedEquipmentIndicator": "(val)",
    "approvedForeignTripIndicator": "(val)",
    "subContractIndicator": "(val)",
    "awardEffectiveDate": "(val)",
    "awardExecutionDate": "(val)",
    "beginDate": "(val)",
    "costSharingIndicator": "(val)",
    "indirectCostIndicator": "(val)",
    "modificationNumber": "(val)",
    "nsfSequenceNumber": "(val)",
    "paymentScheduleIndicator": "(val)",
    "scienceCodeIndicator": "(val)",
    "specialReviewIndicator": "(val)",
    "sponsorAwardNumber": "(val)",
    "transferSponsorIndicator": "(val)",
    "accountTypeCode": "(val)",
    "activityTypeCode": "(val)",
    "awardTypeCode": "(val)",
    "primeSponsorCode": "(val)",
    "awardId": "(val)",
    "basisOfPaymentCode": "(val)",
    "documentFundingId": "(val)",
    "methodOfPaymentCode": "(val)",
    "preAwardAuthorizedAmount": "(val)",
    "preAwardEffectiveDate": "(val)",
    "preAwardInstitutionalAuthorizedAmount": "(val)",
    "preAwardInstitutionalEffectiveDate": "(val)",
    "procurementPriorityCode": "(val)",
    "proposalNumber": "(val)",
    "specialEbRateOffCampus": "(val)",
    "specialEbRateOnCampus": "(val)",
    "subPlanFlag": "(val)",
    "title": "(val)",
    "archiveLocation": "(val)",
    "closeoutDate": "(val)",
    "awardTransactionTypeCode": "(val)",
    "noticeDate": "(val)",
    "unitNumber": "(val)",
    "financialAccountDocumentNumber": "(val)",
    "financialAccountCreationDate": "(val)",
    "financialChartOfAccountsCode": "(val)",
    "syncChild": "(val)",
    "awardSequenceStatus": "(val)",
    "fainId": "(val)",
    "fedAwardYear": "(val)",
    "fedAwardDate": "(val)",
    "awardDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Awards by Key
DELETE`/award/api/v1/awards/(key)`

Example URI

DELETE /award/api/v1/awards/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Awards
DELETE`/award/api/v1/awards/`

Example URI

DELETE /award/api/v1/awards/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Awards with Matching
DELETE`/award/api/v1/awards/`

Example URI

DELETE /award/api/v1/awards/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardNumber: string (optional)
Award ID. Maximum length is 12.
sequenceNumber: string (optional)
Sequence Number. Maximum length is 4.
sponsorCode: string (optional)
The identification number of the organization or agency that is providing support for the sponsored project. Maximum length is 20.
statusCode: string (optional)
Award Status. Maximum length is 3.
templateCode: string (optional)
Pre-defined Sponsor Template to sync. Maximum length is 6.
accountNumber: string (optional)
Account ID. Maximum length is 25.
approvedEquipmentIndicator: string (optional)
approvedForeignTripIndicator: string (optional)
subContractIndicator: string (optional)
awardEffectiveDate: string (optional)
Project Start Date. Maximum length is 10.
awardExecutionDate: string (optional)
The Execution Date of the Budget. Maximum length is 10.
beginDate: string (optional)
Modification Date. Maximum length is 10.
costSharingIndicator: string (optional)
indirectCostIndicator: string (optional)
modificationNumber: string (optional)
Modification ID. Maximum length is 50.
nsfSequenceNumber: string (optional)
A number used to indicate the type of research activity as defined by the National Science Foundation. NSF codes are not specific for NSF proposals and/or awards. Maximum length is 12.
paymentScheduleIndicator: string (optional)
scienceCodeIndicator: string (optional)
specialReviewIndicator: string (optional)
sponsorAwardNumber: string (optional)
Sponsor Award ID. Maximum length is 70.
transferSponsorIndicator: string (optional)
accountTypeCode: string (optional)
Account Type. Maximum length is 3.
activityTypeCode: string (optional)
The type of activity proposed, e.g. organized research, instruction, etc. Maximum length is 3.
awardTypeCode: string (optional)
Award Type. Maximum length is 3.
primeSponsorCode: string (optional)
The identification number of the organization or agency that is providing support for the sponsored project. Maximum length is 20.
awardId: string (optional)
Award Id. Maximum length is 12.
basisOfPaymentCode: string (optional)
Payment Basis. Maximum length is 3.
documentFundingId: string (optional)
Document Funding ID. Maximum length is 20.
methodOfPaymentCode: string (optional)
Payment Method. Maximum length is 3.
preAwardAuthorizedAmount: string (optional)
Pre Award Sponsor Authorized Amount. Maximum length is 12.
preAwardEffectiveDate: string (optional)
Pre Award Sponsor Effective Date. Maximum length is 21.
preAwardInstitutionalAuthorizedAmount: string (optional)
Pre Award Institutional Authorized Amount. Maximum length is 12.
preAwardInstitutionalEffectiveDate: string (optional)
Pre Award Institutional Effective Date. Maximum length is 21.
procurementPriorityCode: string (optional)
Competing Renewal. Maximum length is 6.
proposalNumber: string (optional)
specialEbRateOffCampus: string (optional)
Special EB Rate Off CampusContract. Maximum length is 10.
specialEbRateOnCampus: string (optional)
Special EB Rate On CampusContract. Maximum length is 10.
subPlanFlag: string (optional)
Small Business Subcontracting Plan. Maximum length is 1.
title: string (optional)
The proposed title of the project. Maximum length is 200.
archiveLocation: string (optional)
Archive Location. Maximum length is 500.
closeoutDate: string (optional)
Archive Date. Maximum length is 21.
awardTransactionTypeCode: string (optional)
Transaction Type. Maximum length is 3.
noticeDate: string (optional)
Notice Date. Maximum length is 21.
unitNumber: string (optional)
The lead unit number for the Award. Maximum length is 20.
financialAccountDocumentNumber: string (optional)
Document number returned by financial service when an account is created. Maximum length is 20.
financialAccountCreationDate: string (optional)
Financial account creation date. Maximum length is 20.
financialChartOfAccountsCode: string (optional)
Chart of accounts for a Financial Account. Maximum length is 45.
syncChild: string (optional)
awardSequenceStatus: string (optional)
Document Status. Maximum length is 20.
fainId: string (optional)
FAIN ID. Maximum length is 32.
fedAwardYear: string (optional)
Federal Award Year. Maximum length is 4.
fedAwardDate: string (optional)
Federal Award Date. Maximum length is 21.
awardDocument.documentNumber: string (optional)
The document id is generated by the workflow environment and is unique to each installation of Kuali… Maximum length is 14.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Amount Infos ¶

Get Award Amount Infos by Key
GET`/award/api/v1/award-amount-infos/(key)`

Example URI

GET /award/api/v1/award-amount-infos/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardAmountInfoId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "anticipatedTotalAmount": "(val)",
  "antDistributableAmount": "(val)",
  "finalExpirationDate": "(val)",
  "currentFundEffectiveDate": "(val)",
  "amountObligatedToDate": "(val)",
  "obliDistributableAmount": "(val)",
  "obligationExpirationDate": "(val)",
  "transactionId": "(val)",
  "timeAndMoneyDocumentNumber": "(val)",
  "entryType": "(val)",
  "eomProcessFlag": "(val)",
  "anticipatedChange": "(val)",
  "obligatedChange": "(val)",
  "obligatedChangeDirect": "(val)",
  "obligatedChangeIndirect": "(val)",
  "anticipatedChangeDirect": "(val)",
  "anticipatedChangeIndirect": "(val)",
  "anticipatedTotalDirect": "(val)",
  "anticipatedTotalIndirect": "(val)",
  "obligatedTotalDirect": "(val)",
  "obligatedTotalIndirect": "(val)",
  "originatingAwardVersion": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Amount Infos
GET`/award/api/v1/award-amount-infos/`

Example URI

GET /award/api/v1/award-amount-infos/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardAmountInfoId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "anticipatedTotalAmount": "(val)",
    "antDistributableAmount": "(val)",
    "finalExpirationDate": "(val)",
    "currentFundEffectiveDate": "(val)",
    "amountObligatedToDate": "(val)",
    "obliDistributableAmount": "(val)",
    "obligationExpirationDate": "(val)",
    "transactionId": "(val)",
    "timeAndMoneyDocumentNumber": "(val)",
    "entryType": "(val)",
    "eomProcessFlag": "(val)",
    "anticipatedChange": "(val)",
    "obligatedChange": "(val)",
    "obligatedChangeDirect": "(val)",
    "obligatedChangeIndirect": "(val)",
    "anticipatedChangeDirect": "(val)",
    "anticipatedChangeIndirect": "(val)",
    "anticipatedTotalDirect": "(val)",
    "anticipatedTotalIndirect": "(val)",
    "obligatedTotalDirect": "(val)",
    "obligatedTotalIndirect": "(val)",
    "originatingAwardVersion": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardAmountInfoId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "anticipatedTotalAmount": "(val)",
    "antDistributableAmount": "(val)",
    "finalExpirationDate": "(val)",
    "currentFundEffectiveDate": "(val)",
    "amountObligatedToDate": "(val)",
    "obliDistributableAmount": "(val)",
    "obligationExpirationDate": "(val)",
    "transactionId": "(val)",
    "timeAndMoneyDocumentNumber": "(val)",
    "entryType": "(val)",
    "eomProcessFlag": "(val)",
    "anticipatedChange": "(val)",
    "obligatedChange": "(val)",
    "obligatedChangeDirect": "(val)",
    "obligatedChangeIndirect": "(val)",
    "anticipatedChangeDirect": "(val)",
    "anticipatedChangeIndirect": "(val)",
    "anticipatedTotalDirect": "(val)",
    "anticipatedTotalIndirect": "(val)",
    "obligatedTotalDirect": "(val)",
    "obligatedTotalIndirect": "(val)",
    "originatingAwardVersion": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Amount Infos with Filtering
GET`/award/api/v1/award-amount-infos/`

Example URI

GET /award/api/v1/award-amount-infos/

URI Parameters

HideShow

awardAmountInfoId: string (optional)
Award Amount Info Id. Maximum length is 22.
awardNumber: string (optional)
sequenceNumber: string (optional)
Amount Sequence Number. Maximum length is 22.
anticipatedTotalAmount: string (optional)
Anticipated Cumulative. Maximum length is 22.
antDistributableAmount: string (optional)
Anticipated Distributable. Maximum length is 22.
finalExpirationDate: string (optional)
Final Expiration Date. Maximum length is 10.
currentFundEffectiveDate: string (optional)
Obligation Start Date. Maximum length is 10.
amountObligatedToDate: string (optional)
Obligated Cumulative. Maximum length is 22.
obliDistributableAmount: string (optional)
Obligated Distributable. Maximum length is 22.
obligationExpirationDate: string (optional)
Obligation End Date. Maximum length is 10.
transactionId: string (optional)
Transaction Id. Maximum length is 10.
timeAndMoneyDocumentNumber: string (optional)
Document Number. Maximum length is 10.
entryType: string (optional)
Entry Type. Maximum length is 1.
eomProcessFlag: string (optional)
Eom ProcessDefinitionDefinition Flag. Maximum length is 1.
anticipatedChange: string (optional)
Anticipated Change. Maximum length is 22.
obligatedChange: string (optional)
Obligated Change. Maximum length is 22.
obligatedChangeDirect: string (optional)
Obligated Change Direct. Maximum length is 22.
obligatedChangeIndirect: string (optional)
Obligated Change Indirect. Maximum length is 22.
anticipatedChangeDirect: string (optional)
Anticipated Change Direct. Maximum length is 22.
anticipatedChangeIndirect: string (optional)
Anticipated Change Indirect. Maximum length is 22.
anticipatedTotalDirect: string (optional)
Anticipated Total Direct. Maximum length is 12.
anticipatedTotalIndirect: string (optional)
Anticipated Total Indirect. Maximum length is 12.
obligatedTotalDirect: string (optional)
Obligated Total Direct. Maximum length is 12.
obligatedTotalIndirect: string (optional)
Obligated Total Indirect. Maximum length is 12.
originatingAwardVersion: string (optional)
award.awardId: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardAmountInfoId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "anticipatedTotalAmount": "(val)",
    "antDistributableAmount": "(val)",
    "finalExpirationDate": "(val)",
    "currentFundEffectiveDate": "(val)",
    "amountObligatedToDate": "(val)",
    "obliDistributableAmount": "(val)",
    "obligationExpirationDate": "(val)",
    "transactionId": "(val)",
    "timeAndMoneyDocumentNumber": "(val)",
    "entryType": "(val)",
    "eomProcessFlag": "(val)",
    "anticipatedChange": "(val)",
    "obligatedChange": "(val)",
    "obligatedChangeDirect": "(val)",
    "obligatedChangeIndirect": "(val)",
    "anticipatedChangeDirect": "(val)",
    "anticipatedChangeIndirect": "(val)",
    "anticipatedTotalDirect": "(val)",
    "anticipatedTotalIndirect": "(val)",
    "obligatedTotalDirect": "(val)",
    "obligatedTotalIndirect": "(val)",
    "originatingAwardVersion": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardAmountInfoId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "anticipatedTotalAmount": "(val)",
    "antDistributableAmount": "(val)",
    "finalExpirationDate": "(val)",
    "currentFundEffectiveDate": "(val)",
    "amountObligatedToDate": "(val)",
    "obliDistributableAmount": "(val)",
    "obligationExpirationDate": "(val)",
    "transactionId": "(val)",
    "timeAndMoneyDocumentNumber": "(val)",
    "entryType": "(val)",
    "eomProcessFlag": "(val)",
    "anticipatedChange": "(val)",
    "obligatedChange": "(val)",
    "obligatedChangeDirect": "(val)",
    "obligatedChangeIndirect": "(val)",
    "anticipatedChangeDirect": "(val)",
    "anticipatedChangeIndirect": "(val)",
    "anticipatedTotalDirect": "(val)",
    "anticipatedTotalIndirect": "(val)",
    "obligatedTotalDirect": "(val)",
    "obligatedTotalIndirect": "(val)",
    "originatingAwardVersion": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Amount Infos
GET`/award/api/v1/award-amount-infos/`

Example URI

GET /award/api/v1/award-amount-infos/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardAmountInfoId",
    "awardNumber",
    "sequenceNumber",
    "anticipatedTotalAmount",
    "antDistributableAmount",
    "finalExpirationDate",
    "currentFundEffectiveDate",
    "amountObligatedToDate",
    "obliDistributableAmount",
    "obligationExpirationDate",
    "transactionId",
    "timeAndMoneyDocumentNumber",
    "entryType",
    "eomProcessFlag",
    "anticipatedChange",
    "obligatedChange",
    "obligatedChangeDirect",
    "obligatedChangeIndirect",
    "anticipatedChangeDirect",
    "anticipatedChangeIndirect",
    "anticipatedTotalDirect",
    "anticipatedTotalIndirect",
    "obligatedTotalDirect",
    "obligatedTotalIndirect",
    "originatingAwardVersion",
    "award.awardId"
  ],
  "primaryKey": "awardAmountInfoId"
}

Get Blueprint API specification for Award Amount Infos
GET`/award/api/v1/award-amount-infos/`

Example URI

GET /award/api/v1/award-amount-infos/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Amount Infos.md"
transfer-encoding: chunked

Update Award Amount Infos
PUT`/award/api/v1/award-amount-infos/(key)`

Example URI

PUT /award/api/v1/award-amount-infos/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardAmountInfoId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "anticipatedTotalAmount": "(val)",
  "antDistributableAmount": "(val)",
  "finalExpirationDate": "(val)",
  "currentFundEffectiveDate": "(val)",
  "amountObligatedToDate": "(val)",
  "obliDistributableAmount": "(val)",
  "obligationExpirationDate": "(val)",
  "transactionId": "(val)",
  "timeAndMoneyDocumentNumber": "(val)",
  "entryType": "(val)",
  "eomProcessFlag": "(val)",
  "anticipatedChange": "(val)",
  "obligatedChange": "(val)",
  "obligatedChangeDirect": "(val)",
  "obligatedChangeIndirect": "(val)",
  "anticipatedChangeDirect": "(val)",
  "anticipatedChangeIndirect": "(val)",
  "anticipatedTotalDirect": "(val)",
  "anticipatedTotalIndirect": "(val)",
  "obligatedTotalDirect": "(val)",
  "obligatedTotalIndirect": "(val)",
  "originatingAwardVersion": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Amount Infos
PUT`/award/api/v1/award-amount-infos/`

Example URI

PUT /award/api/v1/award-amount-infos/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardAmountInfoId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "anticipatedTotalAmount": "(val)",
    "antDistributableAmount": "(val)",
    "finalExpirationDate": "(val)",
    "currentFundEffectiveDate": "(val)",
    "amountObligatedToDate": "(val)",
    "obliDistributableAmount": "(val)",
    "obligationExpirationDate": "(val)",
    "transactionId": "(val)",
    "timeAndMoneyDocumentNumber": "(val)",
    "entryType": "(val)",
    "eomProcessFlag": "(val)",
    "anticipatedChange": "(val)",
    "obligatedChange": "(val)",
    "obligatedChangeDirect": "(val)",
    "obligatedChangeIndirect": "(val)",
    "anticipatedChangeDirect": "(val)",
    "anticipatedChangeIndirect": "(val)",
    "anticipatedTotalDirect": "(val)",
    "anticipatedTotalIndirect": "(val)",
    "obligatedTotalDirect": "(val)",
    "obligatedTotalIndirect": "(val)",
    "originatingAwardVersion": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardAmountInfoId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "anticipatedTotalAmount": "(val)",
    "antDistributableAmount": "(val)",
    "finalExpirationDate": "(val)",
    "currentFundEffectiveDate": "(val)",
    "amountObligatedToDate": "(val)",
    "obliDistributableAmount": "(val)",
    "obligationExpirationDate": "(val)",
    "transactionId": "(val)",
    "timeAndMoneyDocumentNumber": "(val)",
    "entryType": "(val)",
    "eomProcessFlag": "(val)",
    "anticipatedChange": "(val)",
    "obligatedChange": "(val)",
    "obligatedChangeDirect": "(val)",
    "obligatedChangeIndirect": "(val)",
    "anticipatedChangeDirect": "(val)",
    "anticipatedChangeIndirect": "(val)",
    "anticipatedTotalDirect": "(val)",
    "anticipatedTotalIndirect": "(val)",
    "obligatedTotalDirect": "(val)",
    "obligatedTotalIndirect": "(val)",
    "originatingAwardVersion": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Amount Infos
PATCH`/award/api/v1/award-amount-infos/(key)`

Example URI

PATCH /award/api/v1/award-amount-infos/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardAmountInfoId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "anticipatedTotalAmount": "(val)",
  "antDistributableAmount": "(val)",
  "finalExpirationDate": "(val)",
  "currentFundEffectiveDate": "(val)",
  "amountObligatedToDate": "(val)",
  "obliDistributableAmount": "(val)",
  "obligationExpirationDate": "(val)",
  "transactionId": "(val)",
  "timeAndMoneyDocumentNumber": "(val)",
  "entryType": "(val)",
  "eomProcessFlag": "(val)",
  "anticipatedChange": "(val)",
  "obligatedChange": "(val)",
  "obligatedChangeDirect": "(val)",
  "obligatedChangeIndirect": "(val)",
  "anticipatedChangeDirect": "(val)",
  "anticipatedChangeIndirect": "(val)",
  "anticipatedTotalDirect": "(val)",
  "anticipatedTotalIndirect": "(val)",
  "obligatedTotalDirect": "(val)",
  "obligatedTotalIndirect": "(val)",
  "originatingAwardVersion": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardAmountInfoId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "anticipatedTotalAmount": "(val)",
  "antDistributableAmount": "(val)",
  "finalExpirationDate": "(val)",
  "currentFundEffectiveDate": "(val)",
  "amountObligatedToDate": "(val)",
  "obliDistributableAmount": "(val)",
  "obligationExpirationDate": "(val)",
  "transactionId": "(val)",
  "timeAndMoneyDocumentNumber": "(val)",
  "entryType": "(val)",
  "eomProcessFlag": "(val)",
  "anticipatedChange": "(val)",
  "obligatedChange": "(val)",
  "obligatedChangeDirect": "(val)",
  "obligatedChangeIndirect": "(val)",
  "anticipatedChangeDirect": "(val)",
  "anticipatedChangeIndirect": "(val)",
  "anticipatedTotalDirect": "(val)",
  "anticipatedTotalIndirect": "(val)",
  "obligatedTotalDirect": "(val)",
  "obligatedTotalIndirect": "(val)",
  "originatingAwardVersion": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Award Amount Transactions ¶

Get Award Amount Transactions by Key
GET`/award/api/v1/award-amount-transactions/(key)`

Example URI

GET /award/api/v1/award-amount-transactions/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardAmountTransactionId": "(val)",
  "awardNumber": "(val)",
  "documentNumber": "(val)",
  "transactionTypeCode": "(val)",
  "noticeDate": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Amount Transactions
GET`/award/api/v1/award-amount-transactions/`

Example URI

GET /award/api/v1/award-amount-transactions/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardAmountTransactionId": "(val)",
    "awardNumber": "(val)",
    "documentNumber": "(val)",
    "transactionTypeCode": "(val)",
    "noticeDate": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardAmountTransactionId": "(val)",
    "awardNumber": "(val)",
    "documentNumber": "(val)",
    "transactionTypeCode": "(val)",
    "noticeDate": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Amount Transactions with Filtering
GET`/award/api/v1/award-amount-transactions/`

Example URI

GET /award/api/v1/award-amount-transactions/

URI Parameters

HideShow

awardAmountTransactionId: string (optional)
Award Amount Transaction Id. Maximum length is 22.
awardNumber: string (optional)
Award ID. Maximum length is 12.
documentNumber: string (optional)
Transaction Id. Maximum length is 10.
transactionTypeCode: string (optional)
Transaction Type Code. Maximum length is 22.
noticeDate: string (optional)
Notice Date. Maximum length is 10.
comments: string (optional)
Comments. Maximum length is 2000.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardAmountTransactionId": "(val)",
    "awardNumber": "(val)",
    "documentNumber": "(val)",
    "transactionTypeCode": "(val)",
    "noticeDate": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardAmountTransactionId": "(val)",
    "awardNumber": "(val)",
    "documentNumber": "(val)",
    "transactionTypeCode": "(val)",
    "noticeDate": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Amount Transactions
GET`/award/api/v1/award-amount-transactions/`

Example URI

GET /award/api/v1/award-amount-transactions/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardAmountTransactionId",
    "awardNumber",
    "documentNumber",
    "transactionTypeCode",
    "noticeDate",
    "comments"
  ],
  "primaryKey": "awardAmountTransactionId"
}

Get Blueprint API specification for Award Amount Transactions
GET`/award/api/v1/award-amount-transactions/`

Example URI

GET /award/api/v1/award-amount-transactions/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Amount Transactions.md"
transfer-encoding: chunked

Update Award Amount Transactions
PUT`/award/api/v1/award-amount-transactions/(key)`

Example URI

PUT /award/api/v1/award-amount-transactions/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardAmountTransactionId": "(val)",
  "awardNumber": "(val)",
  "documentNumber": "(val)",
  "transactionTypeCode": "(val)",
  "noticeDate": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Amount Transactions
PUT`/award/api/v1/award-amount-transactions/`

Example URI

PUT /award/api/v1/award-amount-transactions/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardAmountTransactionId": "(val)",
    "awardNumber": "(val)",
    "documentNumber": "(val)",
    "transactionTypeCode": "(val)",
    "noticeDate": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardAmountTransactionId": "(val)",
    "awardNumber": "(val)",
    "documentNumber": "(val)",
    "transactionTypeCode": "(val)",
    "noticeDate": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Amount Transactions
PATCH`/award/api/v1/award-amount-transactions/(key)`

Example URI

PATCH /award/api/v1/award-amount-transactions/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardAmountTransactionId": "(val)",
  "awardNumber": "(val)",
  "documentNumber": "(val)",
  "transactionTypeCode": "(val)",
  "noticeDate": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardAmountTransactionId": "(val)",
  "awardNumber": "(val)",
  "documentNumber": "(val)",
  "transactionTypeCode": "(val)",
  "noticeDate": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Amount Transactions
POST`/award/api/v1/award-amount-transactions/`

Example URI

POST /award/api/v1/award-amount-transactions/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardAmountTransactionId": "(val)",
  "awardNumber": "(val)",
  "documentNumber": "(val)",
  "transactionTypeCode": "(val)",
  "noticeDate": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardAmountTransactionId": "(val)",
  "awardNumber": "(val)",
  "documentNumber": "(val)",
  "transactionTypeCode": "(val)",
  "noticeDate": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Amount Transactions
POST`/award/api/v1/award-amount-transactions/`

Example URI

POST /award/api/v1/award-amount-transactions/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardAmountTransactionId": "(val)",
    "awardNumber": "(val)",
    "documentNumber": "(val)",
    "transactionTypeCode": "(val)",
    "noticeDate": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardAmountTransactionId": "(val)",
    "awardNumber": "(val)",
    "documentNumber": "(val)",
    "transactionTypeCode": "(val)",
    "noticeDate": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardAmountTransactionId": "(val)",
    "awardNumber": "(val)",
    "documentNumber": "(val)",
    "transactionTypeCode": "(val)",
    "noticeDate": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardAmountTransactionId": "(val)",
    "awardNumber": "(val)",
    "documentNumber": "(val)",
    "transactionTypeCode": "(val)",
    "noticeDate": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Amount Transactions by Key
DELETE`/award/api/v1/award-amount-transactions/(key)`

Example URI

DELETE /award/api/v1/award-amount-transactions/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Amount Transactions
DELETE`/award/api/v1/award-amount-transactions/`

Example URI

DELETE /award/api/v1/award-amount-transactions/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Amount Transactions with Matching
DELETE`/award/api/v1/award-amount-transactions/`

Example URI

DELETE /award/api/v1/award-amount-transactions/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardAmountTransactionId: string (optional)
Award Amount Transaction Id. Maximum length is 22.
awardNumber: string (optional)
Award ID. Maximum length is 12.
documentNumber: string (optional)
Transaction Id. Maximum length is 10.
transactionTypeCode: string (optional)
Transaction Type Code. Maximum length is 22.
noticeDate: string (optional)
Notice Date. Maximum length is 10.
comments: string (optional)
Comments. Maximum length is 2000.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Approved Equipment ¶

Get Award Approved Equipment by Key
GET`/award/api/v1/award-approved-equipment/(key)`

Example URI

GET /award/api/v1/award-approved-equipment/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "approvedEquipmentId": "(val)",
  "item": "(val)",
  "model": "(val)",
  "vendor": "(val)",
  "amount": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Approved Equipment
GET`/award/api/v1/award-approved-equipment/`

Example URI

GET /award/api/v1/award-approved-equipment/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "approvedEquipmentId": "(val)",
    "item": "(val)",
    "model": "(val)",
    "vendor": "(val)",
    "amount": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "approvedEquipmentId": "(val)",
    "item": "(val)",
    "model": "(val)",
    "vendor": "(val)",
    "amount": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Approved Equipment with Filtering
GET`/award/api/v1/award-approved-equipment/`

Example URI

GET /award/api/v1/award-approved-equipment/

URI Parameters

HideShow

approvedEquipmentId: string (optional)
Approved Equipment ID. Maximum length is 8.
item: string (optional)
Item. Maximum length is 100.
model: string (optional)
Model. Maximum length is 50.
vendor: string (optional)
Vendor. Maximum length is 50.
amount: string (optional)
Amount. Maximum length is 15.
awardNumber: string (optional)
Award ID. Maximum length is 12.
sequenceNumber: string (optional)
Sequence Number. Maximum length is 4.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "approvedEquipmentId": "(val)",
    "item": "(val)",
    "model": "(val)",
    "vendor": "(val)",
    "amount": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "approvedEquipmentId": "(val)",
    "item": "(val)",
    "model": "(val)",
    "vendor": "(val)",
    "amount": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Approved Equipment
GET`/award/api/v1/award-approved-equipment/`

Example URI

GET /award/api/v1/award-approved-equipment/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "approvedEquipmentId",
    "item",
    "model",
    "vendor",
    "amount",
    "awardNumber",
    "sequenceNumber"
  ],
  "primaryKey": "approvedEquipmentId"
}

Get Blueprint API specification for Award Approved Equipment
GET`/award/api/v1/award-approved-equipment/`

Example URI

GET /award/api/v1/award-approved-equipment/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Approved Equipment.md"
transfer-encoding: chunked

Award Approved Foreign Travel ¶

Get Award Approved Foreign Travel by Key
GET`/award/api/v1/award-approved-foreign-travel/(key)`

Example URI

GET /award/api/v1/award-approved-foreign-travel/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "approvedForeignTravelId": "(val)",
  "personId": "(val)",
  "rolodexId": "(val)",
  "travelerName": "(val)",
  "destination": "(val)",
  "startDate": "(val)",
  "endDate": "(val)",
  "amount": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Approved Foreign Travel
GET`/award/api/v1/award-approved-foreign-travel/`

Example URI

GET /award/api/v1/award-approved-foreign-travel/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "approvedForeignTravelId": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "travelerName": "(val)",
    "destination": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "amount": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "approvedForeignTravelId": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "travelerName": "(val)",
    "destination": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "amount": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Approved Foreign Travel with Filtering
GET`/award/api/v1/award-approved-foreign-travel/`

Example URI

GET /award/api/v1/award-approved-foreign-travel/

URI Parameters

HideShow

approvedForeignTravelId: string (optional)
Approved Foreign Travel ID. Maximum length is 8.
personId: string (optional)
Person Id. Maximum length is 40.
rolodexId: string (optional)
Rolodex Id. Maximum length is 6.
travelerName: string (optional)
Traveler Name. Maximum length is 90.
destination: string (optional)
Destination. Maximum length is 30.
startDate: string (optional)
Start Date. Maximum length is 10.
endDate: string (optional)
End Date. Maximum length is 10.
amount: string (optional)
Amount. Maximum length is 15.
awardNumber: string (optional)
Award ID. Maximum length is 12.
sequenceNumber: string (optional)
Sequence Number. Maximum length is 4.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "approvedForeignTravelId": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "travelerName": "(val)",
    "destination": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "amount": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "approvedForeignTravelId": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "travelerName": "(val)",
    "destination": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "amount": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Approved Foreign Travel
GET`/award/api/v1/award-approved-foreign-travel/`

Example URI

GET /award/api/v1/award-approved-foreign-travel/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "approvedForeignTravelId",
    "personId",
    "rolodexId",
    "travelerName",
    "destination",
    "startDate",
    "endDate",
    "amount",
    "awardNumber",
    "sequenceNumber"
  ],
  "primaryKey": "approvedForeignTravelId"
}

Get Blueprint API specification for Award Approved Foreign Travel
GET`/award/api/v1/award-approved-foreign-travel/`

Example URI

GET /award/api/v1/award-approved-foreign-travel/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Approved Foreign Travel.md"
transfer-encoding: chunked

Award Approved Sub Awards ¶

Get Award Approved Sub Awards by Key
GET`/award/api/v1/award-approved-sub-awards/(key)`

Example URI

GET /award/api/v1/award-approved-sub-awards/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardApprovedSubawardId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "organizationName": "(val)",
  "organizationId": "(val)",
  "amount": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Approved Sub Awards
GET`/award/api/v1/award-approved-sub-awards/`

Example URI

GET /award/api/v1/award-approved-sub-awards/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardApprovedSubawardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "organizationName": "(val)",
    "organizationId": "(val)",
    "amount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardApprovedSubawardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "organizationName": "(val)",
    "organizationId": "(val)",
    "amount": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Approved Sub Awards with Filtering
GET`/award/api/v1/award-approved-sub-awards/`

Example URI

GET /award/api/v1/award-approved-sub-awards/

URI Parameters

HideShow

awardApprovedSubawardId: string (optional)
Award Approved Subaward ID. Maximum length is 8.
awardNumber: string (optional)
Award ID. Maximum length is 12.
sequenceNumber: string (optional)
Sequence Number. Maximum length is 4.
organizationName: string (optional)
Organization Name. Maximum length is 60.
organizationId: string (optional)
Organization ID. Maximum length is 8.
amount: string (optional)
Amount. Maximum length is 12.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardApprovedSubawardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "organizationName": "(val)",
    "organizationId": "(val)",
    "amount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardApprovedSubawardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "organizationName": "(val)",
    "organizationId": "(val)",
    "amount": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Approved Sub Awards
GET`/award/api/v1/award-approved-sub-awards/`

Example URI

GET /award/api/v1/award-approved-sub-awards/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardApprovedSubawardId",
    "awardNumber",
    "sequenceNumber",
    "organizationName",
    "organizationId",
    "amount"
  ],
  "primaryKey": "awardApprovedSubawardId"
}

Get Blueprint API specification for Award Approved Sub Awards
GET`/award/api/v1/award-approved-sub-awards/`

Example URI

GET /award/api/v1/award-approved-sub-awards/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Approved Sub Awards.md"
transfer-encoding: chunked

Award Attachment Types ¶

Get Award Attachment Types by Key
GET`/award/api/v1/award-attachment-types/(key)`

Example URI

GET /award/api/v1/award-attachment-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "typeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Attachment Types
GET`/award/api/v1/award-attachment-types/`

Example URI

GET /award/api/v1/award-attachment-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "typeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "typeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Attachment Types with Filtering
GET`/award/api/v1/award-attachment-types/`

Example URI

GET /award/api/v1/award-attachment-types/

URI Parameters

HideShow

typeCode: string (optional)
Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "typeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "typeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Attachment Types
GET`/award/api/v1/award-attachment-types/`

Example URI

GET /award/api/v1/award-attachment-types/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "typeCode",
    "description"
  ],
  "primaryKey": "typeCode"
}

Get Blueprint API specification for Award Attachment Types
GET`/award/api/v1/award-attachment-types/`

Example URI

GET /award/api/v1/award-attachment-types/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Attachment Types.md"
transfer-encoding: chunked

Update Award Attachment Types
PUT`/award/api/v1/award-attachment-types/(key)`

Example URI

PUT /award/api/v1/award-attachment-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "typeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Attachment Types
PUT`/award/api/v1/award-attachment-types/`

Example URI

PUT /award/api/v1/award-attachment-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "typeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "typeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Attachment Types
PATCH`/award/api/v1/award-attachment-types/(key)`

Example URI

PATCH /award/api/v1/award-attachment-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "typeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "typeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Attachment Types
POST`/award/api/v1/award-attachment-types/`

Example URI

POST /award/api/v1/award-attachment-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "typeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "typeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Attachment Types
POST`/award/api/v1/award-attachment-types/`

Example URI

POST /award/api/v1/award-attachment-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "typeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "typeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "typeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "typeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Attachment Types by Key
DELETE`/award/api/v1/award-attachment-types/(key)`

Example URI

DELETE /award/api/v1/award-attachment-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Attachment Types
DELETE`/award/api/v1/award-attachment-types/`

Example URI

DELETE /award/api/v1/award-attachment-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Attachment Types with Matching
DELETE`/award/api/v1/award-attachment-types/`

Example URI

DELETE /award/api/v1/award-attachment-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
typeCode: string (optional)
Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Attachments ¶

Get Award Attachments by Key
GET`/award/api/v1/award-attachments/(key)`

Example URI

GET /award/api/v1/award-attachments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardAttachmentId": "(val)",
  "awardId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "typeCode": "(val)",
  "documentId": "(val)",
  "fileId": "(val)",
  "description": "(val)",
  "documentStatusCode": "(val)",
  "lastUpdateTimestamp": "(val)",
  "lastUpdateUser": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Attachments
GET`/award/api/v1/award-attachments/`

Example URI

GET /award/api/v1/award-attachments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardAttachmentId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "typeCode": "(val)",
    "documentId": "(val)",
    "fileId": "(val)",
    "description": "(val)",
    "documentStatusCode": "(val)",
    "lastUpdateTimestamp": "(val)",
    "lastUpdateUser": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardAttachmentId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "typeCode": "(val)",
    "documentId": "(val)",
    "fileId": "(val)",
    "description": "(val)",
    "documentStatusCode": "(val)",
    "lastUpdateTimestamp": "(val)",
    "lastUpdateUser": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Attachments with Filtering
GET`/award/api/v1/award-attachments/`

Example URI

GET /award/api/v1/award-attachments/

URI Parameters

HideShow

awardAttachmentId: string (optional)
Attachment Id. Maximum length is 12.
awardId: string (optional)
awardNumber: string (optional)
sequenceNumber: string (optional)
Sequence Number. Maximum length is 4.
typeCode: string (optional)
Attachment Type. Maximum length is 3.
documentId: string (optional)
Document Id. Maximum length is 4.
fileId: string (optional)
File Name. Maximum length is 12.
description: string (optional)
Description. Maximum length is 200.
documentStatusCode: string (optional)
lastUpdateTimestamp: string (optional)
The creation or last modification timestamp. Maximum length is 21.
lastUpdateUser: string (optional)
The user who created or last modified the object. Maximum length is 60.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardAttachmentId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "typeCode": "(val)",
    "documentId": "(val)",
    "fileId": "(val)",
    "description": "(val)",
    "documentStatusCode": "(val)",
    "lastUpdateTimestamp": "(val)",
    "lastUpdateUser": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardAttachmentId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "typeCode": "(val)",
    "documentId": "(val)",
    "fileId": "(val)",
    "description": "(val)",
    "documentStatusCode": "(val)",
    "lastUpdateTimestamp": "(val)",
    "lastUpdateUser": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Attachments
GET`/award/api/v1/award-attachments/`

Example URI

GET /award/api/v1/award-attachments/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardAttachmentId",
    "awardId",
    "awardNumber",
    "sequenceNumber",
    "typeCode",
    "documentId",
    "fileId",
    "description",
    "documentStatusCode",
    "lastUpdateTimestamp",
    "lastUpdateUser"
  ],
  "primaryKey": "awardAttachmentId"
}

Get Blueprint API specification for Award Attachments
GET`/award/api/v1/award-attachments/`

Example URI

GET /award/api/v1/award-attachments/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Attachments.md"
transfer-encoding: chunked

Update Award Attachments
PUT`/award/api/v1/award-attachments/(key)`

Example URI

PUT /award/api/v1/award-attachments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardAttachmentId": "(val)",
  "awardId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "typeCode": "(val)",
  "documentId": "(val)",
  "fileId": "(val)",
  "description": "(val)",
  "documentStatusCode": "(val)",
  "lastUpdateTimestamp": "(val)",
  "lastUpdateUser": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Attachments
PUT`/award/api/v1/award-attachments/`

Example URI

PUT /award/api/v1/award-attachments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardAttachmentId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "typeCode": "(val)",
    "documentId": "(val)",
    "fileId": "(val)",
    "description": "(val)",
    "documentStatusCode": "(val)",
    "lastUpdateTimestamp": "(val)",
    "lastUpdateUser": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardAttachmentId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "typeCode": "(val)",
    "documentId": "(val)",
    "fileId": "(val)",
    "description": "(val)",
    "documentStatusCode": "(val)",
    "lastUpdateTimestamp": "(val)",
    "lastUpdateUser": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Attachments
PATCH`/award/api/v1/award-attachments/(key)`

Example URI

PATCH /award/api/v1/award-attachments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardAttachmentId": "(val)",
  "awardId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "typeCode": "(val)",
  "documentId": "(val)",
  "fileId": "(val)",
  "description": "(val)",
  "documentStatusCode": "(val)",
  "lastUpdateTimestamp": "(val)",
  "lastUpdateUser": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardAttachmentId": "(val)",
  "awardId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "typeCode": "(val)",
  "documentId": "(val)",
  "fileId": "(val)",
  "description": "(val)",
  "documentStatusCode": "(val)",
  "lastUpdateTimestamp": "(val)",
  "lastUpdateUser": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Attachments
POST`/award/api/v1/award-attachments/`

Example URI

POST /award/api/v1/award-attachments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardAttachmentId": "(val)",
  "awardId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "typeCode": "(val)",
  "documentId": "(val)",
  "fileId": "(val)",
  "description": "(val)",
  "documentStatusCode": "(val)",
  "lastUpdateTimestamp": "(val)",
  "lastUpdateUser": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardAttachmentId": "(val)",
  "awardId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "typeCode": "(val)",
  "documentId": "(val)",
  "fileId": "(val)",
  "description": "(val)",
  "documentStatusCode": "(val)",
  "lastUpdateTimestamp": "(val)",
  "lastUpdateUser": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Attachments
POST`/award/api/v1/award-attachments/`

Example URI

POST /award/api/v1/award-attachments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardAttachmentId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "typeCode": "(val)",
    "documentId": "(val)",
    "fileId": "(val)",
    "description": "(val)",
    "documentStatusCode": "(val)",
    "lastUpdateTimestamp": "(val)",
    "lastUpdateUser": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardAttachmentId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "typeCode": "(val)",
    "documentId": "(val)",
    "fileId": "(val)",
    "description": "(val)",
    "documentStatusCode": "(val)",
    "lastUpdateTimestamp": "(val)",
    "lastUpdateUser": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardAttachmentId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "typeCode": "(val)",
    "documentId": "(val)",
    "fileId": "(val)",
    "description": "(val)",
    "documentStatusCode": "(val)",
    "lastUpdateTimestamp": "(val)",
    "lastUpdateUser": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardAttachmentId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "typeCode": "(val)",
    "documentId": "(val)",
    "fileId": "(val)",
    "description": "(val)",
    "documentStatusCode": "(val)",
    "lastUpdateTimestamp": "(val)",
    "lastUpdateUser": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Attachments by Key
DELETE`/award/api/v1/award-attachments/(key)`

Example URI

DELETE /award/api/v1/award-attachments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Attachments
DELETE`/award/api/v1/award-attachments/`

Example URI

DELETE /award/api/v1/award-attachments/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Attachments with Matching
DELETE`/award/api/v1/award-attachments/`

Example URI

DELETE /award/api/v1/award-attachments/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardAttachmentId: string (optional)
Attachment Id. Maximum length is 12.
awardId: string (optional)
awardNumber: string (optional)
sequenceNumber: string (optional)
Sequence Number. Maximum length is 4.
typeCode: string (optional)
Attachment Type. Maximum length is 3.
documentId: string (optional)
Document Id. Maximum length is 4.
fileId: string (optional)
File Name. Maximum length is 12.
description: string (optional)
Description. Maximum length is 200.
documentStatusCode: string (optional)
lastUpdateTimestamp: string (optional)
The creation or last modification timestamp. Maximum length is 21.
lastUpdateUser: string (optional)
The user who created or last modified the object. Maximum length is 60.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Basis Of Payments ¶

Get Award Basis Of Payments by Key
GET`/award/api/v1/award-basis-of-payments/(key)`

Example URI

GET /award/api/v1/award-basis-of-payments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "basisOfPaymentCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Basis Of Payments
GET`/award/api/v1/award-basis-of-payments/`

Example URI

GET /award/api/v1/award-basis-of-payments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "basisOfPaymentCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "basisOfPaymentCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Basis Of Payments with Filtering
GET`/award/api/v1/award-basis-of-payments/`

Example URI

GET /award/api/v1/award-basis-of-payments/

URI Parameters

HideShow

basisOfPaymentCode: string (optional)
Basis Of Payment Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "basisOfPaymentCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "basisOfPaymentCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Basis Of Payments
GET`/award/api/v1/award-basis-of-payments/`

Example URI

GET /award/api/v1/award-basis-of-payments/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "basisOfPaymentCode",
    "description"
  ],
  "primaryKey": "basisOfPaymentCode"
}

Get Blueprint API specification for Award Basis Of Payments
GET`/award/api/v1/award-basis-of-payments/`

Example URI

GET /award/api/v1/award-basis-of-payments/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Basis Of Payments.md"
transfer-encoding: chunked

Update Award Basis Of Payments
PUT`/award/api/v1/award-basis-of-payments/(key)`

Example URI

PUT /award/api/v1/award-basis-of-payments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "basisOfPaymentCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Basis Of Payments
PUT`/award/api/v1/award-basis-of-payments/`

Example URI

PUT /award/api/v1/award-basis-of-payments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "basisOfPaymentCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "basisOfPaymentCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Basis Of Payments
PATCH`/award/api/v1/award-basis-of-payments/(key)`

Example URI

PATCH /award/api/v1/award-basis-of-payments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "basisOfPaymentCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "basisOfPaymentCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Basis Of Payments
POST`/award/api/v1/award-basis-of-payments/`

Example URI

POST /award/api/v1/award-basis-of-payments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "basisOfPaymentCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "basisOfPaymentCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Basis Of Payments
POST`/award/api/v1/award-basis-of-payments/`

Example URI

POST /award/api/v1/award-basis-of-payments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "basisOfPaymentCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "basisOfPaymentCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "basisOfPaymentCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "basisOfPaymentCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Basis Of Payments by Key
DELETE`/award/api/v1/award-basis-of-payments/(key)`

Example URI

DELETE /award/api/v1/award-basis-of-payments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Basis Of Payments
DELETE`/award/api/v1/award-basis-of-payments/`

Example URI

DELETE /award/api/v1/award-basis-of-payments/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Basis Of Payments with Matching
DELETE`/award/api/v1/award-basis-of-payments/`

Example URI

DELETE /award/api/v1/award-basis-of-payments/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
basisOfPaymentCode: string (optional)
Basis Of Payment Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Budget Limits ¶

Get Award Budget Limits by Key
GET`/award/api/v1/award-budget-limits/(key)`

Example URI

GET /award/api/v1/award-budget-limits/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "budgetLimitId": "(val)",
  "budgetId": "(val)",
  "limitTypeCode": "(val)",
  "limit": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Budget Limits
GET`/award/api/v1/award-budget-limits/`

Example URI

GET /award/api/v1/award-budget-limits/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "budgetLimitId": "(val)",
    "budgetId": "(val)",
    "limitTypeCode": "(val)",
    "limit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetLimitId": "(val)",
    "budgetId": "(val)",
    "limitTypeCode": "(val)",
    "limit": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Budget Limits with Filtering
GET`/award/api/v1/award-budget-limits/`

Example URI

GET /award/api/v1/award-budget-limits/

URI Parameters

HideShow

budgetLimitId: string (optional)
Award Budget Limit Id. Maximum length is 22.
budgetId: string (optional)
limitTypeCode: string (optional)
Budget Limit Type Code. Maximum length is 100.
limit: string (optional)
Budget Limit. Maximum length is 15.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "budgetLimitId": "(val)",
    "budgetId": "(val)",
    "limitTypeCode": "(val)",
    "limit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetLimitId": "(val)",
    "budgetId": "(val)",
    "limitTypeCode": "(val)",
    "limit": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Budget Limits
GET`/award/api/v1/award-budget-limits/`

Example URI

GET /award/api/v1/award-budget-limits/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "budgetLimitId",
    "budgetId",
    "limitTypeCode",
    "limit"
  ],
  "primaryKey": "budgetLimitId"
}

Get Blueprint API specification for Award Budget Limits
GET`/award/api/v1/award-budget-limits/`

Example URI

GET /award/api/v1/award-budget-limits/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Budget Limits.md"
transfer-encoding: chunked

Award Budget Line Item Calculated Amounts ¶

Get Award Budget Line Item Calculated Amounts by Key
GET`/award/api/v1/award-budget-line-item-calculated-amounts/(key)`

Example URI

GET /award/api/v1/award-budget-line-item-calculated-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "budgetLineItemCalculatedAmountId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Budget Line Item Calculated Amounts
GET`/award/api/v1/award-budget-line-item-calculated-amounts/`

Example URI

GET /award/api/v1/award-budget-line-item-calculated-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "budgetLineItemCalculatedAmountId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetLineItemCalculatedAmountId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Budget Line Item Calculated Amounts with Filtering
GET`/award/api/v1/award-budget-line-item-calculated-amounts/`

Example URI

GET /award/api/v1/award-budget-line-item-calculated-amounts/

URI Parameters

HideShow

budgetLineItemCalculatedAmountId: string (optional)
Budget Id. Maximum length is 22.
obligatedAmount: string (optional)
Obligated amount from award amount info. Maximum length is 15.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "budgetLineItemCalculatedAmountId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetLineItemCalculatedAmountId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Budget Line Item Calculated Amounts
GET`/award/api/v1/award-budget-line-item-calculated-amounts/`

Example URI

GET /award/api/v1/award-budget-line-item-calculated-amounts/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "budgetLineItemCalculatedAmountId",
    "obligatedAmount"
  ],
  "primaryKey": "budgetLineItemCalculatedAmountId"
}

Get Blueprint API specification for Award Budget Line Item Calculated Amounts
GET`/award/api/v1/award-budget-line-item-calculated-amounts/`

Example URI

GET /award/api/v1/award-budget-line-item-calculated-amounts/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Budget Line Item Calculated Amounts.md"
transfer-encoding: chunked

Update Award Budget Line Item Calculated Amounts
PUT`/award/api/v1/award-budget-line-item-calculated-amounts/(key)`

Example URI

PUT /award/api/v1/award-budget-line-item-calculated-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "budgetLineItemCalculatedAmountId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Budget Line Item Calculated Amounts
PUT`/award/api/v1/award-budget-line-item-calculated-amounts/`

Example URI

PUT /award/api/v1/award-budget-line-item-calculated-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "budgetLineItemCalculatedAmountId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetLineItemCalculatedAmountId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Budget Line Item Calculated Amounts
PATCH`/award/api/v1/award-budget-line-item-calculated-amounts/(key)`

Example URI

PATCH /award/api/v1/award-budget-line-item-calculated-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "budgetLineItemCalculatedAmountId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "budgetLineItemCalculatedAmountId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Budget Line Item Calculated Amounts
POST`/award/api/v1/award-budget-line-item-calculated-amounts/`

Example URI

POST /award/api/v1/award-budget-line-item-calculated-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "budgetLineItemCalculatedAmountId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "budgetLineItemCalculatedAmountId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Budget Line Item Calculated Amounts
POST`/award/api/v1/award-budget-line-item-calculated-amounts/`

Example URI

POST /award/api/v1/award-budget-line-item-calculated-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "budgetLineItemCalculatedAmountId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetLineItemCalculatedAmountId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "budgetLineItemCalculatedAmountId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetLineItemCalculatedAmountId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Budget Line Item Calculated Amounts by Key
DELETE`/award/api/v1/award-budget-line-item-calculated-amounts/(key)`

Example URI

DELETE /award/api/v1/award-budget-line-item-calculated-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Budget Line Item Calculated Amounts
DELETE`/award/api/v1/award-budget-line-item-calculated-amounts/`

Example URI

DELETE /award/api/v1/award-budget-line-item-calculated-amounts/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Budget Line Item Calculated Amounts with Matching
DELETE`/award/api/v1/award-budget-line-item-calculated-amounts/`

Example URI

DELETE /award/api/v1/award-budget-line-item-calculated-amounts/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
budgetLineItemCalculatedAmountId: string (optional)
Budget Id. Maximum length is 22.
obligatedAmount: string (optional)
Obligated amount from award amount info. Maximum length is 15.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Budget Line Items ¶

Get Award Budget Line Items by Key
GET`/award/api/v1/award-budget-line-items/(key)`

Example URI

GET /award/api/v1/award-budget-line-items/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "budgetLineItemId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Budget Line Items
GET`/award/api/v1/award-budget-line-items/`

Example URI

GET /award/api/v1/award-budget-line-items/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "budgetLineItemId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetLineItemId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Budget Line Items with Filtering
GET`/award/api/v1/award-budget-line-items/`

Example URI

GET /award/api/v1/award-budget-line-items/

URI Parameters

HideShow

budgetLineItemId: string (optional)
Budget Line Item Id. Maximum length is 22.
obligatedAmount: string (optional)
Obligated amount from award amount info. Maximum length is 15.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "budgetLineItemId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetLineItemId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Budget Line Items
GET`/award/api/v1/award-budget-line-items/`

Example URI

GET /award/api/v1/award-budget-line-items/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "budgetLineItemId",
    "obligatedAmount"
  ],
  "primaryKey": "budgetLineItemId"
}

Get Blueprint API specification for Award Budget Line Items
GET`/award/api/v1/award-budget-line-items/`

Example URI

GET /award/api/v1/award-budget-line-items/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Budget Line Items.md"
transfer-encoding: chunked

Update Award Budget Line Items
PUT`/award/api/v1/award-budget-line-items/(key)`

Example URI

PUT /award/api/v1/award-budget-line-items/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "budgetLineItemId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Budget Line Items
PUT`/award/api/v1/award-budget-line-items/`

Example URI

PUT /award/api/v1/award-budget-line-items/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "budgetLineItemId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetLineItemId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Budget Line Items
PATCH`/award/api/v1/award-budget-line-items/(key)`

Example URI

PATCH /award/api/v1/award-budget-line-items/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "budgetLineItemId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "budgetLineItemId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Budget Line Items
POST`/award/api/v1/award-budget-line-items/`

Example URI

POST /award/api/v1/award-budget-line-items/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "budgetLineItemId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "budgetLineItemId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Budget Line Items
POST`/award/api/v1/award-budget-line-items/`

Example URI

POST /award/api/v1/award-budget-line-items/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "budgetLineItemId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetLineItemId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "budgetLineItemId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetLineItemId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Budget Line Items by Key
DELETE`/award/api/v1/award-budget-line-items/(key)`

Example URI

DELETE /award/api/v1/award-budget-line-items/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Budget Line Items
DELETE`/award/api/v1/award-budget-line-items/`

Example URI

DELETE /award/api/v1/award-budget-line-items/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Budget Line Items with Matching
DELETE`/award/api/v1/award-budget-line-items/`

Example URI

DELETE /award/api/v1/award-budget-line-items/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
budgetLineItemId: string (optional)
Budget Line Item Id. Maximum length is 22.
obligatedAmount: string (optional)
Obligated amount from award amount info. Maximum length is 15.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Budget Period Summary Calculated Amounts ¶

Get Award Budget Period Summary Calculated Amounts by Key
GET`/award/api/v1/award-budget-period-summary-calculated-amounts/(key)`

Example URI

GET /award/api/v1/award-budget-period-summary-calculated-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardBudgetPeriodSummaryCalculatedAmountId": "(val)",
  "budgetPeriodId": "(val)",
  "costElement": "(val)",
  "onOffCampusFlag": "(val)",
  "rateClassType": "(val)",
  "calculatedCost": "(val)",
  "calculatedCostSharing": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Budget Period Summary Calculated Amounts
GET`/award/api/v1/award-budget-period-summary-calculated-amounts/`

Example URI

GET /award/api/v1/award-budget-period-summary-calculated-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardBudgetPeriodSummaryCalculatedAmountId": "(val)",
    "budgetPeriodId": "(val)",
    "costElement": "(val)",
    "onOffCampusFlag": "(val)",
    "rateClassType": "(val)",
    "calculatedCost": "(val)",
    "calculatedCostSharing": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardBudgetPeriodSummaryCalculatedAmountId": "(val)",
    "budgetPeriodId": "(val)",
    "costElement": "(val)",
    "onOffCampusFlag": "(val)",
    "rateClassType": "(val)",
    "calculatedCost": "(val)",
    "calculatedCostSharing": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Budget Period Summary Calculated Amounts with Filtering
GET`/award/api/v1/award-budget-period-summary-calculated-amounts/`

Example URI

GET /award/api/v1/award-budget-period-summary-calculated-amounts/

URI Parameters

HideShow

awardBudgetPeriodSummaryCalculatedAmountId: string (optional)
Awd Bgt Per Sum Calc Amt Id. Maximum length is 22.
budgetPeriodId: string (optional)
Budget Period Id. Maximum length is 22.
costElement: string (optional)
Cost Element. Maximum length is 8.
onOffCampusFlag: string (optional)
On Off CampusContractContract Flag. Maximum length is 1.
rateClassType: string (optional)
Rate Class Type. Maximum length is 1.
calculatedCost: string (optional)
Calculated Cost. Maximum length is 22.
calculatedCostSharing: string (optional)
Calculated Cost Sharing. Maximum length is 22.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardBudgetPeriodSummaryCalculatedAmountId": "(val)",
    "budgetPeriodId": "(val)",
    "costElement": "(val)",
    "onOffCampusFlag": "(val)",
    "rateClassType": "(val)",
    "calculatedCost": "(val)",
    "calculatedCostSharing": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardBudgetPeriodSummaryCalculatedAmountId": "(val)",
    "budgetPeriodId": "(val)",
    "costElement": "(val)",
    "onOffCampusFlag": "(val)",
    "rateClassType": "(val)",
    "calculatedCost": "(val)",
    "calculatedCostSharing": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Budget Period Summary Calculated Amounts
GET`/award/api/v1/award-budget-period-summary-calculated-amounts/`

Example URI

GET /award/api/v1/award-budget-period-summary-calculated-amounts/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardBudgetPeriodSummaryCalculatedAmountId",
    "budgetPeriodId",
    "costElement",
    "onOffCampusFlag",
    "rateClassType",
    "calculatedCost",
    "calculatedCostSharing"
  ],
  "primaryKey": "awardBudgetPeriodSummaryCalculatedAmountId"
}

Get Blueprint API specification for Award Budget Period Summary Calculated Amounts
GET`/award/api/v1/award-budget-period-summary-calculated-amounts/`

Example URI

GET /award/api/v1/award-budget-period-summary-calculated-amounts/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Budget Period Summary Calculated Amounts.md"
transfer-encoding: chunked

Update Award Budget Period Summary Calculated Amounts
PUT`/award/api/v1/award-budget-period-summary-calculated-amounts/(key)`

Example URI

PUT /award/api/v1/award-budget-period-summary-calculated-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardBudgetPeriodSummaryCalculatedAmountId": "(val)",
  "budgetPeriodId": "(val)",
  "costElement": "(val)",
  "onOffCampusFlag": "(val)",
  "rateClassType": "(val)",
  "calculatedCost": "(val)",
  "calculatedCostSharing": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Budget Period Summary Calculated Amounts
PUT`/award/api/v1/award-budget-period-summary-calculated-amounts/`

Example URI

PUT /award/api/v1/award-budget-period-summary-calculated-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardBudgetPeriodSummaryCalculatedAmountId": "(val)",
    "budgetPeriodId": "(val)",
    "costElement": "(val)",
    "onOffCampusFlag": "(val)",
    "rateClassType": "(val)",
    "calculatedCost": "(val)",
    "calculatedCostSharing": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardBudgetPeriodSummaryCalculatedAmountId": "(val)",
    "budgetPeriodId": "(val)",
    "costElement": "(val)",
    "onOffCampusFlag": "(val)",
    "rateClassType": "(val)",
    "calculatedCost": "(val)",
    "calculatedCostSharing": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Budget Period Summary Calculated Amounts
PATCH`/award/api/v1/award-budget-period-summary-calculated-amounts/(key)`

Example URI

PATCH /award/api/v1/award-budget-period-summary-calculated-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardBudgetPeriodSummaryCalculatedAmountId": "(val)",
  "budgetPeriodId": "(val)",
  "costElement": "(val)",
  "onOffCampusFlag": "(val)",
  "rateClassType": "(val)",
  "calculatedCost": "(val)",
  "calculatedCostSharing": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardBudgetPeriodSummaryCalculatedAmountId": "(val)",
  "budgetPeriodId": "(val)",
  "costElement": "(val)",
  "onOffCampusFlag": "(val)",
  "rateClassType": "(val)",
  "calculatedCost": "(val)",
  "calculatedCostSharing": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Budget Period Summary Calculated Amounts
POST`/award/api/v1/award-budget-period-summary-calculated-amounts/`

Example URI

POST /award/api/v1/award-budget-period-summary-calculated-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardBudgetPeriodSummaryCalculatedAmountId": "(val)",
  "budgetPeriodId": "(val)",
  "costElement": "(val)",
  "onOffCampusFlag": "(val)",
  "rateClassType": "(val)",
  "calculatedCost": "(val)",
  "calculatedCostSharing": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardBudgetPeriodSummaryCalculatedAmountId": "(val)",
  "budgetPeriodId": "(val)",
  "costElement": "(val)",
  "onOffCampusFlag": "(val)",
  "rateClassType": "(val)",
  "calculatedCost": "(val)",
  "calculatedCostSharing": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Budget Period Summary Calculated Amounts
POST`/award/api/v1/award-budget-period-summary-calculated-amounts/`

Example URI

POST /award/api/v1/award-budget-period-summary-calculated-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardBudgetPeriodSummaryCalculatedAmountId": "(val)",
    "budgetPeriodId": "(val)",
    "costElement": "(val)",
    "onOffCampusFlag": "(val)",
    "rateClassType": "(val)",
    "calculatedCost": "(val)",
    "calculatedCostSharing": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardBudgetPeriodSummaryCalculatedAmountId": "(val)",
    "budgetPeriodId": "(val)",
    "costElement": "(val)",
    "onOffCampusFlag": "(val)",
    "rateClassType": "(val)",
    "calculatedCost": "(val)",
    "calculatedCostSharing": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardBudgetPeriodSummaryCalculatedAmountId": "(val)",
    "budgetPeriodId": "(val)",
    "costElement": "(val)",
    "onOffCampusFlag": "(val)",
    "rateClassType": "(val)",
    "calculatedCost": "(val)",
    "calculatedCostSharing": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardBudgetPeriodSummaryCalculatedAmountId": "(val)",
    "budgetPeriodId": "(val)",
    "costElement": "(val)",
    "onOffCampusFlag": "(val)",
    "rateClassType": "(val)",
    "calculatedCost": "(val)",
    "calculatedCostSharing": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Budget Period Summary Calculated Amounts by Key
DELETE`/award/api/v1/award-budget-period-summary-calculated-amounts/(key)`

Example URI

DELETE /award/api/v1/award-budget-period-summary-calculated-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Budget Period Summary Calculated Amounts
DELETE`/award/api/v1/award-budget-period-summary-calculated-amounts/`

Example URI

DELETE /award/api/v1/award-budget-period-summary-calculated-amounts/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Budget Period Summary Calculated Amounts with Matching
DELETE`/award/api/v1/award-budget-period-summary-calculated-amounts/`

Example URI

DELETE /award/api/v1/award-budget-period-summary-calculated-amounts/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardBudgetPeriodSummaryCalculatedAmountId: string (optional)
Awd Bgt Per Sum Calc Amt Id. Maximum length is 22.
budgetPeriodId: string (optional)
Budget Period Id. Maximum length is 22.
costElement: string (optional)
Cost Element. Maximum length is 8.
onOffCampusFlag: string (optional)
On Off CampusContractContract Flag. Maximum length is 1.
rateClassType: string (optional)
Rate Class Type. Maximum length is 1.
calculatedCost: string (optional)
Calculated Cost. Maximum length is 22.
calculatedCostSharing: string (optional)
Calculated Cost Sharing. Maximum length is 22.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Budget Periods ¶

Get Award Budget Periods by Key
GET`/award/api/v1/award-budget-periods/(key)`

Example URI

GET /award/api/v1/award-budget-periods/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "budgetPeriodId": "(val)",
  "obligatedAmount": "(val)",
  "totalFringeAmount": "(val)",
  "fringeOverridden": "(val)",
  "fAndAOverridden": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Budget Periods
GET`/award/api/v1/award-budget-periods/`

Example URI

GET /award/api/v1/award-budget-periods/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "budgetPeriodId": "(val)",
    "obligatedAmount": "(val)",
    "totalFringeAmount": "(val)",
    "fringeOverridden": "(val)",
    "fAndAOverridden": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetPeriodId": "(val)",
    "obligatedAmount": "(val)",
    "totalFringeAmount": "(val)",
    "fringeOverridden": "(val)",
    "fAndAOverridden": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Budget Periods with Filtering
GET`/award/api/v1/award-budget-periods/`

Example URI

GET /award/api/v1/award-budget-periods/

URI Parameters

HideShow

budgetPeriodId: string (optional)
obligatedAmount: string (optional)
Obligated amount from award amount info. Maximum length is 15.
totalFringeAmount: string (optional)
Total Fringe amount from award amount info. Maximum length is 15.
fringeOverridden: string (optional)
fAndAOverridden: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "budgetPeriodId": "(val)",
    "obligatedAmount": "(val)",
    "totalFringeAmount": "(val)",
    "fringeOverridden": "(val)",
    "fAndAOverridden": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetPeriodId": "(val)",
    "obligatedAmount": "(val)",
    "totalFringeAmount": "(val)",
    "fringeOverridden": "(val)",
    "fAndAOverridden": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Budget Periods
GET`/award/api/v1/award-budget-periods/`

Example URI

GET /award/api/v1/award-budget-periods/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "budgetPeriodId",
    "obligatedAmount",
    "totalFringeAmount",
    "fringeOverridden",
    "fAndAOverridden"
  ],
  "primaryKey": "budgetPeriodId"
}

Get Blueprint API specification for Award Budget Periods
GET`/award/api/v1/award-budget-periods/`

Example URI

GET /award/api/v1/award-budget-periods/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Budget Periods.md"
transfer-encoding: chunked

Update Award Budget Periods
PUT`/award/api/v1/award-budget-periods/(key)`

Example URI

PUT /award/api/v1/award-budget-periods/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "budgetPeriodId": "(val)",
  "obligatedAmount": "(val)",
  "totalFringeAmount": "(val)",
  "fringeOverridden": "(val)",
  "fAndAOverridden": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Budget Periods
PUT`/award/api/v1/award-budget-periods/`

Example URI

PUT /award/api/v1/award-budget-periods/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "budgetPeriodId": "(val)",
    "obligatedAmount": "(val)",
    "totalFringeAmount": "(val)",
    "fringeOverridden": "(val)",
    "fAndAOverridden": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetPeriodId": "(val)",
    "obligatedAmount": "(val)",
    "totalFringeAmount": "(val)",
    "fringeOverridden": "(val)",
    "fAndAOverridden": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Budget Periods
PATCH`/award/api/v1/award-budget-periods/(key)`

Example URI

PATCH /award/api/v1/award-budget-periods/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "budgetPeriodId": "(val)",
  "obligatedAmount": "(val)",
  "totalFringeAmount": "(val)",
  "fringeOverridden": "(val)",
  "fAndAOverridden": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "budgetPeriodId": "(val)",
  "obligatedAmount": "(val)",
  "totalFringeAmount": "(val)",
  "fringeOverridden": "(val)",
  "fAndAOverridden": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Budget Periods
POST`/award/api/v1/award-budget-periods/`

Example URI

POST /award/api/v1/award-budget-periods/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "budgetPeriodId": "(val)",
  "obligatedAmount": "(val)",
  "totalFringeAmount": "(val)",
  "fringeOverridden": "(val)",
  "fAndAOverridden": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "budgetPeriodId": "(val)",
  "obligatedAmount": "(val)",
  "totalFringeAmount": "(val)",
  "fringeOverridden": "(val)",
  "fAndAOverridden": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Budget Periods
POST`/award/api/v1/award-budget-periods/`

Example URI

POST /award/api/v1/award-budget-periods/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "budgetPeriodId": "(val)",
    "obligatedAmount": "(val)",
    "totalFringeAmount": "(val)",
    "fringeOverridden": "(val)",
    "fAndAOverridden": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetPeriodId": "(val)",
    "obligatedAmount": "(val)",
    "totalFringeAmount": "(val)",
    "fringeOverridden": "(val)",
    "fAndAOverridden": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "budgetPeriodId": "(val)",
    "obligatedAmount": "(val)",
    "totalFringeAmount": "(val)",
    "fringeOverridden": "(val)",
    "fAndAOverridden": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetPeriodId": "(val)",
    "obligatedAmount": "(val)",
    "totalFringeAmount": "(val)",
    "fringeOverridden": "(val)",
    "fAndAOverridden": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Budget Periods by Key
DELETE`/award/api/v1/award-budget-periods/(key)`

Example URI

DELETE /award/api/v1/award-budget-periods/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Budget Periods
DELETE`/award/api/v1/award-budget-periods/`

Example URI

DELETE /award/api/v1/award-budget-periods/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Budget Periods with Matching
DELETE`/award/api/v1/award-budget-periods/`

Example URI

DELETE /award/api/v1/award-budget-periods/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
budgetPeriodId: string (optional)
obligatedAmount: string (optional)
Obligated amount from award amount info. Maximum length is 15.
totalFringeAmount: string (optional)
Total Fringe amount from award amount info. Maximum length is 15.
fringeOverridden: string (optional)
fAndAOverridden: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Budget Personnel Calculated Amounts ¶

Get Award Budget Personnel Calculated Amounts by Key
GET`/award/api/v1/award-budget-personnel-calculated-amounts/(key)`

Example URI

GET /award/api/v1/award-budget-personnel-calculated-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "budgetPersonnelCalculatedAmountId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Budget Personnel Calculated Amounts
GET`/award/api/v1/award-budget-personnel-calculated-amounts/`

Example URI

GET /award/api/v1/award-budget-personnel-calculated-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "budgetPersonnelCalculatedAmountId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetPersonnelCalculatedAmountId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Budget Personnel Calculated Amounts with Filtering
GET`/award/api/v1/award-budget-personnel-calculated-amounts/`

Example URI

GET /award/api/v1/award-budget-personnel-calculated-amounts/

URI Parameters

HideShow

budgetPersonnelCalculatedAmountId: string (optional)
Budget Id. Maximum length is 22.
obligatedAmount: string (optional)
Obligated amount from award amount info. Maximum length is 15.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "budgetPersonnelCalculatedAmountId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetPersonnelCalculatedAmountId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Budget Personnel Calculated Amounts
GET`/award/api/v1/award-budget-personnel-calculated-amounts/`

Example URI

GET /award/api/v1/award-budget-personnel-calculated-amounts/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "budgetPersonnelCalculatedAmountId",
    "obligatedAmount"
  ],
  "primaryKey": "budgetPersonnelCalculatedAmountId"
}

Get Blueprint API specification for Award Budget Personnel Calculated Amounts
GET`/award/api/v1/award-budget-personnel-calculated-amounts/`

Example URI

GET /award/api/v1/award-budget-personnel-calculated-amounts/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Budget Personnel Calculated Amounts.md"
transfer-encoding: chunked

Update Award Budget Personnel Calculated Amounts
PUT`/award/api/v1/award-budget-personnel-calculated-amounts/(key)`

Example URI

PUT /award/api/v1/award-budget-personnel-calculated-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "budgetPersonnelCalculatedAmountId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Budget Personnel Calculated Amounts
PUT`/award/api/v1/award-budget-personnel-calculated-amounts/`

Example URI

PUT /award/api/v1/award-budget-personnel-calculated-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "budgetPersonnelCalculatedAmountId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetPersonnelCalculatedAmountId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Budget Personnel Calculated Amounts
PATCH`/award/api/v1/award-budget-personnel-calculated-amounts/(key)`

Example URI

PATCH /award/api/v1/award-budget-personnel-calculated-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "budgetPersonnelCalculatedAmountId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "budgetPersonnelCalculatedAmountId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Budget Personnel Calculated Amounts
POST`/award/api/v1/award-budget-personnel-calculated-amounts/`

Example URI

POST /award/api/v1/award-budget-personnel-calculated-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "budgetPersonnelCalculatedAmountId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "budgetPersonnelCalculatedAmountId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Budget Personnel Calculated Amounts
POST`/award/api/v1/award-budget-personnel-calculated-amounts/`

Example URI

POST /award/api/v1/award-budget-personnel-calculated-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "budgetPersonnelCalculatedAmountId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetPersonnelCalculatedAmountId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "budgetPersonnelCalculatedAmountId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetPersonnelCalculatedAmountId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Budget Personnel Calculated Amounts by Key
DELETE`/award/api/v1/award-budget-personnel-calculated-amounts/(key)`

Example URI

DELETE /award/api/v1/award-budget-personnel-calculated-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Budget Personnel Calculated Amounts
DELETE`/award/api/v1/award-budget-personnel-calculated-amounts/`

Example URI

DELETE /award/api/v1/award-budget-personnel-calculated-amounts/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Budget Personnel Calculated Amounts with Matching
DELETE`/award/api/v1/award-budget-personnel-calculated-amounts/`

Example URI

DELETE /award/api/v1/award-budget-personnel-calculated-amounts/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
budgetPersonnelCalculatedAmountId: string (optional)
Budget Id. Maximum length is 22.
obligatedAmount: string (optional)
Obligated amount from award amount info. Maximum length is 15.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Budget Personnel Details ¶

Get Award Budget Personnel Details by Key
GET`/award/api/v1/award-budget-personnel-details/(key)`

Example URI

GET /award/api/v1/award-budget-personnel-details/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "budgetPersonnelLineItemId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Budget Personnel Details
GET`/award/api/v1/award-budget-personnel-details/`

Example URI

GET /award/api/v1/award-budget-personnel-details/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "budgetPersonnelLineItemId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetPersonnelLineItemId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Budget Personnel Details with Filtering
GET`/award/api/v1/award-budget-personnel-details/`

Example URI

GET /award/api/v1/award-budget-personnel-details/

URI Parameters

HideShow

budgetPersonnelLineItemId: string (optional)
Budget Id. Maximum length is 22.
obligatedAmount: string (optional)
Obligated amount from award amount info. Maximum length is 15.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "budgetPersonnelLineItemId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetPersonnelLineItemId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Budget Personnel Details
GET`/award/api/v1/award-budget-personnel-details/`

Example URI

GET /award/api/v1/award-budget-personnel-details/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "budgetPersonnelLineItemId",
    "obligatedAmount"
  ],
  "primaryKey": "budgetPersonnelLineItemId"
}

Get Blueprint API specification for Award Budget Personnel Details
GET`/award/api/v1/award-budget-personnel-details/`

Example URI

GET /award/api/v1/award-budget-personnel-details/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Budget Personnel Details.md"
transfer-encoding: chunked

Update Award Budget Personnel Details
PUT`/award/api/v1/award-budget-personnel-details/(key)`

Example URI

PUT /award/api/v1/award-budget-personnel-details/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "budgetPersonnelLineItemId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Budget Personnel Details
PUT`/award/api/v1/award-budget-personnel-details/`

Example URI

PUT /award/api/v1/award-budget-personnel-details/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "budgetPersonnelLineItemId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetPersonnelLineItemId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Budget Personnel Details
PATCH`/award/api/v1/award-budget-personnel-details/(key)`

Example URI

PATCH /award/api/v1/award-budget-personnel-details/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "budgetPersonnelLineItemId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "budgetPersonnelLineItemId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Budget Personnel Details
POST`/award/api/v1/award-budget-personnel-details/`

Example URI

POST /award/api/v1/award-budget-personnel-details/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "budgetPersonnelLineItemId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "budgetPersonnelLineItemId": "(val)",
  "obligatedAmount": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Budget Personnel Details
POST`/award/api/v1/award-budget-personnel-details/`

Example URI

POST /award/api/v1/award-budget-personnel-details/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "budgetPersonnelLineItemId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetPersonnelLineItemId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "budgetPersonnelLineItemId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetPersonnelLineItemId": "(val)",
    "obligatedAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Budget Personnel Details by Key
DELETE`/award/api/v1/award-budget-personnel-details/(key)`

Example URI

DELETE /award/api/v1/award-budget-personnel-details/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Budget Personnel Details
DELETE`/award/api/v1/award-budget-personnel-details/`

Example URI

DELETE /award/api/v1/award-budget-personnel-details/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Budget Personnel Details with Matching
DELETE`/award/api/v1/award-budget-personnel-details/`

Example URI

DELETE /award/api/v1/award-budget-personnel-details/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
budgetPersonnelLineItemId: string (optional)
Budget Id. Maximum length is 22.
obligatedAmount: string (optional)
Obligated amount from award amount info. Maximum length is 15.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Budget Statuses ¶

Get Award Budget Statuses by Key
GET`/award/api/v1/award-budget-statuses/(key)`

Example URI

GET /award/api/v1/award-budget-statuses/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardBudgetStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Budget Statuses
GET`/award/api/v1/award-budget-statuses/`

Example URI

GET /award/api/v1/award-budget-statuses/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardBudgetStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardBudgetStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Budget Statuses with Filtering
GET`/award/api/v1/award-budget-statuses/`

Example URI

GET /award/api/v1/award-budget-statuses/

URI Parameters

HideShow

awardBudgetStatusCode: string (optional)
Award Budget Status Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardBudgetStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardBudgetStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Budget Statuses
GET`/award/api/v1/award-budget-statuses/`

Example URI

GET /award/api/v1/award-budget-statuses/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardBudgetStatusCode",
    "description"
  ],
  "primaryKey": "awardBudgetStatusCode"
}

Get Blueprint API specification for Award Budget Statuses
GET`/award/api/v1/award-budget-statuses/`

Example URI

GET /award/api/v1/award-budget-statuses/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Budget Statuses.md"
transfer-encoding: chunked

Update Award Budget Statuses
PUT`/award/api/v1/award-budget-statuses/(key)`

Example URI

PUT /award/api/v1/award-budget-statuses/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardBudgetStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Budget Statuses
PUT`/award/api/v1/award-budget-statuses/`

Example URI

PUT /award/api/v1/award-budget-statuses/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardBudgetStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardBudgetStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Budget Statuses
PATCH`/award/api/v1/award-budget-statuses/(key)`

Example URI

PATCH /award/api/v1/award-budget-statuses/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardBudgetStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardBudgetStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Budget Statuses
POST`/award/api/v1/award-budget-statuses/`

Example URI

POST /award/api/v1/award-budget-statuses/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardBudgetStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardBudgetStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Budget Statuses
POST`/award/api/v1/award-budget-statuses/`

Example URI

POST /award/api/v1/award-budget-statuses/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardBudgetStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardBudgetStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardBudgetStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardBudgetStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Budget Statuses by Key
DELETE`/award/api/v1/award-budget-statuses/(key)`

Example URI

DELETE /award/api/v1/award-budget-statuses/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Budget Statuses
DELETE`/award/api/v1/award-budget-statuses/`

Example URI

DELETE /award/api/v1/award-budget-statuses/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Budget Statuses with Matching
DELETE`/award/api/v1/award-budget-statuses/`

Example URI

DELETE /award/api/v1/award-budget-statuses/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardBudgetStatusCode: string (optional)
Award Budget Status Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Budget Types ¶

Get Award Budget Types by Key
GET`/award/api/v1/award-budget-types/(key)`

Example URI

GET /award/api/v1/award-budget-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardBudgetTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Budget Types
GET`/award/api/v1/award-budget-types/`

Example URI

GET /award/api/v1/award-budget-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardBudgetTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardBudgetTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Budget Types with Filtering
GET`/award/api/v1/award-budget-types/`

Example URI

GET /award/api/v1/award-budget-types/

URI Parameters

HideShow

awardBudgetTypeCode: string (optional)
Award Budget Type Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardBudgetTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardBudgetTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Budget Types
GET`/award/api/v1/award-budget-types/`

Example URI

GET /award/api/v1/award-budget-types/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardBudgetTypeCode",
    "description"
  ],
  "primaryKey": "awardBudgetTypeCode"
}

Get Blueprint API specification for Award Budget Types
GET`/award/api/v1/award-budget-types/`

Example URI

GET /award/api/v1/award-budget-types/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Budget Types.md"
transfer-encoding: chunked

Update Award Budget Types
PUT`/award/api/v1/award-budget-types/(key)`

Example URI

PUT /award/api/v1/award-budget-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardBudgetTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Budget Types
PUT`/award/api/v1/award-budget-types/`

Example URI

PUT /award/api/v1/award-budget-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardBudgetTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardBudgetTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Budget Types
PATCH`/award/api/v1/award-budget-types/(key)`

Example URI

PATCH /award/api/v1/award-budget-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardBudgetTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardBudgetTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Budget Types
POST`/award/api/v1/award-budget-types/`

Example URI

POST /award/api/v1/award-budget-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardBudgetTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardBudgetTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Budget Types
POST`/award/api/v1/award-budget-types/`

Example URI

POST /award/api/v1/award-budget-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardBudgetTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardBudgetTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardBudgetTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardBudgetTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Budget Types by Key
DELETE`/award/api/v1/award-budget-types/(key)`

Example URI

DELETE /award/api/v1/award-budget-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Budget Types
DELETE`/award/api/v1/award-budget-types/`

Example URI

DELETE /award/api/v1/award-budget-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Budget Types with Matching
DELETE`/award/api/v1/award-budget-types/`

Example URI

DELETE /award/api/v1/award-budget-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardBudgetTypeCode: string (optional)
Award Budget Type Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Budget Version Overviews ¶

Get Award Budget Version Overviews by Key
GET`/award/api/v1/award-budget-version-overviews/(key)`

Example URI

GET /award/api/v1/award-budget-version-overviews/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "budgetId": "(val)",
  "awardBudgetStatusCode": "(val)",
  "awardBudgetTypeCode": "(val)",
  "obligatedAmount": "(val)",
  "description": "(val)",
  "budgetInitiator": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Budget Version Overviews
GET`/award/api/v1/award-budget-version-overviews/`

Example URI

GET /award/api/v1/award-budget-version-overviews/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "budgetId": "(val)",
    "awardBudgetStatusCode": "(val)",
    "awardBudgetTypeCode": "(val)",
    "obligatedAmount": "(val)",
    "description": "(val)",
    "budgetInitiator": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetId": "(val)",
    "awardBudgetStatusCode": "(val)",
    "awardBudgetTypeCode": "(val)",
    "obligatedAmount": "(val)",
    "description": "(val)",
    "budgetInitiator": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Budget Version Overviews with Filtering
GET`/award/api/v1/award-budget-version-overviews/`

Example URI

GET /award/api/v1/award-budget-version-overviews/

URI Parameters

HideShow

budgetId: string (optional)
awardBudgetStatusCode: string (optional)
awardBudgetTypeCode: string (optional)
obligatedAmount: string (optional)
description: string (optional)
budgetInitiator: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "budgetId": "(val)",
    "awardBudgetStatusCode": "(val)",
    "awardBudgetTypeCode": "(val)",
    "obligatedAmount": "(val)",
    "description": "(val)",
    "budgetInitiator": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetId": "(val)",
    "awardBudgetStatusCode": "(val)",
    "awardBudgetTypeCode": "(val)",
    "obligatedAmount": "(val)",
    "description": "(val)",
    "budgetInitiator": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Budget Version Overviews
GET`/award/api/v1/award-budget-version-overviews/`

Example URI

GET /award/api/v1/award-budget-version-overviews/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "budgetId",
    "awardBudgetStatusCode",
    "awardBudgetTypeCode",
    "obligatedAmount",
    "description",
    "budgetInitiator"
  ],
  "primaryKey": "budgetId"
}

Get Blueprint API specification for Award Budget Version Overviews
GET`/award/api/v1/award-budget-version-overviews/`

Example URI

GET /award/api/v1/award-budget-version-overviews/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Budget Version Overviews.md"
transfer-encoding: chunked

Update Award Budget Version Overviews
PUT`/award/api/v1/award-budget-version-overviews/(key)`

Example URI

PUT /award/api/v1/award-budget-version-overviews/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "budgetId": "(val)",
  "awardBudgetStatusCode": "(val)",
  "awardBudgetTypeCode": "(val)",
  "obligatedAmount": "(val)",
  "description": "(val)",
  "budgetInitiator": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Budget Version Overviews
PUT`/award/api/v1/award-budget-version-overviews/`

Example URI

PUT /award/api/v1/award-budget-version-overviews/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "budgetId": "(val)",
    "awardBudgetStatusCode": "(val)",
    "awardBudgetTypeCode": "(val)",
    "obligatedAmount": "(val)",
    "description": "(val)",
    "budgetInitiator": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetId": "(val)",
    "awardBudgetStatusCode": "(val)",
    "awardBudgetTypeCode": "(val)",
    "obligatedAmount": "(val)",
    "description": "(val)",
    "budgetInitiator": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Budget Version Overviews
PATCH`/award/api/v1/award-budget-version-overviews/(key)`

Example URI

PATCH /award/api/v1/award-budget-version-overviews/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "budgetId": "(val)",
  "awardBudgetStatusCode": "(val)",
  "awardBudgetTypeCode": "(val)",
  "obligatedAmount": "(val)",
  "description": "(val)",
  "budgetInitiator": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "budgetId": "(val)",
  "awardBudgetStatusCode": "(val)",
  "awardBudgetTypeCode": "(val)",
  "obligatedAmount": "(val)",
  "description": "(val)",
  "budgetInitiator": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Budget Version Overviews
POST`/award/api/v1/award-budget-version-overviews/`

Example URI

POST /award/api/v1/award-budget-version-overviews/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "budgetId": "(val)",
  "awardBudgetStatusCode": "(val)",
  "awardBudgetTypeCode": "(val)",
  "obligatedAmount": "(val)",
  "description": "(val)",
  "budgetInitiator": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "budgetId": "(val)",
  "awardBudgetStatusCode": "(val)",
  "awardBudgetTypeCode": "(val)",
  "obligatedAmount": "(val)",
  "description": "(val)",
  "budgetInitiator": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Budget Version Overviews
POST`/award/api/v1/award-budget-version-overviews/`

Example URI

POST /award/api/v1/award-budget-version-overviews/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "budgetId": "(val)",
    "awardBudgetStatusCode": "(val)",
    "awardBudgetTypeCode": "(val)",
    "obligatedAmount": "(val)",
    "description": "(val)",
    "budgetInitiator": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetId": "(val)",
    "awardBudgetStatusCode": "(val)",
    "awardBudgetTypeCode": "(val)",
    "obligatedAmount": "(val)",
    "description": "(val)",
    "budgetInitiator": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "budgetId": "(val)",
    "awardBudgetStatusCode": "(val)",
    "awardBudgetTypeCode": "(val)",
    "obligatedAmount": "(val)",
    "description": "(val)",
    "budgetInitiator": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetId": "(val)",
    "awardBudgetStatusCode": "(val)",
    "awardBudgetTypeCode": "(val)",
    "obligatedAmount": "(val)",
    "description": "(val)",
    "budgetInitiator": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Budget Version Overviews by Key
DELETE`/award/api/v1/award-budget-version-overviews/(key)`

Example URI

DELETE /award/api/v1/award-budget-version-overviews/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Budget Version Overviews
DELETE`/award/api/v1/award-budget-version-overviews/`

Example URI

DELETE /award/api/v1/award-budget-version-overviews/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Budget Version Overviews with Matching
DELETE`/award/api/v1/award-budget-version-overviews/`

Example URI

DELETE /award/api/v1/award-budget-version-overviews/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
budgetId: string (optional)
awardBudgetStatusCode: string (optional)
awardBudgetTypeCode: string (optional)
obligatedAmount: string (optional)
description: string (optional)
budgetInitiator: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Budgets ¶

Get Award Budgets by Key
GET`/award/api/v1/award-budgets/(key)`

Example URI

GET /award/api/v1/award-budgets/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "budgetId": "(val)",
  "awardBudgetStatusCode": "(val)",
  "awardBudgetTypeCode": "(val)",
  "obligatedAmount": "(val)",
  "obligatedTotal": "(val)",
  "description": "(val)",
  "budgetInitiator": "(val)",
  "awardId": "(val)",
  "awardBudgetDocument.documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Budgets
GET`/award/api/v1/award-budgets/`

Example URI

GET /award/api/v1/award-budgets/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "budgetId": "(val)",
    "awardBudgetStatusCode": "(val)",
    "awardBudgetTypeCode": "(val)",
    "obligatedAmount": "(val)",
    "obligatedTotal": "(val)",
    "description": "(val)",
    "budgetInitiator": "(val)",
    "awardId": "(val)",
    "awardBudgetDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetId": "(val)",
    "awardBudgetStatusCode": "(val)",
    "awardBudgetTypeCode": "(val)",
    "obligatedAmount": "(val)",
    "obligatedTotal": "(val)",
    "description": "(val)",
    "budgetInitiator": "(val)",
    "awardId": "(val)",
    "awardBudgetDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Budgets with Filtering
GET`/award/api/v1/award-budgets/`

Example URI

GET /award/api/v1/award-budgets/

URI Parameters

HideShow

budgetId: string (optional)
Budget Id. Maximum length is 22.
awardBudgetStatusCode: string (optional)
Award Budget Status Code. Maximum length is 3.
awardBudgetTypeCode: string (optional)
Award Budget Type Code. Maximum length is 3.
obligatedAmount: string (optional)
Obligated amount from award amount info. Maximum length is 15.
obligatedTotal: string (optional)
description: string (optional)
Description. Maximum length is 255.
budgetInitiator: string (optional)
Budget Initiator. Maximum length is 60.
awardId: string (optional)
awardBudgetDocument.documentNumber: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "budgetId": "(val)",
    "awardBudgetStatusCode": "(val)",
    "awardBudgetTypeCode": "(val)",
    "obligatedAmount": "(val)",
    "obligatedTotal": "(val)",
    "description": "(val)",
    "budgetInitiator": "(val)",
    "awardId": "(val)",
    "awardBudgetDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "budgetId": "(val)",
    "awardBudgetStatusCode": "(val)",
    "awardBudgetTypeCode": "(val)",
    "obligatedAmount": "(val)",
    "obligatedTotal": "(val)",
    "description": "(val)",
    "budgetInitiator": "(val)",
    "awardId": "(val)",
    "awardBudgetDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Budgets
GET`/award/api/v1/award-budgets/`

Example URI

GET /award/api/v1/award-budgets/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "budgetId",
    "awardBudgetStatusCode",
    "awardBudgetTypeCode",
    "obligatedAmount",
    "obligatedTotal",
    "description",
    "budgetInitiator",
    "awardId",
    "awardBudgetDocument.documentNumber"
  ],
  "primaryKey": "budgetId"
}

Get Blueprint API specification for Award Budgets
GET`/award/api/v1/award-budgets/`

Example URI

GET /award/api/v1/award-budgets/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Budgets.md"
transfer-encoding: chunked

Award Central Admin Contacts ¶

Get Award Central Admin Contacts by Key
GET`/award/api/v1/award-central-admin-contacts/(key)`

Example URI

GET /award/api/v1/award-central-admin-contacts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardContactId": "(val)",
  "personId": "(val)",
  "fullName": "(val)",
  "unitContactType": "(val)",
  "unitAdministratorTypeCode": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "unitAdministratorUnitNumber": "(val)",
  "defaultUnitContact": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Central Admin Contacts
GET`/award/api/v1/award-central-admin-contacts/`

Example URI

GET /award/api/v1/award-central-admin-contacts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardContactId": "(val)",
    "personId": "(val)",
    "fullName": "(val)",
    "unitContactType": "(val)",
    "unitAdministratorTypeCode": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "unitAdministratorUnitNumber": "(val)",
    "defaultUnitContact": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardContactId": "(val)",
    "personId": "(val)",
    "fullName": "(val)",
    "unitContactType": "(val)",
    "unitAdministratorTypeCode": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "unitAdministratorUnitNumber": "(val)",
    "defaultUnitContact": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Central Admin Contacts with Filtering
GET`/award/api/v1/award-central-admin-contacts/`

Example URI

GET /award/api/v1/award-central-admin-contacts/

URI Parameters

HideShow

awardContactId: string (optional)
personId: string (optional)
fullName: string (optional)
unitContactType: string (optional)
unitAdministratorTypeCode: string (optional)
awardNumber: string (optional)
sequenceNumber: string (optional)
unitAdministratorUnitNumber: string (optional)
defaultUnitContact: string (optional)
award.awardId: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardContactId": "(val)",
    "personId": "(val)",
    "fullName": "(val)",
    "unitContactType": "(val)",
    "unitAdministratorTypeCode": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "unitAdministratorUnitNumber": "(val)",
    "defaultUnitContact": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardContactId": "(val)",
    "personId": "(val)",
    "fullName": "(val)",
    "unitContactType": "(val)",
    "unitAdministratorTypeCode": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "unitAdministratorUnitNumber": "(val)",
    "defaultUnitContact": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Central Admin Contacts
GET`/award/api/v1/award-central-admin-contacts/`

Example URI

GET /award/api/v1/award-central-admin-contacts/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardContactId",
    "personId",
    "fullName",
    "unitContactType",
    "unitAdministratorTypeCode",
    "awardNumber",
    "sequenceNumber",
    "unitAdministratorUnitNumber",
    "defaultUnitContact",
    "award.awardId"
  ],
  "primaryKey": "awardContactId"
}

Get Blueprint API specification for Award Central Admin Contacts
GET`/award/api/v1/award-central-admin-contacts/`

Example URI

GET /award/api/v1/award-central-admin-contacts/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Central Admin Contacts.md"
transfer-encoding: chunked

Update Award Central Admin Contacts
PUT`/award/api/v1/award-central-admin-contacts/(key)`

Example URI

PUT /award/api/v1/award-central-admin-contacts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardContactId": "(val)",
  "personId": "(val)",
  "fullName": "(val)",
  "unitContactType": "(val)",
  "unitAdministratorTypeCode": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "unitAdministratorUnitNumber": "(val)",
  "defaultUnitContact": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Central Admin Contacts
PUT`/award/api/v1/award-central-admin-contacts/`

Example URI

PUT /award/api/v1/award-central-admin-contacts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardContactId": "(val)",
    "personId": "(val)",
    "fullName": "(val)",
    "unitContactType": "(val)",
    "unitAdministratorTypeCode": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "unitAdministratorUnitNumber": "(val)",
    "defaultUnitContact": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardContactId": "(val)",
    "personId": "(val)",
    "fullName": "(val)",
    "unitContactType": "(val)",
    "unitAdministratorTypeCode": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "unitAdministratorUnitNumber": "(val)",
    "defaultUnitContact": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Central Admin Contacts
PATCH`/award/api/v1/award-central-admin-contacts/(key)`

Example URI

PATCH /award/api/v1/award-central-admin-contacts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardContactId": "(val)",
  "personId": "(val)",
  "fullName": "(val)",
  "unitContactType": "(val)",
  "unitAdministratorTypeCode": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "unitAdministratorUnitNumber": "(val)",
  "defaultUnitContact": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardContactId": "(val)",
  "personId": "(val)",
  "fullName": "(val)",
  "unitContactType": "(val)",
  "unitAdministratorTypeCode": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "unitAdministratorUnitNumber": "(val)",
  "defaultUnitContact": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Central Admin Contacts
POST`/award/api/v1/award-central-admin-contacts/`

Example URI

POST /award/api/v1/award-central-admin-contacts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardContactId": "(val)",
  "personId": "(val)",
  "fullName": "(val)",
  "unitContactType": "(val)",
  "unitAdministratorTypeCode": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "unitAdministratorUnitNumber": "(val)",
  "defaultUnitContact": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardContactId": "(val)",
  "personId": "(val)",
  "fullName": "(val)",
  "unitContactType": "(val)",
  "unitAdministratorTypeCode": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "unitAdministratorUnitNumber": "(val)",
  "defaultUnitContact": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Central Admin Contacts
POST`/award/api/v1/award-central-admin-contacts/`

Example URI

POST /award/api/v1/award-central-admin-contacts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardContactId": "(val)",
    "personId": "(val)",
    "fullName": "(val)",
    "unitContactType": "(val)",
    "unitAdministratorTypeCode": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "unitAdministratorUnitNumber": "(val)",
    "defaultUnitContact": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardContactId": "(val)",
    "personId": "(val)",
    "fullName": "(val)",
    "unitContactType": "(val)",
    "unitAdministratorTypeCode": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "unitAdministratorUnitNumber": "(val)",
    "defaultUnitContact": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardContactId": "(val)",
    "personId": "(val)",
    "fullName": "(val)",
    "unitContactType": "(val)",
    "unitAdministratorTypeCode": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "unitAdministratorUnitNumber": "(val)",
    "defaultUnitContact": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardContactId": "(val)",
    "personId": "(val)",
    "fullName": "(val)",
    "unitContactType": "(val)",
    "unitAdministratorTypeCode": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "unitAdministratorUnitNumber": "(val)",
    "defaultUnitContact": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Central Admin Contacts by Key
DELETE`/award/api/v1/award-central-admin-contacts/(key)`

Example URI

DELETE /award/api/v1/award-central-admin-contacts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Central Admin Contacts
DELETE`/award/api/v1/award-central-admin-contacts/`

Example URI

DELETE /award/api/v1/award-central-admin-contacts/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Central Admin Contacts with Matching
DELETE`/award/api/v1/award-central-admin-contacts/`

Example URI

DELETE /award/api/v1/award-central-admin-contacts/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardContactId: string (optional)
personId: string (optional)
fullName: string (optional)
unitContactType: string (optional)
unitAdministratorTypeCode: string (optional)
awardNumber: string (optional)
sequenceNumber: string (optional)
unitAdministratorUnitNumber: string (optional)
defaultUnitContact: string (optional)
award.awardId: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Cgbs ¶

Get Award Cgbs by Key
GET`/award/api/v1/award-cgbs/(key)`

Example URI

GET /award/api/v1/award-cgbs/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "additionalFormsRequired": "(val)",
  "autoApproveInvoice": "(val)",
  "stopWork": "(val)",
  "minInvoiceAmount": "(val)",
  "invoicingOption": "(val)",
  "dunningCampaignId": "(val)",
  "lastBilledDate": "(val)",
  "previousLastBilledDate": "(val)",
  "finalBill": "(val)",
  "amountToDraw": "(val)",
  "letterOfCreditReviewIndicator": "(val)",
  "invoiceDocumentStatus": "(val)",
  "locCreationType": "(val)",
  "suspendInvoicing": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Cgbs
GET`/award/api/v1/award-cgbs/`

Example URI

GET /award/api/v1/award-cgbs/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "additionalFormsRequired": "(val)",
    "autoApproveInvoice": "(val)",
    "stopWork": "(val)",
    "minInvoiceAmount": "(val)",
    "invoicingOption": "(val)",
    "dunningCampaignId": "(val)",
    "lastBilledDate": "(val)",
    "previousLastBilledDate": "(val)",
    "finalBill": "(val)",
    "amountToDraw": "(val)",
    "letterOfCreditReviewIndicator": "(val)",
    "invoiceDocumentStatus": "(val)",
    "locCreationType": "(val)",
    "suspendInvoicing": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "additionalFormsRequired": "(val)",
    "autoApproveInvoice": "(val)",
    "stopWork": "(val)",
    "minInvoiceAmount": "(val)",
    "invoicingOption": "(val)",
    "dunningCampaignId": "(val)",
    "lastBilledDate": "(val)",
    "previousLastBilledDate": "(val)",
    "finalBill": "(val)",
    "amountToDraw": "(val)",
    "letterOfCreditReviewIndicator": "(val)",
    "invoiceDocumentStatus": "(val)",
    "locCreationType": "(val)",
    "suspendInvoicing": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Cgbs with Filtering
GET`/award/api/v1/award-cgbs/`

Example URI

GET /award/api/v1/award-cgbs/

URI Parameters

HideShow

awardId: string (optional)
awardNumber: string (optional)
sequenceNumber: string (optional)
additionalFormsRequired: string (optional)
This attribute should always be overriden on the descriptive elements. Maximum length is 1.
autoApproveInvoice: string (optional)
This attribute should always be overriden on the descriptive elements. Maximum length is 1.
stopWork: string (optional)
This attribute should always be overriden on the descriptive elements. Maximum length is 1.
minInvoiceAmount: string (optional)
Minimum Invoice Amount. Maximum length is 22.
invoicingOption: string (optional)
Invoicing Option. Maximum length is 120.
dunningCampaignId: string (optional)
Dunning Campaign. Maximum length is 4.
lastBilledDate: string (optional)
This attribute should always be overriden on the descriptive elements. Maximum length is 21.
previousLastBilledDate: string (optional)
This attribute should always be overriden on the descriptive elements. Maximum length is 21.
finalBill: string (optional)
This attribute should always be overriden on the descriptive elements. Maximum length is 1.
amountToDraw: string (optional)
Amount To Draw. Maximum length is 22.
letterOfCreditReviewIndicator: string (optional)
This attribute should always be overriden on the descriptive elements. Maximum length is 1.
invoiceDocumentStatus: string (optional)
Invoice Document Status. Maximum length is 45.
locCreationType: string (optional)
Letter Of Credit Creation Type. Maximum length is 45.
suspendInvoicing: string (optional)
This attribute should always be overriden on the descriptive elements. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "additionalFormsRequired": "(val)",
    "autoApproveInvoice": "(val)",
    "stopWork": "(val)",
    "minInvoiceAmount": "(val)",
    "invoicingOption": "(val)",
    "dunningCampaignId": "(val)",
    "lastBilledDate": "(val)",
    "previousLastBilledDate": "(val)",
    "finalBill": "(val)",
    "amountToDraw": "(val)",
    "letterOfCreditReviewIndicator": "(val)",
    "invoiceDocumentStatus": "(val)",
    "locCreationType": "(val)",
    "suspendInvoicing": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "additionalFormsRequired": "(val)",
    "autoApproveInvoice": "(val)",
    "stopWork": "(val)",
    "minInvoiceAmount": "(val)",
    "invoicingOption": "(val)",
    "dunningCampaignId": "(val)",
    "lastBilledDate": "(val)",
    "previousLastBilledDate": "(val)",
    "finalBill": "(val)",
    "amountToDraw": "(val)",
    "letterOfCreditReviewIndicator": "(val)",
    "invoiceDocumentStatus": "(val)",
    "locCreationType": "(val)",
    "suspendInvoicing": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Cgbs
GET`/award/api/v1/award-cgbs/`

Example URI

GET /award/api/v1/award-cgbs/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardId",
    "awardNumber",
    "sequenceNumber",
    "additionalFormsRequired",
    "autoApproveInvoice",
    "stopWork",
    "minInvoiceAmount",
    "invoicingOption",
    "dunningCampaignId",
    "lastBilledDate",
    "previousLastBilledDate",
    "finalBill",
    "amountToDraw",
    "letterOfCreditReviewIndicator",
    "invoiceDocumentStatus",
    "locCreationType",
    "suspendInvoicing"
  ],
  "primaryKey": "awardId"
}

Get Blueprint API specification for Award Cgbs
GET`/award/api/v1/award-cgbs/`

Example URI

GET /award/api/v1/award-cgbs/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Cgbs.md"
transfer-encoding: chunked

Update Award Cgbs
PUT`/award/api/v1/award-cgbs/(key)`

Example URI

PUT /award/api/v1/award-cgbs/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "additionalFormsRequired": "(val)",
  "autoApproveInvoice": "(val)",
  "stopWork": "(val)",
  "minInvoiceAmount": "(val)",
  "invoicingOption": "(val)",
  "dunningCampaignId": "(val)",
  "lastBilledDate": "(val)",
  "previousLastBilledDate": "(val)",
  "finalBill": "(val)",
  "amountToDraw": "(val)",
  "letterOfCreditReviewIndicator": "(val)",
  "invoiceDocumentStatus": "(val)",
  "locCreationType": "(val)",
  "suspendInvoicing": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Cgbs
PUT`/award/api/v1/award-cgbs/`

Example URI

PUT /award/api/v1/award-cgbs/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "additionalFormsRequired": "(val)",
    "autoApproveInvoice": "(val)",
    "stopWork": "(val)",
    "minInvoiceAmount": "(val)",
    "invoicingOption": "(val)",
    "dunningCampaignId": "(val)",
    "lastBilledDate": "(val)",
    "previousLastBilledDate": "(val)",
    "finalBill": "(val)",
    "amountToDraw": "(val)",
    "letterOfCreditReviewIndicator": "(val)",
    "invoiceDocumentStatus": "(val)",
    "locCreationType": "(val)",
    "suspendInvoicing": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "additionalFormsRequired": "(val)",
    "autoApproveInvoice": "(val)",
    "stopWork": "(val)",
    "minInvoiceAmount": "(val)",
    "invoicingOption": "(val)",
    "dunningCampaignId": "(val)",
    "lastBilledDate": "(val)",
    "previousLastBilledDate": "(val)",
    "finalBill": "(val)",
    "amountToDraw": "(val)",
    "letterOfCreditReviewIndicator": "(val)",
    "invoiceDocumentStatus": "(val)",
    "locCreationType": "(val)",
    "suspendInvoicing": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Cgbs
PATCH`/award/api/v1/award-cgbs/(key)`

Example URI

PATCH /award/api/v1/award-cgbs/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "additionalFormsRequired": "(val)",
  "autoApproveInvoice": "(val)",
  "stopWork": "(val)",
  "minInvoiceAmount": "(val)",
  "invoicingOption": "(val)",
  "dunningCampaignId": "(val)",
  "lastBilledDate": "(val)",
  "previousLastBilledDate": "(val)",
  "finalBill": "(val)",
  "amountToDraw": "(val)",
  "letterOfCreditReviewIndicator": "(val)",
  "invoiceDocumentStatus": "(val)",
  "locCreationType": "(val)",
  "suspendInvoicing": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "additionalFormsRequired": "(val)",
  "autoApproveInvoice": "(val)",
  "stopWork": "(val)",
  "minInvoiceAmount": "(val)",
  "invoicingOption": "(val)",
  "dunningCampaignId": "(val)",
  "lastBilledDate": "(val)",
  "previousLastBilledDate": "(val)",
  "finalBill": "(val)",
  "amountToDraw": "(val)",
  "letterOfCreditReviewIndicator": "(val)",
  "invoiceDocumentStatus": "(val)",
  "locCreationType": "(val)",
  "suspendInvoicing": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Cgbs
POST`/award/api/v1/award-cgbs/`

Example URI

POST /award/api/v1/award-cgbs/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "additionalFormsRequired": "(val)",
  "autoApproveInvoice": "(val)",
  "stopWork": "(val)",
  "minInvoiceAmount": "(val)",
  "invoicingOption": "(val)",
  "dunningCampaignId": "(val)",
  "lastBilledDate": "(val)",
  "previousLastBilledDate": "(val)",
  "finalBill": "(val)",
  "amountToDraw": "(val)",
  "letterOfCreditReviewIndicator": "(val)",
  "invoiceDocumentStatus": "(val)",
  "locCreationType": "(val)",
  "suspendInvoicing": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "additionalFormsRequired": "(val)",
  "autoApproveInvoice": "(val)",
  "stopWork": "(val)",
  "minInvoiceAmount": "(val)",
  "invoicingOption": "(val)",
  "dunningCampaignId": "(val)",
  "lastBilledDate": "(val)",
  "previousLastBilledDate": "(val)",
  "finalBill": "(val)",
  "amountToDraw": "(val)",
  "letterOfCreditReviewIndicator": "(val)",
  "invoiceDocumentStatus": "(val)",
  "locCreationType": "(val)",
  "suspendInvoicing": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Cgbs
POST`/award/api/v1/award-cgbs/`

Example URI

POST /award/api/v1/award-cgbs/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "additionalFormsRequired": "(val)",
    "autoApproveInvoice": "(val)",
    "stopWork": "(val)",
    "minInvoiceAmount": "(val)",
    "invoicingOption": "(val)",
    "dunningCampaignId": "(val)",
    "lastBilledDate": "(val)",
    "previousLastBilledDate": "(val)",
    "finalBill": "(val)",
    "amountToDraw": "(val)",
    "letterOfCreditReviewIndicator": "(val)",
    "invoiceDocumentStatus": "(val)",
    "locCreationType": "(val)",
    "suspendInvoicing": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "additionalFormsRequired": "(val)",
    "autoApproveInvoice": "(val)",
    "stopWork": "(val)",
    "minInvoiceAmount": "(val)",
    "invoicingOption": "(val)",
    "dunningCampaignId": "(val)",
    "lastBilledDate": "(val)",
    "previousLastBilledDate": "(val)",
    "finalBill": "(val)",
    "amountToDraw": "(val)",
    "letterOfCreditReviewIndicator": "(val)",
    "invoiceDocumentStatus": "(val)",
    "locCreationType": "(val)",
    "suspendInvoicing": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "additionalFormsRequired": "(val)",
    "autoApproveInvoice": "(val)",
    "stopWork": "(val)",
    "minInvoiceAmount": "(val)",
    "invoicingOption": "(val)",
    "dunningCampaignId": "(val)",
    "lastBilledDate": "(val)",
    "previousLastBilledDate": "(val)",
    "finalBill": "(val)",
    "amountToDraw": "(val)",
    "letterOfCreditReviewIndicator": "(val)",
    "invoiceDocumentStatus": "(val)",
    "locCreationType": "(val)",
    "suspendInvoicing": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "additionalFormsRequired": "(val)",
    "autoApproveInvoice": "(val)",
    "stopWork": "(val)",
    "minInvoiceAmount": "(val)",
    "invoicingOption": "(val)",
    "dunningCampaignId": "(val)",
    "lastBilledDate": "(val)",
    "previousLastBilledDate": "(val)",
    "finalBill": "(val)",
    "amountToDraw": "(val)",
    "letterOfCreditReviewIndicator": "(val)",
    "invoiceDocumentStatus": "(val)",
    "locCreationType": "(val)",
    "suspendInvoicing": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Cgbs by Key
DELETE`/award/api/v1/award-cgbs/(key)`

Example URI

DELETE /award/api/v1/award-cgbs/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Cgbs
DELETE`/award/api/v1/award-cgbs/`

Example URI

DELETE /award/api/v1/award-cgbs/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Cgbs with Matching
DELETE`/award/api/v1/award-cgbs/`

Example URI

DELETE /award/api/v1/award-cgbs/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardId: string (optional)
awardNumber: string (optional)
sequenceNumber: string (optional)
additionalFormsRequired: string (optional)
This attribute should always be overriden on the descriptive elements. Maximum length is 1.
autoApproveInvoice: string (optional)
This attribute should always be overriden on the descriptive elements. Maximum length is 1.
stopWork: string (optional)
This attribute should always be overriden on the descriptive elements. Maximum length is 1.
minInvoiceAmount: string (optional)
Minimum Invoice Amount. Maximum length is 22.
invoicingOption: string (optional)
Invoicing Option. Maximum length is 120.
dunningCampaignId: string (optional)
Dunning Campaign. Maximum length is 4.
lastBilledDate: string (optional)
This attribute should always be overriden on the descriptive elements. Maximum length is 21.
previousLastBilledDate: string (optional)
This attribute should always be overriden on the descriptive elements. Maximum length is 21.
finalBill: string (optional)
This attribute should always be overriden on the descriptive elements. Maximum length is 1.
amountToDraw: string (optional)
Amount To Draw. Maximum length is 22.
letterOfCreditReviewIndicator: string (optional)
This attribute should always be overriden on the descriptive elements. Maximum length is 1.
invoiceDocumentStatus: string (optional)
Invoice Document Status. Maximum length is 45.
locCreationType: string (optional)
Letter Of Credit Creation Type. Maximum length is 45.
suspendInvoicing: string (optional)
This attribute should always be overriden on the descriptive elements. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Closeouts ¶

Get Award Closeouts by Key
GET`/award/api/v1/award-closeouts/(key)`

Example URI

GET /award/api/v1/award-closeouts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardCloseoutId": "(val)",
  "closeoutReportCode": "(val)",
  "closeoutReportName": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "finalSubmissionDate": "(val)",
  "dueDate": "(val)",
  "multiple": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Closeouts
GET`/award/api/v1/award-closeouts/`

Example URI

GET /award/api/v1/award-closeouts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardCloseoutId": "(val)",
    "closeoutReportCode": "(val)",
    "closeoutReportName": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "finalSubmissionDate": "(val)",
    "dueDate": "(val)",
    "multiple": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardCloseoutId": "(val)",
    "closeoutReportCode": "(val)",
    "closeoutReportName": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "finalSubmissionDate": "(val)",
    "dueDate": "(val)",
    "multiple": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Closeouts with Filtering
GET`/award/api/v1/award-closeouts/`

Example URI

GET /award/api/v1/award-closeouts/

URI Parameters

HideShow

awardCloseoutId: string (optional)
Award Closeout Id. Maximum length is 22.
closeoutReportCode: string (optional)
Closeout Report Code. Maximum length is 22.
closeoutReportName: string (optional)
Final Report. Maximum length is 100.
awardNumber: string (optional)
Award ID. Maximum length is 12.
sequenceNumber: string (optional)
Sequence Number. Maximum length is 4.
finalSubmissionDate: string (optional)
Final Submission Date. Maximum length is 10.
dueDate: string (optional)
Due Date. Maximum length is 10.
multiple: string (optional)
award.awardId: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardCloseoutId": "(val)",
    "closeoutReportCode": "(val)",
    "closeoutReportName": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "finalSubmissionDate": "(val)",
    "dueDate": "(val)",
    "multiple": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardCloseoutId": "(val)",
    "closeoutReportCode": "(val)",
    "closeoutReportName": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "finalSubmissionDate": "(val)",
    "dueDate": "(val)",
    "multiple": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Closeouts
GET`/award/api/v1/award-closeouts/`

Example URI

GET /award/api/v1/award-closeouts/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardCloseoutId",
    "closeoutReportCode",
    "closeoutReportName",
    "awardNumber",
    "sequenceNumber",
    "finalSubmissionDate",
    "dueDate",
    "multiple",
    "award.awardId"
  ],
  "primaryKey": "awardCloseoutId"
}

Get Blueprint API specification for Award Closeouts
GET`/award/api/v1/award-closeouts/`

Example URI

GET /award/api/v1/award-closeouts/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Closeouts.md"
transfer-encoding: chunked

Award Comments ¶

Get Award Comments by Key
GET`/award/api/v1/award-comments/(key)`

Example URI

GET /award/api/v1/award-comments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardCommentId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "commentTypeCode": "(val)",
  "checklistPrintFlag": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Comments
GET`/award/api/v1/award-comments/`

Example URI

GET /award/api/v1/award-comments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardCommentId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "checklistPrintFlag": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardCommentId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "checklistPrintFlag": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Comments with Filtering
GET`/award/api/v1/award-comments/`

Example URI

GET /award/api/v1/award-comments/

URI Parameters

HideShow

awardCommentId: string (optional)
Award Comment ID. Maximum length is 8.
awardNumber: string (optional)
Award ID. Maximum length is 12.
sequenceNumber: string (optional)
Sequence Number. Maximum length is 4.
commentTypeCode: string (optional)
checklistPrintFlag: string (optional)
Checklist Print Flag. Maximum length is 1.
comments: string (optional)
Comments. Maximum length is 999999999.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardCommentId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "checklistPrintFlag": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardCommentId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "checklistPrintFlag": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Comments
GET`/award/api/v1/award-comments/`

Example URI

GET /award/api/v1/award-comments/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardCommentId",
    "awardNumber",
    "sequenceNumber",
    "commentTypeCode",
    "checklistPrintFlag",
    "comments"
  ],
  "primaryKey": "awardCommentId"
}

Get Blueprint API specification for Award Comments
GET`/award/api/v1/award-comments/`

Example URI

GET /award/api/v1/award-comments/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Comments.md"
transfer-encoding: chunked

Award Cost Shares ¶

Get Award Cost Shares by Key
GET`/award/api/v1/award-cost-shares/(key)`

Example URI

GET /award/api/v1/award-cost-shares/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardCostShareId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "projectPeriod": "(val)",
  "costSharePercentage": "(val)",
  "costShareTypeCode": "(val)",
  "source": "(val)",
  "destination": "(val)",
  "commitmentAmount": "(val)",
  "costShareMet": "(val)",
  "verificationDate": "(val)",
  "unitNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Cost Shares
GET`/award/api/v1/award-cost-shares/`

Example URI

GET /award/api/v1/award-cost-shares/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardCostShareId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "projectPeriod": "(val)",
    "costSharePercentage": "(val)",
    "costShareTypeCode": "(val)",
    "source": "(val)",
    "destination": "(val)",
    "commitmentAmount": "(val)",
    "costShareMet": "(val)",
    "verificationDate": "(val)",
    "unitNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardCostShareId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "projectPeriod": "(val)",
    "costSharePercentage": "(val)",
    "costShareTypeCode": "(val)",
    "source": "(val)",
    "destination": "(val)",
    "commitmentAmount": "(val)",
    "costShareMet": "(val)",
    "verificationDate": "(val)",
    "unitNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Cost Shares with Filtering
GET`/award/api/v1/award-cost-shares/`

Example URI

GET /award/api/v1/award-cost-shares/

URI Parameters

HideShow

awardCostShareId: string (optional)
Award Cost Share ID. Maximum length is 8.
awardNumber: string (optional)
Award ID. Maximum length is 12.
sequenceNumber: string (optional)
Sequence Number. Maximum length is 4.
projectPeriod: string (optional)
Project Period. Maximum length is 4.
costSharePercentage: string (optional)
Cost Share Percentage. Maximum length is 10.
costShareTypeCode: string (optional)
Cost Share Type Code. Maximum length is 3.
source: string (optional)
Source. Maximum length is 32.
destination: string (optional)
Destination. Maximum length is 32.
commitmentAmount: string (optional)
Commitment Amount. Maximum length is 12.
costShareMet: string (optional)
Cost Share Met. Maximum length is 12.
verificationDate: string (optional)
Verification Date. Maximum length is 21.
unitNumber: string (optional)
Unit Number. Maximum length is 20.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardCostShareId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "projectPeriod": "(val)",
    "costSharePercentage": "(val)",
    "costShareTypeCode": "(val)",
    "source": "(val)",
    "destination": "(val)",
    "commitmentAmount": "(val)",
    "costShareMet": "(val)",
    "verificationDate": "(val)",
    "unitNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardCostShareId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "projectPeriod": "(val)",
    "costSharePercentage": "(val)",
    "costShareTypeCode": "(val)",
    "source": "(val)",
    "destination": "(val)",
    "commitmentAmount": "(val)",
    "costShareMet": "(val)",
    "verificationDate": "(val)",
    "unitNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Cost Shares
GET`/award/api/v1/award-cost-shares/`

Example URI

GET /award/api/v1/award-cost-shares/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardCostShareId",
    "awardNumber",
    "sequenceNumber",
    "projectPeriod",
    "costSharePercentage",
    "costShareTypeCode",
    "source",
    "destination",
    "commitmentAmount",
    "costShareMet",
    "verificationDate",
    "unitNumber"
  ],
  "primaryKey": "awardCostShareId"
}

Get Blueprint API specification for Award Cost Shares
GET`/award/api/v1/award-cost-shares/`

Example URI

GET /award/api/v1/award-cost-shares/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Cost Shares.md"
transfer-encoding: chunked

Award Custom Data ¶

Get Award Custom Data by Key
GET`/award/api/v1/award-custom-data/(key)`

Example URI

GET /award/api/v1/award-custom-data/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardCustomDataId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "customAttributeId": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Custom Data
GET`/award/api/v1/award-custom-data/`

Example URI

GET /award/api/v1/award-custom-data/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardCustomDataId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "customAttributeId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardCustomDataId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "customAttributeId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Custom Data with Filtering
GET`/award/api/v1/award-custom-data/`

Example URI

GET /award/api/v1/award-custom-data/

URI Parameters

HideShow

awardCustomDataId: string (optional)
awardNumber: string (optional)
sequenceNumber: string (optional)
customAttributeId: string (optional)
value: string (optional)
Value. Maximum length is 2000.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardCustomDataId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "customAttributeId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardCustomDataId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "customAttributeId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Custom Data
GET`/award/api/v1/award-custom-data/`

Example URI

GET /award/api/v1/award-custom-data/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardCustomDataId",
    "awardNumber",
    "sequenceNumber",
    "customAttributeId",
    "value"
  ],
  "primaryKey": "awardCustomDataId"
}

Get Blueprint API specification for Award Custom Data
GET`/award/api/v1/award-custom-data/`

Example URI

GET /award/api/v1/award-custom-data/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Custom Data.md"
transfer-encoding: chunked

Award Direct F And A Distributions ¶

Get Award Direct F And A Distributions by Key
GET`/award/api/v1/award-direct-f-and-a-distributions/(key)`

Example URI

GET /award/api/v1/award-direct-f-and-a-distributions/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardDirectFandADistributionId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "amountSequenceNumber": "(val)",
  "awardAmountInfoId": "(val)",
  "budgetPeriod": "(val)",
  "startDate": "(val)",
  "endDate": "(val)",
  "directCost": "(val)",
  "indirectCost": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Direct F And A Distributions
GET`/award/api/v1/award-direct-f-and-a-distributions/`

Example URI

GET /award/api/v1/award-direct-f-and-a-distributions/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardDirectFandADistributionId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "amountSequenceNumber": "(val)",
    "awardAmountInfoId": "(val)",
    "budgetPeriod": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "directCost": "(val)",
    "indirectCost": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardDirectFandADistributionId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "amountSequenceNumber": "(val)",
    "awardAmountInfoId": "(val)",
    "budgetPeriod": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "directCost": "(val)",
    "indirectCost": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Direct F And A Distributions with Filtering
GET`/award/api/v1/award-direct-f-and-a-distributions/`

Example URI

GET /award/api/v1/award-direct-f-and-a-distributions/

URI Parameters

HideShow

awardDirectFandADistributionId: string (optional)
Award Direct F and A Distribution ID. Maximum length is 8.
awardNumber: string (optional)
Award ID. Maximum length is 12.
sequenceNumber: string (optional)
Sequence Number. Maximum length is 4.
amountSequenceNumber: string (optional)
Amount Sequence Number. Maximum length is 4.
awardAmountInfoId: string (optional)
budgetPeriod: string (optional)
Budget Period. Maximum length is 3.
startDate: string (optional)
Start Date. Maximum length is 21.
endDate: string (optional)
End Date. Maximum length is 21.
directCost: string (optional)
Direct Cost. Maximum length is 12.
indirectCost: string (optional)
F&A Cost. Maximum length is 12.
award.awardId: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardDirectFandADistributionId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "amountSequenceNumber": "(val)",
    "awardAmountInfoId": "(val)",
    "budgetPeriod": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "directCost": "(val)",
    "indirectCost": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardDirectFandADistributionId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "amountSequenceNumber": "(val)",
    "awardAmountInfoId": "(val)",
    "budgetPeriod": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "directCost": "(val)",
    "indirectCost": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Direct F And A Distributions
GET`/award/api/v1/award-direct-f-and-a-distributions/`

Example URI

GET /award/api/v1/award-direct-f-and-a-distributions/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardDirectFandADistributionId",
    "awardNumber",
    "sequenceNumber",
    "amountSequenceNumber",
    "awardAmountInfoId",
    "budgetPeriod",
    "startDate",
    "endDate",
    "directCost",
    "indirectCost",
    "award.awardId"
  ],
  "primaryKey": "awardDirectFandADistributionId"
}

Get Blueprint API specification for Award Direct F And A Distributions
GET`/award/api/v1/award-direct-f-and-a-distributions/`

Example URI

GET /award/api/v1/award-direct-f-and-a-distributions/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Direct F And A Distributions.md"
transfer-encoding: chunked

Award F And A Rates ¶

Get Award F And A Rates by Key
GET`/award/api/v1/award-f-and-a-rates/(key)`

Example URI

GET /award/api/v1/award-f-and-a-rates/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardFandaRateId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "applicableFandaRate": "(val)",
  "fandaRateTypeCode": "(val)",
  "fiscalYear": "(val)",
  "onCampusFlag": "(val)",
  "underrecoveryOfIndirectCost": "(val)",
  "sourceAccount": "(val)",
  "destinationAccount": "(val)",
  "startDate": "(val)",
  "endDate": "(val)",
  "_primaryKey": "(val)"
}

Get All Award F And A Rates
GET`/award/api/v1/award-f-and-a-rates/`

Example URI

GET /award/api/v1/award-f-and-a-rates/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardFandaRateId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "applicableFandaRate": "(val)",
    "fandaRateTypeCode": "(val)",
    "fiscalYear": "(val)",
    "onCampusFlag": "(val)",
    "underrecoveryOfIndirectCost": "(val)",
    "sourceAccount": "(val)",
    "destinationAccount": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardFandaRateId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "applicableFandaRate": "(val)",
    "fandaRateTypeCode": "(val)",
    "fiscalYear": "(val)",
    "onCampusFlag": "(val)",
    "underrecoveryOfIndirectCost": "(val)",
    "sourceAccount": "(val)",
    "destinationAccount": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award F And A Rates with Filtering
GET`/award/api/v1/award-f-and-a-rates/`

Example URI

GET /award/api/v1/award-f-and-a-rates/

URI Parameters

HideShow

awardFandaRateId: string (optional)
Award Idc Rate Id. Maximum length is 22.
awardNumber: string (optional)
Award ID. Maximum length is 12.
sequenceNumber: string (optional)
Sequence Number. Maximum length is 8.
applicableFandaRate: string (optional)
Applicable Idc Rate. Maximum length is 22.
fandaRateTypeCode: string (optional)
F&A Rate Type Code. Maximum length is 22.
fiscalYear: string (optional)
Fiscal Year. Maximum length is 4.
onCampusFlag: string (optional)
On CampusContractContract Flag. Maximum length is 1.
underrecoveryOfIndirectCost: string (optional)
Underrecovery Of Idc. Maximum length is 22.
sourceAccount: string (optional)
Source Account. Maximum length is 32.
destinationAccount: string (optional)
Destination Account. Maximum length is 32.
startDate: string (optional)
Start Date. Maximum length is 10.
endDate: string (optional)
End Date. Maximum length is 10.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardFandaRateId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "applicableFandaRate": "(val)",
    "fandaRateTypeCode": "(val)",
    "fiscalYear": "(val)",
    "onCampusFlag": "(val)",
    "underrecoveryOfIndirectCost": "(val)",
    "sourceAccount": "(val)",
    "destinationAccount": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardFandaRateId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "applicableFandaRate": "(val)",
    "fandaRateTypeCode": "(val)",
    "fiscalYear": "(val)",
    "onCampusFlag": "(val)",
    "underrecoveryOfIndirectCost": "(val)",
    "sourceAccount": "(val)",
    "destinationAccount": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award F And A Rates
GET`/award/api/v1/award-f-and-a-rates/`

Example URI

GET /award/api/v1/award-f-and-a-rates/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardFandaRateId",
    "awardNumber",
    "sequenceNumber",
    "applicableFandaRate",
    "fandaRateTypeCode",
    "fiscalYear",
    "onCampusFlag",
    "underrecoveryOfIndirectCost",
    "sourceAccount",
    "destinationAccount",
    "startDate",
    "endDate"
  ],
  "primaryKey": "awardFandaRateId"
}

Get Blueprint API specification for Award F And A Rates
GET`/award/api/v1/award-f-and-a-rates/`

Example URI

GET /award/api/v1/award-f-and-a-rates/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award F And A Rates.md"
transfer-encoding: chunked

Award Funding Proposals ¶

Get Award Funding Proposals by Key
GET`/award/api/v1/award-funding-proposals/(key)`

Example URI

GET /award/api/v1/award-funding-proposals/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardFundingProposalId": "(val)",
  "awardId": "(val)",
  "proposalId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Funding Proposals
GET`/award/api/v1/award-funding-proposals/`

Example URI

GET /award/api/v1/award-funding-proposals/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardFundingProposalId": "(val)",
    "awardId": "(val)",
    "proposalId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardFundingProposalId": "(val)",
    "awardId": "(val)",
    "proposalId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Funding Proposals with Filtering
GET`/award/api/v1/award-funding-proposals/`

Example URI

GET /award/api/v1/award-funding-proposals/

URI Parameters

HideShow

awardFundingProposalId: string (optional)
Award Funding Proposal Id. Maximum length is 22.
awardId: string (optional)
Award ID. Maximum length is 22.
proposalId: string (optional)
Proposal ID. Maximum length is 22.
active: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardFundingProposalId": "(val)",
    "awardId": "(val)",
    "proposalId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardFundingProposalId": "(val)",
    "awardId": "(val)",
    "proposalId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Funding Proposals
GET`/award/api/v1/award-funding-proposals/`

Example URI

GET /award/api/v1/award-funding-proposals/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardFundingProposalId",
    "awardId",
    "proposalId",
    "active"
  ],
  "primaryKey": "awardFundingProposalId"
}

Get Blueprint API specification for Award Funding Proposals
GET`/award/api/v1/award-funding-proposals/`

Example URI

GET /award/api/v1/award-funding-proposals/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Funding Proposals.md"
transfer-encoding: chunked

Update Award Funding Proposals
PUT`/award/api/v1/award-funding-proposals/(key)`

Example URI

PUT /award/api/v1/award-funding-proposals/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardFundingProposalId": "(val)",
  "awardId": "(val)",
  "proposalId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Funding Proposals
PUT`/award/api/v1/award-funding-proposals/`

Example URI

PUT /award/api/v1/award-funding-proposals/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardFundingProposalId": "(val)",
    "awardId": "(val)",
    "proposalId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardFundingProposalId": "(val)",
    "awardId": "(val)",
    "proposalId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Funding Proposals
PATCH`/award/api/v1/award-funding-proposals/(key)`

Example URI

PATCH /award/api/v1/award-funding-proposals/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardFundingProposalId": "(val)",
  "awardId": "(val)",
  "proposalId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardFundingProposalId": "(val)",
  "awardId": "(val)",
  "proposalId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Funding Proposals
POST`/award/api/v1/award-funding-proposals/`

Example URI

POST /award/api/v1/award-funding-proposals/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardFundingProposalId": "(val)",
  "awardId": "(val)",
  "proposalId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardFundingProposalId": "(val)",
  "awardId": "(val)",
  "proposalId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Funding Proposals
POST`/award/api/v1/award-funding-proposals/`

Example URI

POST /award/api/v1/award-funding-proposals/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardFundingProposalId": "(val)",
    "awardId": "(val)",
    "proposalId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardFundingProposalId": "(val)",
    "awardId": "(val)",
    "proposalId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardFundingProposalId": "(val)",
    "awardId": "(val)",
    "proposalId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardFundingProposalId": "(val)",
    "awardId": "(val)",
    "proposalId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Funding Proposals by Key
DELETE`/award/api/v1/award-funding-proposals/(key)`

Example URI

DELETE /award/api/v1/award-funding-proposals/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Funding Proposals
DELETE`/award/api/v1/award-funding-proposals/`

Example URI

DELETE /award/api/v1/award-funding-proposals/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Funding Proposals with Matching
DELETE`/award/api/v1/award-funding-proposals/`

Example URI

DELETE /award/api/v1/award-funding-proposals/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardFundingProposalId: string (optional)
Award Funding Proposal Id. Maximum length is 22.
awardId: string (optional)
Award ID. Maximum length is 22.
proposalId: string (optional)
Proposal ID. Maximum length is 22.
active: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Hierarchies ¶

Get Award Hierarchies by Key
GET`/award/api/v1/award-hierarchies/(key)`

Example URI

GET /award/api/v1/award-hierarchies/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardHierarchyId": "(val)",
  "rootAwardNumber": "(val)",
  "awardNumber": "(val)",
  "parentAwardNumber": "(val)",
  "originatingAwardNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Hierarchies
GET`/award/api/v1/award-hierarchies/`

Example URI

GET /award/api/v1/award-hierarchies/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardHierarchyId": "(val)",
    "rootAwardNumber": "(val)",
    "awardNumber": "(val)",
    "parentAwardNumber": "(val)",
    "originatingAwardNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardHierarchyId": "(val)",
    "rootAwardNumber": "(val)",
    "awardNumber": "(val)",
    "parentAwardNumber": "(val)",
    "originatingAwardNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Hierarchies with Filtering
GET`/award/api/v1/award-hierarchies/`

Example URI

GET /award/api/v1/award-hierarchies/

URI Parameters

HideShow

awardHierarchyId: string (optional)
rootAwardNumber: string (optional)
Root Award Number. Maximum length is 12.
awardNumber: string (optional)
Award ID. Maximum length is 12.
parentAwardNumber: string (optional)
Parent Award Number. Maximum length is 12.
originatingAwardNumber: string (optional)
active: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardHierarchyId": "(val)",
    "rootAwardNumber": "(val)",
    "awardNumber": "(val)",
    "parentAwardNumber": "(val)",
    "originatingAwardNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardHierarchyId": "(val)",
    "rootAwardNumber": "(val)",
    "awardNumber": "(val)",
    "parentAwardNumber": "(val)",
    "originatingAwardNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Hierarchies
GET`/award/api/v1/award-hierarchies/`

Example URI

GET /award/api/v1/award-hierarchies/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardHierarchyId",
    "rootAwardNumber",
    "awardNumber",
    "parentAwardNumber",
    "originatingAwardNumber",
    "active"
  ],
  "primaryKey": "awardHierarchyId"
}

Get Blueprint API specification for Award Hierarchies
GET`/award/api/v1/award-hierarchies/`

Example URI

GET /award/api/v1/award-hierarchies/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Hierarchies.md"
transfer-encoding: chunked

Update Award Hierarchies
PUT`/award/api/v1/award-hierarchies/(key)`

Example URI

PUT /award/api/v1/award-hierarchies/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardHierarchyId": "(val)",
  "rootAwardNumber": "(val)",
  "awardNumber": "(val)",
  "parentAwardNumber": "(val)",
  "originatingAwardNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Hierarchies
PUT`/award/api/v1/award-hierarchies/`

Example URI

PUT /award/api/v1/award-hierarchies/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardHierarchyId": "(val)",
    "rootAwardNumber": "(val)",
    "awardNumber": "(val)",
    "parentAwardNumber": "(val)",
    "originatingAwardNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardHierarchyId": "(val)",
    "rootAwardNumber": "(val)",
    "awardNumber": "(val)",
    "parentAwardNumber": "(val)",
    "originatingAwardNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Hierarchies
PATCH`/award/api/v1/award-hierarchies/(key)`

Example URI

PATCH /award/api/v1/award-hierarchies/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardHierarchyId": "(val)",
  "rootAwardNumber": "(val)",
  "awardNumber": "(val)",
  "parentAwardNumber": "(val)",
  "originatingAwardNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardHierarchyId": "(val)",
  "rootAwardNumber": "(val)",
  "awardNumber": "(val)",
  "parentAwardNumber": "(val)",
  "originatingAwardNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Hierarchies
POST`/award/api/v1/award-hierarchies/`

Example URI

POST /award/api/v1/award-hierarchies/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardHierarchyId": "(val)",
  "rootAwardNumber": "(val)",
  "awardNumber": "(val)",
  "parentAwardNumber": "(val)",
  "originatingAwardNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardHierarchyId": "(val)",
  "rootAwardNumber": "(val)",
  "awardNumber": "(val)",
  "parentAwardNumber": "(val)",
  "originatingAwardNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Hierarchies
POST`/award/api/v1/award-hierarchies/`

Example URI

POST /award/api/v1/award-hierarchies/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardHierarchyId": "(val)",
    "rootAwardNumber": "(val)",
    "awardNumber": "(val)",
    "parentAwardNumber": "(val)",
    "originatingAwardNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardHierarchyId": "(val)",
    "rootAwardNumber": "(val)",
    "awardNumber": "(val)",
    "parentAwardNumber": "(val)",
    "originatingAwardNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardHierarchyId": "(val)",
    "rootAwardNumber": "(val)",
    "awardNumber": "(val)",
    "parentAwardNumber": "(val)",
    "originatingAwardNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardHierarchyId": "(val)",
    "rootAwardNumber": "(val)",
    "awardNumber": "(val)",
    "parentAwardNumber": "(val)",
    "originatingAwardNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Hierarchies by Key
DELETE`/award/api/v1/award-hierarchies/(key)`

Example URI

DELETE /award/api/v1/award-hierarchies/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Hierarchies
DELETE`/award/api/v1/award-hierarchies/`

Example URI

DELETE /award/api/v1/award-hierarchies/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Hierarchies with Matching
DELETE`/award/api/v1/award-hierarchies/`

Example URI

DELETE /award/api/v1/award-hierarchies/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardHierarchyId: string (optional)
rootAwardNumber: string (optional)
Root Award Number. Maximum length is 12.
awardNumber: string (optional)
Award ID. Maximum length is 12.
parentAwardNumber: string (optional)
Parent Award Number. Maximum length is 12.
originatingAwardNumber: string (optional)
active: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Hierarchy Nodes ¶

Get Award Hierarchy Nodes by Key
GET`/award/api/v1/award-hierarchy-nodes/(key)`

Example URI

GET /award/api/v1/award-hierarchy-nodes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardHierarchyId": "(val)",
  "rootAwardNumber": "(val)",
  "awardNumber": "(val)",
  "parentAwardNumber": "(val)",
  "originatingAwardNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Hierarchy Nodes
GET`/award/api/v1/award-hierarchy-nodes/`

Example URI

GET /award/api/v1/award-hierarchy-nodes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardHierarchyId": "(val)",
    "rootAwardNumber": "(val)",
    "awardNumber": "(val)",
    "parentAwardNumber": "(val)",
    "originatingAwardNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardHierarchyId": "(val)",
    "rootAwardNumber": "(val)",
    "awardNumber": "(val)",
    "parentAwardNumber": "(val)",
    "originatingAwardNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Hierarchy Nodes with Filtering
GET`/award/api/v1/award-hierarchy-nodes/`

Example URI

GET /award/api/v1/award-hierarchy-nodes/

URI Parameters

HideShow

awardHierarchyId: string (optional)
rootAwardNumber: string (optional)
Root Award Number. Maximum length is 12.
awardNumber: string (optional)
Award ID. Maximum length is 12.
parentAwardNumber: string (optional)
Parent Award Number. Maximum length is 12.
originatingAwardNumber: string (optional)
active: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardHierarchyId": "(val)",
    "rootAwardNumber": "(val)",
    "awardNumber": "(val)",
    "parentAwardNumber": "(val)",
    "originatingAwardNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardHierarchyId": "(val)",
    "rootAwardNumber": "(val)",
    "awardNumber": "(val)",
    "parentAwardNumber": "(val)",
    "originatingAwardNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Hierarchy Nodes
GET`/award/api/v1/award-hierarchy-nodes/`

Example URI

GET /award/api/v1/award-hierarchy-nodes/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardHierarchyId",
    "rootAwardNumber",
    "awardNumber",
    "parentAwardNumber",
    "originatingAwardNumber",
    "active"
  ],
  "primaryKey": "awardHierarchyId"
}

Get Blueprint API specification for Award Hierarchy Nodes
GET`/award/api/v1/award-hierarchy-nodes/`

Example URI

GET /award/api/v1/award-hierarchy-nodes/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Hierarchy Nodes.md"
transfer-encoding: chunked

Update Award Hierarchy Nodes
PUT`/award/api/v1/award-hierarchy-nodes/(key)`

Example URI

PUT /award/api/v1/award-hierarchy-nodes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardHierarchyId": "(val)",
  "rootAwardNumber": "(val)",
  "awardNumber": "(val)",
  "parentAwardNumber": "(val)",
  "originatingAwardNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Hierarchy Nodes
PUT`/award/api/v1/award-hierarchy-nodes/`

Example URI

PUT /award/api/v1/award-hierarchy-nodes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardHierarchyId": "(val)",
    "rootAwardNumber": "(val)",
    "awardNumber": "(val)",
    "parentAwardNumber": "(val)",
    "originatingAwardNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardHierarchyId": "(val)",
    "rootAwardNumber": "(val)",
    "awardNumber": "(val)",
    "parentAwardNumber": "(val)",
    "originatingAwardNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Hierarchy Nodes
PATCH`/award/api/v1/award-hierarchy-nodes/(key)`

Example URI

PATCH /award/api/v1/award-hierarchy-nodes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardHierarchyId": "(val)",
  "rootAwardNumber": "(val)",
  "awardNumber": "(val)",
  "parentAwardNumber": "(val)",
  "originatingAwardNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardHierarchyId": "(val)",
  "rootAwardNumber": "(val)",
  "awardNumber": "(val)",
  "parentAwardNumber": "(val)",
  "originatingAwardNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Hierarchy Nodes
POST`/award/api/v1/award-hierarchy-nodes/`

Example URI

POST /award/api/v1/award-hierarchy-nodes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardHierarchyId": "(val)",
  "rootAwardNumber": "(val)",
  "awardNumber": "(val)",
  "parentAwardNumber": "(val)",
  "originatingAwardNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardHierarchyId": "(val)",
  "rootAwardNumber": "(val)",
  "awardNumber": "(val)",
  "parentAwardNumber": "(val)",
  "originatingAwardNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Hierarchy Nodes
POST`/award/api/v1/award-hierarchy-nodes/`

Example URI

POST /award/api/v1/award-hierarchy-nodes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardHierarchyId": "(val)",
    "rootAwardNumber": "(val)",
    "awardNumber": "(val)",
    "parentAwardNumber": "(val)",
    "originatingAwardNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardHierarchyId": "(val)",
    "rootAwardNumber": "(val)",
    "awardNumber": "(val)",
    "parentAwardNumber": "(val)",
    "originatingAwardNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardHierarchyId": "(val)",
    "rootAwardNumber": "(val)",
    "awardNumber": "(val)",
    "parentAwardNumber": "(val)",
    "originatingAwardNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardHierarchyId": "(val)",
    "rootAwardNumber": "(val)",
    "awardNumber": "(val)",
    "parentAwardNumber": "(val)",
    "originatingAwardNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Hierarchy Nodes by Key
DELETE`/award/api/v1/award-hierarchy-nodes/(key)`

Example URI

DELETE /award/api/v1/award-hierarchy-nodes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Hierarchy Nodes
DELETE`/award/api/v1/award-hierarchy-nodes/`

Example URI

DELETE /award/api/v1/award-hierarchy-nodes/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Hierarchy Nodes with Matching
DELETE`/award/api/v1/award-hierarchy-nodes/`

Example URI

DELETE /award/api/v1/award-hierarchy-nodes/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardHierarchyId: string (optional)
rootAwardNumber: string (optional)
Root Award Number. Maximum length is 12.
awardNumber: string (optional)
Award ID. Maximum length is 12.
parentAwardNumber: string (optional)
Parent Award Number. Maximum length is 12.
originatingAwardNumber: string (optional)
active: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Method Of Payments ¶

Get Award Method Of Payments by Key
GET`/award/api/v1/award-method-of-payments/(key)`

Example URI

GET /award/api/v1/award-method-of-payments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "methodOfPaymentCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Method Of Payments
GET`/award/api/v1/award-method-of-payments/`

Example URI

GET /award/api/v1/award-method-of-payments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "methodOfPaymentCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "methodOfPaymentCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Method Of Payments with Filtering
GET`/award/api/v1/award-method-of-payments/`

Example URI

GET /award/api/v1/award-method-of-payments/

URI Parameters

HideShow

methodOfPaymentCode: string (optional)
Method Of Payment Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "methodOfPaymentCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "methodOfPaymentCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Method Of Payments
GET`/award/api/v1/award-method-of-payments/`

Example URI

GET /award/api/v1/award-method-of-payments/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "methodOfPaymentCode",
    "description"
  ],
  "primaryKey": "methodOfPaymentCode"
}

Get Blueprint API specification for Award Method Of Payments
GET`/award/api/v1/award-method-of-payments/`

Example URI

GET /award/api/v1/award-method-of-payments/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Method Of Payments.md"
transfer-encoding: chunked

Update Award Method Of Payments
PUT`/award/api/v1/award-method-of-payments/(key)`

Example URI

PUT /award/api/v1/award-method-of-payments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "methodOfPaymentCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Method Of Payments
PUT`/award/api/v1/award-method-of-payments/`

Example URI

PUT /award/api/v1/award-method-of-payments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "methodOfPaymentCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "methodOfPaymentCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Method Of Payments
PATCH`/award/api/v1/award-method-of-payments/(key)`

Example URI

PATCH /award/api/v1/award-method-of-payments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "methodOfPaymentCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "methodOfPaymentCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Method Of Payments
POST`/award/api/v1/award-method-of-payments/`

Example URI

POST /award/api/v1/award-method-of-payments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "methodOfPaymentCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "methodOfPaymentCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Method Of Payments
POST`/award/api/v1/award-method-of-payments/`

Example URI

POST /award/api/v1/award-method-of-payments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "methodOfPaymentCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "methodOfPaymentCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "methodOfPaymentCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "methodOfPaymentCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Method Of Payments by Key
DELETE`/award/api/v1/award-method-of-payments/(key)`

Example URI

DELETE /award/api/v1/award-method-of-payments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Method Of Payments
DELETE`/award/api/v1/award-method-of-payments/`

Example URI

DELETE /award/api/v1/award-method-of-payments/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Method Of Payments with Matching
DELETE`/award/api/v1/award-method-of-payments/`

Example URI

DELETE /award/api/v1/award-method-of-payments/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
methodOfPaymentCode: string (optional)
Method Of Payment Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Notepads ¶

Get Award Notepads by Key
GET`/award/api/v1/award-notepads/(key)`

Example URI

GET /award/api/v1/award-notepads/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardNotepadId": "(val)",
  "awardNumber": "(val)",
  "entryNumber": "(val)",
  "noteTopic": "(val)",
  "comments": "(val)",
  "restrictedView": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Notepads
GET`/award/api/v1/award-notepads/`

Example URI

GET /award/api/v1/award-notepads/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardNotepadId": "(val)",
    "awardNumber": "(val)",
    "entryNumber": "(val)",
    "noteTopic": "(val)",
    "comments": "(val)",
    "restrictedView": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNotepadId": "(val)",
    "awardNumber": "(val)",
    "entryNumber": "(val)",
    "noteTopic": "(val)",
    "comments": "(val)",
    "restrictedView": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Notepads with Filtering
GET`/award/api/v1/award-notepads/`

Example URI

GET /award/api/v1/award-notepads/

URI Parameters

HideShow

awardNotepadId: string (optional)
Award Notepad Id. Maximum length is 22.
awardNumber: string (optional)
Award ID. Maximum length is 12.
entryNumber: string (optional)
Entry Number. Maximum length is 22.
noteTopic: string (optional)
Comments. Maximum length is 60.
comments: string (optional)
Comments. Maximum length is 4000.
restrictedView: string (optional)
Restricted View. Maximum length is 1.
createTimestamp: string (optional)
Posted Timestamp. Maximum length is 10.
createUser: string (optional)
The user who created or last modified the object. Maximum length is 60.
award.awardId: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardNotepadId": "(val)",
    "awardNumber": "(val)",
    "entryNumber": "(val)",
    "noteTopic": "(val)",
    "comments": "(val)",
    "restrictedView": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNotepadId": "(val)",
    "awardNumber": "(val)",
    "entryNumber": "(val)",
    "noteTopic": "(val)",
    "comments": "(val)",
    "restrictedView": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Notepads
GET`/award/api/v1/award-notepads/`

Example URI

GET /award/api/v1/award-notepads/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardNotepadId",
    "awardNumber",
    "entryNumber",
    "noteTopic",
    "comments",
    "restrictedView",
    "createTimestamp",
    "createUser",
    "award.awardId"
  ],
  "primaryKey": "awardNotepadId"
}

Get Blueprint API specification for Award Notepads
GET`/award/api/v1/award-notepads/`

Example URI

GET /award/api/v1/award-notepads/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Notepads.md"
transfer-encoding: chunked

Award Notice Printouts ¶

Get Award Notice Printouts by Key
GET`/award/api/v1/award-notice-printouts/(key)`

Example URI

GET /award/api/v1/award-notice-printouts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardNoticeId": "(val)",
  "awardId": "(val)",
  "awardNumber": "(val)",
  "unitNumber": "(val)",
  "pdfContent": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Notice Printouts
GET`/award/api/v1/award-notice-printouts/`

Example URI

GET /award/api/v1/award-notice-printouts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardNoticeId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "unitNumber": "(val)",
    "pdfContent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNoticeId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "unitNumber": "(val)",
    "pdfContent": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Notice Printouts with Filtering
GET`/award/api/v1/award-notice-printouts/`

Example URI

GET /award/api/v1/award-notice-printouts/

URI Parameters

HideShow

awardNoticeId: string (optional)
awardId: string (optional)
awardNumber: string (optional)
unitNumber: string (optional)
pdfContent: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardNoticeId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "unitNumber": "(val)",
    "pdfContent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNoticeId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "unitNumber": "(val)",
    "pdfContent": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Notice Printouts
GET`/award/api/v1/award-notice-printouts/`

Example URI

GET /award/api/v1/award-notice-printouts/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardNoticeId",
    "awardId",
    "awardNumber",
    "unitNumber",
    "pdfContent"
  ],
  "primaryKey": "awardNoticeId"
}

Get Blueprint API specification for Award Notice Printouts
GET`/award/api/v1/award-notice-printouts/`

Example URI

GET /award/api/v1/award-notice-printouts/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Notice Printouts.md"
transfer-encoding: chunked

Update Award Notice Printouts
PUT`/award/api/v1/award-notice-printouts/(key)`

Example URI

PUT /award/api/v1/award-notice-printouts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardNoticeId": "(val)",
  "awardId": "(val)",
  "awardNumber": "(val)",
  "unitNumber": "(val)",
  "pdfContent": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Notice Printouts
PUT`/award/api/v1/award-notice-printouts/`

Example URI

PUT /award/api/v1/award-notice-printouts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardNoticeId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "unitNumber": "(val)",
    "pdfContent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNoticeId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "unitNumber": "(val)",
    "pdfContent": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Notice Printouts
PATCH`/award/api/v1/award-notice-printouts/(key)`

Example URI

PATCH /award/api/v1/award-notice-printouts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardNoticeId": "(val)",
  "awardId": "(val)",
  "awardNumber": "(val)",
  "unitNumber": "(val)",
  "pdfContent": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardNoticeId": "(val)",
  "awardId": "(val)",
  "awardNumber": "(val)",
  "unitNumber": "(val)",
  "pdfContent": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Notice Printouts
POST`/award/api/v1/award-notice-printouts/`

Example URI

POST /award/api/v1/award-notice-printouts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardNoticeId": "(val)",
  "awardId": "(val)",
  "awardNumber": "(val)",
  "unitNumber": "(val)",
  "pdfContent": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardNoticeId": "(val)",
  "awardId": "(val)",
  "awardNumber": "(val)",
  "unitNumber": "(val)",
  "pdfContent": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Notice Printouts
POST`/award/api/v1/award-notice-printouts/`

Example URI

POST /award/api/v1/award-notice-printouts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardNoticeId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "unitNumber": "(val)",
    "pdfContent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNoticeId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "unitNumber": "(val)",
    "pdfContent": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardNoticeId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "unitNumber": "(val)",
    "pdfContent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNoticeId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "unitNumber": "(val)",
    "pdfContent": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Notice Printouts by Key
DELETE`/award/api/v1/award-notice-printouts/(key)`

Example URI

DELETE /award/api/v1/award-notice-printouts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Notice Printouts
DELETE`/award/api/v1/award-notice-printouts/`

Example URI

DELETE /award/api/v1/award-notice-printouts/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Notice Printouts with Matching
DELETE`/award/api/v1/award-notice-printouts/`

Example URI

DELETE /award/api/v1/award-notice-printouts/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardNoticeId: string (optional)
awardId: string (optional)
awardNumber: string (optional)
unitNumber: string (optional)
pdfContent: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Payment Schedules ¶

Get Award Payment Schedules by Key
GET`/award/api/v1/award-payment-schedules/(key)`

Example URI

GET /award/api/v1/award-payment-schedules/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardPaymentScheduleId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "awardReportTermId": "(val)",
  "dueDate": "(val)",
  "amount": "(val)",
  "submitDate": "(val)",
  "submittedBy": "(val)",
  "invoiceNumber": "(val)",
  "statusDescription": "(val)",
  "status": "(val)",
  "lastUpdateUser": "(val)",
  "lastUpdateTimestamp": "(val)",
  "overdue": "(val)",
  "reportStatusCode": "(val)",
  "submittedByPersonId": "(val)",
  "awardReportTermDescription": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Payment Schedules
GET`/award/api/v1/award-payment-schedules/`

Example URI

GET /award/api/v1/award-payment-schedules/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardPaymentScheduleId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "awardReportTermId": "(val)",
    "dueDate": "(val)",
    "amount": "(val)",
    "submitDate": "(val)",
    "submittedBy": "(val)",
    "invoiceNumber": "(val)",
    "statusDescription": "(val)",
    "status": "(val)",
    "lastUpdateUser": "(val)",
    "lastUpdateTimestamp": "(val)",
    "overdue": "(val)",
    "reportStatusCode": "(val)",
    "submittedByPersonId": "(val)",
    "awardReportTermDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPaymentScheduleId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "awardReportTermId": "(val)",
    "dueDate": "(val)",
    "amount": "(val)",
    "submitDate": "(val)",
    "submittedBy": "(val)",
    "invoiceNumber": "(val)",
    "statusDescription": "(val)",
    "status": "(val)",
    "lastUpdateUser": "(val)",
    "lastUpdateTimestamp": "(val)",
    "overdue": "(val)",
    "reportStatusCode": "(val)",
    "submittedByPersonId": "(val)",
    "awardReportTermDescription": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Payment Schedules with Filtering
GET`/award/api/v1/award-payment-schedules/`

Example URI

GET /award/api/v1/award-payment-schedules/

URI Parameters

HideShow

awardPaymentScheduleId: string (optional)
Award Payment Schedule Id. Maximum length is 22.
awardNumber: string (optional)
Award ID. Maximum length is 12.
sequenceNumber: string (optional)
Sequence Number. Maximum length is 22.
awardReportTermId: string (optional)
dueDate: string (optional)
Due Date. Maximum length is 10.
amount: string (optional)
Amount. Maximum length is 22.
submitDate: string (optional)
Activity Date. Maximum length is 10.
submittedBy: string (optional)
Preparer. Maximum length is 9.
invoiceNumber: string (optional)
Invoice ID. Maximum length is 10.
statusDescription: string (optional)
Comments. Maximum length is 200.
status: string (optional)
Status. Maximum length is 5.
lastUpdateUser: string (optional)
lastUpdateTimestamp: string (optional)
overdue: string (optional)
Overdue. Maximum length is 15.
reportStatusCode: string (optional)
Status. Maximum length is 22.
submittedByPersonId: string (optional)
Preparer. Maximum length is 40.
awardReportTermDescription: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardPaymentScheduleId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "awardReportTermId": "(val)",
    "dueDate": "(val)",
    "amount": "(val)",
    "submitDate": "(val)",
    "submittedBy": "(val)",
    "invoiceNumber": "(val)",
    "statusDescription": "(val)",
    "status": "(val)",
    "lastUpdateUser": "(val)",
    "lastUpdateTimestamp": "(val)",
    "overdue": "(val)",
    "reportStatusCode": "(val)",
    "submittedByPersonId": "(val)",
    "awardReportTermDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPaymentScheduleId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "awardReportTermId": "(val)",
    "dueDate": "(val)",
    "amount": "(val)",
    "submitDate": "(val)",
    "submittedBy": "(val)",
    "invoiceNumber": "(val)",
    "statusDescription": "(val)",
    "status": "(val)",
    "lastUpdateUser": "(val)",
    "lastUpdateTimestamp": "(val)",
    "overdue": "(val)",
    "reportStatusCode": "(val)",
    "submittedByPersonId": "(val)",
    "awardReportTermDescription": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Payment Schedules
GET`/award/api/v1/award-payment-schedules/`

Example URI

GET /award/api/v1/award-payment-schedules/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardPaymentScheduleId",
    "awardNumber",
    "sequenceNumber",
    "awardReportTermId",
    "dueDate",
    "amount",
    "submitDate",
    "submittedBy",
    "invoiceNumber",
    "statusDescription",
    "status",
    "lastUpdateUser",
    "lastUpdateTimestamp",
    "overdue",
    "reportStatusCode",
    "submittedByPersonId",
    "awardReportTermDescription"
  ],
  "primaryKey": "awardPaymentScheduleId"
}

Get Blueprint API specification for Award Payment Schedules
GET`/award/api/v1/award-payment-schedules/`

Example URI

GET /award/api/v1/award-payment-schedules/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Payment Schedules.md"
transfer-encoding: chunked

Award Person Credit Splits ¶

Get Award Person Credit Splits by Key
GET`/award/api/v1/award-person-credit-splits/(key)`

Example URI

GET /award/api/v1/award-person-credit-splits/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardPersonCreditSplitId": "(val)",
  "awardContactId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Person Credit Splits
GET`/award/api/v1/award-person-credit-splits/`

Example URI

GET /award/api/v1/award-person-credit-splits/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardPersonCreditSplitId": "(val)",
    "awardContactId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPersonCreditSplitId": "(val)",
    "awardContactId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Person Credit Splits with Filtering
GET`/award/api/v1/award-person-credit-splits/`

Example URI

GET /award/api/v1/award-person-credit-splits/

URI Parameters

HideShow

awardPersonCreditSplitId: string (optional)
awardContactId: string (optional)
invCreditTypeCode: string (optional)
credit: string (optional)
Credit. Maximum length is 6.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardPersonCreditSplitId": "(val)",
    "awardContactId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPersonCreditSplitId": "(val)",
    "awardContactId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Person Credit Splits
GET`/award/api/v1/award-person-credit-splits/`

Example URI

GET /award/api/v1/award-person-credit-splits/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardPersonCreditSplitId",
    "awardContactId",
    "invCreditTypeCode",
    "credit"
  ],
  "primaryKey": "awardPersonCreditSplitId"
}

Get Blueprint API specification for Award Person Credit Splits
GET`/award/api/v1/award-person-credit-splits/`

Example URI

GET /award/api/v1/award-person-credit-splits/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Person Credit Splits.md"
transfer-encoding: chunked

Update Award Person Credit Splits
PUT`/award/api/v1/award-person-credit-splits/(key)`

Example URI

PUT /award/api/v1/award-person-credit-splits/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardPersonCreditSplitId": "(val)",
  "awardContactId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Person Credit Splits
PUT`/award/api/v1/award-person-credit-splits/`

Example URI

PUT /award/api/v1/award-person-credit-splits/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardPersonCreditSplitId": "(val)",
    "awardContactId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPersonCreditSplitId": "(val)",
    "awardContactId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Person Credit Splits
PATCH`/award/api/v1/award-person-credit-splits/(key)`

Example URI

PATCH /award/api/v1/award-person-credit-splits/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardPersonCreditSplitId": "(val)",
  "awardContactId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardPersonCreditSplitId": "(val)",
  "awardContactId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Person Credit Splits
POST`/award/api/v1/award-person-credit-splits/`

Example URI

POST /award/api/v1/award-person-credit-splits/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardPersonCreditSplitId": "(val)",
  "awardContactId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardPersonCreditSplitId": "(val)",
  "awardContactId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Person Credit Splits
POST`/award/api/v1/award-person-credit-splits/`

Example URI

POST /award/api/v1/award-person-credit-splits/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardPersonCreditSplitId": "(val)",
    "awardContactId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPersonCreditSplitId": "(val)",
    "awardContactId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardPersonCreditSplitId": "(val)",
    "awardContactId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPersonCreditSplitId": "(val)",
    "awardContactId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Person Credit Splits by Key
DELETE`/award/api/v1/award-person-credit-splits/(key)`

Example URI

DELETE /award/api/v1/award-person-credit-splits/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Person Credit Splits
DELETE`/award/api/v1/award-person-credit-splits/`

Example URI

DELETE /award/api/v1/award-person-credit-splits/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Person Credit Splits with Matching
DELETE`/award/api/v1/award-person-credit-splits/`

Example URI

DELETE /award/api/v1/award-person-credit-splits/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardPersonCreditSplitId: string (optional)
awardContactId: string (optional)
invCreditTypeCode: string (optional)
credit: string (optional)
Credit. Maximum length is 6.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Person Mass Changes ¶

Get Award Person Mass Changes by Key
GET`/award/api/v1/award-person-mass-changes/(key)`

Example URI

GET /award/api/v1/award-person-mass-changes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "investigator": "(val)",
  "keyStudyPerson": "(val)",
  "unitContact": "(val)",
  "sponsorContact": "(val)",
  "approvedForeignTravel": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Person Mass Changes
GET`/award/api/v1/award-person-mass-changes/`

Example URI

GET /award/api/v1/award-person-mass-changes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "unitContact": "(val)",
    "sponsorContact": "(val)",
    "approvedForeignTravel": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "unitContact": "(val)",
    "sponsorContact": "(val)",
    "approvedForeignTravel": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Person Mass Changes with Filtering
GET`/award/api/v1/award-person-mass-changes/`

Example URI

GET /award/api/v1/award-person-mass-changes/

URI Parameters

HideShow

awardPersonMassChangeId: string (optional)
Award Person Mass Change Id. Maximum length is 12.
personMassChangeId: string (optional)
Person Mass Change Id. Maximum length is 12.
investigator: string (optional)
Investigator. Maximum length is 1.
keyStudyPerson: string (optional)
Key Study Person. Maximum length is 1.
unitContact: string (optional)
Unit Contact. Maximum length is 1.
sponsorContact: string (optional)
Sponsor Contact. Maximum length is 1.
approvedForeignTravel: string (optional)
Approved Foreign Travel. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "unitContact": "(val)",
    "sponsorContact": "(val)",
    "approvedForeignTravel": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "unitContact": "(val)",
    "sponsorContact": "(val)",
    "approvedForeignTravel": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Person Mass Changes
GET`/award/api/v1/award-person-mass-changes/`

Example URI

GET /award/api/v1/award-person-mass-changes/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardPersonMassChangeId",
    "personMassChangeId",
    "investigator",
    "keyStudyPerson",
    "unitContact",
    "sponsorContact",
    "approvedForeignTravel"
  ],
  "primaryKey": "awardPersonMassChangeId"
}

Get Blueprint API specification for Award Person Mass Changes
GET`/award/api/v1/award-person-mass-changes/`

Example URI

GET /award/api/v1/award-person-mass-changes/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Person Mass Changes.md"
transfer-encoding: chunked

Update Award Person Mass Changes
PUT`/award/api/v1/award-person-mass-changes/(key)`

Example URI

PUT /award/api/v1/award-person-mass-changes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "investigator": "(val)",
  "keyStudyPerson": "(val)",
  "unitContact": "(val)",
  "sponsorContact": "(val)",
  "approvedForeignTravel": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Person Mass Changes
PUT`/award/api/v1/award-person-mass-changes/`

Example URI

PUT /award/api/v1/award-person-mass-changes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "unitContact": "(val)",
    "sponsorContact": "(val)",
    "approvedForeignTravel": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "unitContact": "(val)",
    "sponsorContact": "(val)",
    "approvedForeignTravel": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Person Mass Changes
PATCH`/award/api/v1/award-person-mass-changes/(key)`

Example URI

PATCH /award/api/v1/award-person-mass-changes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "investigator": "(val)",
  "keyStudyPerson": "(val)",
  "unitContact": "(val)",
  "sponsorContact": "(val)",
  "approvedForeignTravel": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "investigator": "(val)",
  "keyStudyPerson": "(val)",
  "unitContact": "(val)",
  "sponsorContact": "(val)",
  "approvedForeignTravel": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Person Mass Changes
POST`/award/api/v1/award-person-mass-changes/`

Example URI

POST /award/api/v1/award-person-mass-changes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "investigator": "(val)",
  "keyStudyPerson": "(val)",
  "unitContact": "(val)",
  "sponsorContact": "(val)",
  "approvedForeignTravel": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "investigator": "(val)",
  "keyStudyPerson": "(val)",
  "unitContact": "(val)",
  "sponsorContact": "(val)",
  "approvedForeignTravel": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Person Mass Changes
POST`/award/api/v1/award-person-mass-changes/`

Example URI

POST /award/api/v1/award-person-mass-changes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "unitContact": "(val)",
    "sponsorContact": "(val)",
    "approvedForeignTravel": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "unitContact": "(val)",
    "sponsorContact": "(val)",
    "approvedForeignTravel": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "unitContact": "(val)",
    "sponsorContact": "(val)",
    "approvedForeignTravel": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "unitContact": "(val)",
    "sponsorContact": "(val)",
    "approvedForeignTravel": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Person Mass Changes by Key
DELETE`/award/api/v1/award-person-mass-changes/(key)`

Example URI

DELETE /award/api/v1/award-person-mass-changes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Person Mass Changes
DELETE`/award/api/v1/award-person-mass-changes/`

Example URI

DELETE /award/api/v1/award-person-mass-changes/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Person Mass Changes with Matching
DELETE`/award/api/v1/award-person-mass-changes/`

Example URI

DELETE /award/api/v1/award-person-mass-changes/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardPersonMassChangeId: string (optional)
Award Person Mass Change Id. Maximum length is 12.
personMassChangeId: string (optional)
Person Mass Change Id. Maximum length is 12.
investigator: string (optional)
Investigator. Maximum length is 1.
keyStudyPerson: string (optional)
Key Study Person. Maximum length is 1.
unitContact: string (optional)
Unit Contact. Maximum length is 1.
sponsorContact: string (optional)
Sponsor Contact. Maximum length is 1.
approvedForeignTravel: string (optional)
Approved Foreign Travel. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Person Unit Credit Splits ¶

Get Award Person Unit Credit Splits by Key
GET`/award/api/v1/award-person-unit-credit-splits/(key)`

Example URI

GET /award/api/v1/award-person-unit-credit-splits/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardPersonUnitCreditSplitId": "(val)",
  "awardPersonUnitId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Person Unit Credit Splits
GET`/award/api/v1/award-person-unit-credit-splits/`

Example URI

GET /award/api/v1/award-person-unit-credit-splits/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardPersonUnitCreditSplitId": "(val)",
    "awardPersonUnitId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPersonUnitCreditSplitId": "(val)",
    "awardPersonUnitId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Person Unit Credit Splits with Filtering
GET`/award/api/v1/award-person-unit-credit-splits/`

Example URI

GET /award/api/v1/award-person-unit-credit-splits/

URI Parameters

HideShow

awardPersonUnitCreditSplitId: string (optional)
awardPersonUnitId: string (optional)
invCreditTypeCode: string (optional)
credit: string (optional)
Credit. Maximum length is 6.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardPersonUnitCreditSplitId": "(val)",
    "awardPersonUnitId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPersonUnitCreditSplitId": "(val)",
    "awardPersonUnitId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Person Unit Credit Splits
GET`/award/api/v1/award-person-unit-credit-splits/`

Example URI

GET /award/api/v1/award-person-unit-credit-splits/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardPersonUnitCreditSplitId",
    "awardPersonUnitId",
    "invCreditTypeCode",
    "credit"
  ],
  "primaryKey": "awardPersonUnitCreditSplitId"
}

Get Blueprint API specification for Award Person Unit Credit Splits
GET`/award/api/v1/award-person-unit-credit-splits/`

Example URI

GET /award/api/v1/award-person-unit-credit-splits/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Person Unit Credit Splits.md"
transfer-encoding: chunked

Update Award Person Unit Credit Splits
PUT`/award/api/v1/award-person-unit-credit-splits/(key)`

Example URI

PUT /award/api/v1/award-person-unit-credit-splits/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardPersonUnitCreditSplitId": "(val)",
  "awardPersonUnitId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Person Unit Credit Splits
PUT`/award/api/v1/award-person-unit-credit-splits/`

Example URI

PUT /award/api/v1/award-person-unit-credit-splits/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardPersonUnitCreditSplitId": "(val)",
    "awardPersonUnitId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPersonUnitCreditSplitId": "(val)",
    "awardPersonUnitId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Person Unit Credit Splits
PATCH`/award/api/v1/award-person-unit-credit-splits/(key)`

Example URI

PATCH /award/api/v1/award-person-unit-credit-splits/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardPersonUnitCreditSplitId": "(val)",
  "awardPersonUnitId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardPersonUnitCreditSplitId": "(val)",
  "awardPersonUnitId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Person Unit Credit Splits
POST`/award/api/v1/award-person-unit-credit-splits/`

Example URI

POST /award/api/v1/award-person-unit-credit-splits/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardPersonUnitCreditSplitId": "(val)",
  "awardPersonUnitId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardPersonUnitCreditSplitId": "(val)",
  "awardPersonUnitId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Person Unit Credit Splits
POST`/award/api/v1/award-person-unit-credit-splits/`

Example URI

POST /award/api/v1/award-person-unit-credit-splits/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardPersonUnitCreditSplitId": "(val)",
    "awardPersonUnitId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPersonUnitCreditSplitId": "(val)",
    "awardPersonUnitId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardPersonUnitCreditSplitId": "(val)",
    "awardPersonUnitId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPersonUnitCreditSplitId": "(val)",
    "awardPersonUnitId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Person Unit Credit Splits by Key
DELETE`/award/api/v1/award-person-unit-credit-splits/(key)`

Example URI

DELETE /award/api/v1/award-person-unit-credit-splits/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Person Unit Credit Splits
DELETE`/award/api/v1/award-person-unit-credit-splits/`

Example URI

DELETE /award/api/v1/award-person-unit-credit-splits/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Person Unit Credit Splits with Matching
DELETE`/award/api/v1/award-person-unit-credit-splits/`

Example URI

DELETE /award/api/v1/award-person-unit-credit-splits/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardPersonUnitCreditSplitId: string (optional)
awardPersonUnitId: string (optional)
invCreditTypeCode: string (optional)
credit: string (optional)
Credit. Maximum length is 6.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Person Units ¶

Get Award Person Units by Key
GET`/award/api/v1/award-person-units/(key)`

Example URI

GET /award/api/v1/award-person-units/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardPersonUnitId": "(val)",
  "awardContactId": "(val)",
  "unitNumber": "(val)",
  "leadUnit": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Person Units
GET`/award/api/v1/award-person-units/`

Example URI

GET /award/api/v1/award-person-units/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardPersonUnitId": "(val)",
    "awardContactId": "(val)",
    "unitNumber": "(val)",
    "leadUnit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPersonUnitId": "(val)",
    "awardContactId": "(val)",
    "unitNumber": "(val)",
    "leadUnit": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Person Units with Filtering
GET`/award/api/v1/award-person-units/`

Example URI

GET /award/api/v1/award-person-units/

URI Parameters

HideShow

awardPersonUnitId: string (optional)
AwardPersonUnit ID. Maximum length is 8.
awardContactId: string (optional)
unitNumber: string (optional)
Unit Number. Maximum length is 20.
leadUnit: string (optional)
Lead Unit flag. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardPersonUnitId": "(val)",
    "awardContactId": "(val)",
    "unitNumber": "(val)",
    "leadUnit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPersonUnitId": "(val)",
    "awardContactId": "(val)",
    "unitNumber": "(val)",
    "leadUnit": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Person Units
GET`/award/api/v1/award-person-units/`

Example URI

GET /award/api/v1/award-person-units/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardPersonUnitId",
    "awardContactId",
    "unitNumber",
    "leadUnit"
  ],
  "primaryKey": "awardPersonUnitId"
}

Get Blueprint API specification for Award Person Units
GET`/award/api/v1/award-person-units/`

Example URI

GET /award/api/v1/award-person-units/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Person Units.md"
transfer-encoding: chunked

Update Award Person Units
PUT`/award/api/v1/award-person-units/(key)`

Example URI

PUT /award/api/v1/award-person-units/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardPersonUnitId": "(val)",
  "awardContactId": "(val)",
  "unitNumber": "(val)",
  "leadUnit": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Person Units
PUT`/award/api/v1/award-person-units/`

Example URI

PUT /award/api/v1/award-person-units/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardPersonUnitId": "(val)",
    "awardContactId": "(val)",
    "unitNumber": "(val)",
    "leadUnit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPersonUnitId": "(val)",
    "awardContactId": "(val)",
    "unitNumber": "(val)",
    "leadUnit": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Person Units
PATCH`/award/api/v1/award-person-units/(key)`

Example URI

PATCH /award/api/v1/award-person-units/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardPersonUnitId": "(val)",
  "awardContactId": "(val)",
  "unitNumber": "(val)",
  "leadUnit": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardPersonUnitId": "(val)",
  "awardContactId": "(val)",
  "unitNumber": "(val)",
  "leadUnit": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Person Units
POST`/award/api/v1/award-person-units/`

Example URI

POST /award/api/v1/award-person-units/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardPersonUnitId": "(val)",
  "awardContactId": "(val)",
  "unitNumber": "(val)",
  "leadUnit": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardPersonUnitId": "(val)",
  "awardContactId": "(val)",
  "unitNumber": "(val)",
  "leadUnit": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Person Units
POST`/award/api/v1/award-person-units/`

Example URI

POST /award/api/v1/award-person-units/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardPersonUnitId": "(val)",
    "awardContactId": "(val)",
    "unitNumber": "(val)",
    "leadUnit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPersonUnitId": "(val)",
    "awardContactId": "(val)",
    "unitNumber": "(val)",
    "leadUnit": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardPersonUnitId": "(val)",
    "awardContactId": "(val)",
    "unitNumber": "(val)",
    "leadUnit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardPersonUnitId": "(val)",
    "awardContactId": "(val)",
    "unitNumber": "(val)",
    "leadUnit": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Person Units by Key
DELETE`/award/api/v1/award-person-units/(key)`

Example URI

DELETE /award/api/v1/award-person-units/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Person Units
DELETE`/award/api/v1/award-person-units/`

Example URI

DELETE /award/api/v1/award-person-units/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Person Units with Matching
DELETE`/award/api/v1/award-person-units/`

Example URI

DELETE /award/api/v1/award-person-units/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardPersonUnitId: string (optional)
AwardPersonUnit ID. Maximum length is 8.
awardContactId: string (optional)
unitNumber: string (optional)
Unit Number. Maximum length is 20.
leadUnit: string (optional)
Lead Unit flag. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Persons ¶

Get Award Persons by Key
GET`/award/api/v1/award-persons/(key)`

Example URI

GET /award/api/v1/award-persons/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardContactId": "(val)",
  "personId": "(val)",
  "rolodexId": "(val)",
  "fullName": "(val)",
  "academicYearEffort": "(val)",
  "calendarYearEffort": "(val)",
  "summerEffort": "(val)",
  "totalEffort": "(val)",
  "faculty": "(val)",
  "includeInCreditAllocation": "(val)",
  "roleCode": "(val)",
  "keyPersonRole": "(val)",
  "optInUnitStatus": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Persons
GET`/award/api/v1/award-persons/`

Example URI

GET /award/api/v1/award-persons/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardContactId": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "fullName": "(val)",
    "academicYearEffort": "(val)",
    "calendarYearEffort": "(val)",
    "summerEffort": "(val)",
    "totalEffort": "(val)",
    "faculty": "(val)",
    "includeInCreditAllocation": "(val)",
    "roleCode": "(val)",
    "keyPersonRole": "(val)",
    "optInUnitStatus": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardContactId": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "fullName": "(val)",
    "academicYearEffort": "(val)",
    "calendarYearEffort": "(val)",
    "summerEffort": "(val)",
    "totalEffort": "(val)",
    "faculty": "(val)",
    "includeInCreditAllocation": "(val)",
    "roleCode": "(val)",
    "keyPersonRole": "(val)",
    "optInUnitStatus": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Persons with Filtering
GET`/award/api/v1/award-persons/`

Example URI

GET /award/api/v1/award-persons/

URI Parameters

HideShow

awardContactId: string (optional)
Award Contact ID. Maximum length is 8.
personId: string (optional)
rolodexId: string (optional)
fullName: string (optional)
Full Name. Maximum length is 90.
academicYearEffort: string (optional)
Academic Year Effort. Maximum length is 7.
calendarYearEffort: string (optional)
Calendar Year Effort. Maximum length is 7.
summerEffort: string (optional)
Summer Effort. Maximum length is 7.
totalEffort: string (optional)
Total Effort. Maximum length is 7.
faculty: string (optional)
Faculty flag. Maximum length is 1.
includeInCreditAllocation: string (optional)
Include in Credit Allocation. Maximum length is 1.
roleCode: string (optional)
keyPersonRole: string (optional)
Project Role. Maximum length is 60.
optInUnitStatus: string (optional)
awardNumber: string (optional)
Award ID. Maximum length is 12.
sequenceNumber: string (optional)
Sequence Number. Maximum length is 4.
award.awardId: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardContactId": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "fullName": "(val)",
    "academicYearEffort": "(val)",
    "calendarYearEffort": "(val)",
    "summerEffort": "(val)",
    "totalEffort": "(val)",
    "faculty": "(val)",
    "includeInCreditAllocation": "(val)",
    "roleCode": "(val)",
    "keyPersonRole": "(val)",
    "optInUnitStatus": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardContactId": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "fullName": "(val)",
    "academicYearEffort": "(val)",
    "calendarYearEffort": "(val)",
    "summerEffort": "(val)",
    "totalEffort": "(val)",
    "faculty": "(val)",
    "includeInCreditAllocation": "(val)",
    "roleCode": "(val)",
    "keyPersonRole": "(val)",
    "optInUnitStatus": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Persons
GET`/award/api/v1/award-persons/`

Example URI

GET /award/api/v1/award-persons/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardContactId",
    "personId",
    "rolodexId",
    "fullName",
    "academicYearEffort",
    "calendarYearEffort",
    "summerEffort",
    "totalEffort",
    "faculty",
    "includeInCreditAllocation",
    "roleCode",
    "keyPersonRole",
    "optInUnitStatus",
    "awardNumber",
    "sequenceNumber",
    "award.awardId"
  ],
  "primaryKey": "awardContactId"
}

Get Blueprint API specification for Award Persons
GET`/award/api/v1/award-persons/`

Example URI

GET /award/api/v1/award-persons/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Persons.md"
transfer-encoding: chunked

Update Award Persons
PUT`/award/api/v1/award-persons/(key)`

Example URI

PUT /award/api/v1/award-persons/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardContactId": "(val)",
  "personId": "(val)",
  "rolodexId": "(val)",
  "fullName": "(val)",
  "academicYearEffort": "(val)",
  "calendarYearEffort": "(val)",
  "summerEffort": "(val)",
  "totalEffort": "(val)",
  "faculty": "(val)",
  "includeInCreditAllocation": "(val)",
  "roleCode": "(val)",
  "keyPersonRole": "(val)",
  "optInUnitStatus": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Persons
PUT`/award/api/v1/award-persons/`

Example URI

PUT /award/api/v1/award-persons/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardContactId": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "fullName": "(val)",
    "academicYearEffort": "(val)",
    "calendarYearEffort": "(val)",
    "summerEffort": "(val)",
    "totalEffort": "(val)",
    "faculty": "(val)",
    "includeInCreditAllocation": "(val)",
    "roleCode": "(val)",
    "keyPersonRole": "(val)",
    "optInUnitStatus": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardContactId": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "fullName": "(val)",
    "academicYearEffort": "(val)",
    "calendarYearEffort": "(val)",
    "summerEffort": "(val)",
    "totalEffort": "(val)",
    "faculty": "(val)",
    "includeInCreditAllocation": "(val)",
    "roleCode": "(val)",
    "keyPersonRole": "(val)",
    "optInUnitStatus": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Persons
PATCH`/award/api/v1/award-persons/(key)`

Example URI

PATCH /award/api/v1/award-persons/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardContactId": "(val)",
  "personId": "(val)",
  "rolodexId": "(val)",
  "fullName": "(val)",
  "academicYearEffort": "(val)",
  "calendarYearEffort": "(val)",
  "summerEffort": "(val)",
  "totalEffort": "(val)",
  "faculty": "(val)",
  "includeInCreditAllocation": "(val)",
  "roleCode": "(val)",
  "keyPersonRole": "(val)",
  "optInUnitStatus": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardContactId": "(val)",
  "personId": "(val)",
  "rolodexId": "(val)",
  "fullName": "(val)",
  "academicYearEffort": "(val)",
  "calendarYearEffort": "(val)",
  "summerEffort": "(val)",
  "totalEffort": "(val)",
  "faculty": "(val)",
  "includeInCreditAllocation": "(val)",
  "roleCode": "(val)",
  "keyPersonRole": "(val)",
  "optInUnitStatus": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Award Posts ¶

Get All Active Award Posts
GET`/award/api/v1/award-posts/`

Example URI

GET /award/api/v1/award-posts/

URI Parameters

HideShow

accountNumber: number (optional) Example: 55555
Account number of the posts to be returned. If not included, will return all active award posts.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "id": 16,
    "accountNumber": "55555",
    "posted": true,
    "active": true,
    "documentNumber": "4469",
    "updateUser": "quickstart",
    "updateTimestamp": 1468434837000,
    "awardId": 2799,
    "awardDto": {
      "docNbr": null,
      "documentDescription": null,
      "docStatus": null,
      "awardId": 2799,
      "awardNumber": "000023-00001",
      "sequenceNumber": 9,
      "sponsorCode": "055075",
      "sponsor": {
        "sponsorCode": "055075",
        "sponsorName": "Sponsor",
        "acronym": null,
        "sponsorType": {
          "code": "1",
          "description": "State"
        }
      },
      "statusCode": 1,
      "accountNumber": "55555",
      "awardEffectiveDate": "2014-01-01",
      "awardExecutionDate": null,
      "beginDate": "2014-01-01",
      "obligationStartDate": null,
      "projectEndDate": "2016-06-30",
      "costSharingIndicator": "N",
      "indirectCostIndicator": "Y",
      "nsfSequenceNumber": null,
      "paymentScheduleIndicator": "N",
      "scienceCodeIndicator": "N",
      "specialReviewIndicator": "N",
      "sponsorAwardNumber": null,
      "transferSponsorIndicator": "N",
      "accountTypeCode": 1,
      "activityTypeCode": "3",
      "primeSponsorCode": null,
      "primeSponsor": null,
      "awardTypeCode": 1,
      "cfdaNumber": "00.000",
      "methodOfPaymentCode": "1",
      "proposalNumber": null,
      "title": "LOC - by cc acct",
      "basisOfPaymentCode": "1",
      "awardTransactionTypeCode": 4,
      "noticeDate": null,
      "leadUnitNumber": "000001",
      "awardSequenceStatus": "ACTIVE",
      "unitNumber": "000001",
      "approvedEquipmentIndicator": "N",
      "approvedForeignTripIndicator": "N",
      "subContractIndicator": "N",
      "modificationNumber": null,
      "documentFundingId": null,
      "preAwardAuthorizedAmount": null,
      "preAwardEffectiveDate": null,
      "preAwardInstitutionalAuthorizedAmount": null,
      "obligationEndDate": null,
      "preAwardInstitutionalEffectiveDate": null,
      "procurementPriorityCode": null,
      "specialEbRateOffCampus": null,
      "specialEbRateOnCampus": null,
      "anticipatedTotalDirect": 200000,
      "anticipatedTotalIndirect": 100000,
      "obligatedTotalDirect": 200000,
      "obligatedTotalIndirect": 100000,
      "subPlanFlag": null,
      "archiveLocation": null,
      "closeoutDate": null,
      "currentActionComments": "",
      "awardSequenceStatusResult": "Final",
      "templateCode": null,
      "awardBasisOfPayment": null,
      "awardMethodOfPayment": null,
      "fainId": null,
      "fedAwardYear": null,
      "fedAwardDate": null,
      "posted": true,
      "projectPersons": [
        {
          "awardContactId": 2800,
          "personId": "10000000002",
          "roleCode": "PI",
          "keyPersonRole": null,
          "rolodexId": null,
          "fullName": "Joe Tester",
          "academicYearEffort": null,
          "calendarYearEffort": null,
          "summerEffort": null,
          "totalEffort": null,
          "kcPerson.emailAddress": "kcnotification+quickstart@gmail.com",
          "kcPerson.phoneNumber": "321-321-1197",
          "creditSplits": [
            {
              "awardPersonCreditSplitId": 2265,
              "credit": 100,
              "investigatorCreditType": {
                "code": "0",
                "addsToHundred": true,
                "active": true,
                "description": "Recognition"
              }
            },
            {
              "awardPersonCreditSplitId": 2266,
              "credit": 100,
              "investigatorCreditType": {
                "code": "1",
                "addsToHundred": true,
                "active": true,
                "description": "Responsibility"
              }
            },
            {
              "awardPersonCreditSplitId": 2267,
              "credit": 100,
              "investigatorCreditType": {
                "code": "2",
                "addsToHundred": true,
                "active": true,
                "description": "Space"
              }
            },
            {
              "awardPersonCreditSplitId": 2268,
              "credit": 100,
              "investigatorCreditType": {
                "code": "3",
                "addsToHundred": true,
                "active": true,
                "description": "Financial"
              }
            }
          ],
          "units": [
            {
              "awardPersonUnitId": 2264,
              "leadUnit": true,
              "unit": {
                "unitNumber": "000001",
                "parentUnitNumber": null,
                "organizationId": "000001",
                "unitName": "University"
              },
              "creditSplits": [
                {
                  "awardPersonUnitCreditSplitId": 2269,
                  "credit": 100,
                  "investigatorCreditType": {
                    "code": "0",
                    "addsToHundred": true,
                    "active": true,
                    "description": "Recognition"
                  }
                },
                {
                  "awardPersonUnitCreditSplitId": 2270,
                  "credit": 100,
                  "investigatorCreditType": {
                    "code": "1",
                    "addsToHundred": true,
                    "active": true,
                    "description": "Responsibility"
                  }
                },
                {
                  "awardPersonUnitCreditSplitId": 2271,
                  "credit": 100,
                  "investigatorCreditType": {
                    "code": "2",
                    "addsToHundred": true,
                    "active": true,
                    "description": "Space"
                  }
                },
                {
                  "awardPersonUnitCreditSplitId": 2272,
                  "credit": 100,
                  "investigatorCreditType": {
                    "code": "3",
                    "addsToHundred": true,
                    "active": true,
                    "description": "Financial"
                  }
                }
              ]
            }
          ]
        }
      ],
      "awardCustomDataList": [
        {
          "customAttributeId": 1,
          "value": "05"
        },
        {
          "customAttributeId": 4,
          "value": "5"
        },
        {
          "customAttributeId": 2,
          "value": null
        },
        {
          "customAttributeId": 3,
          "value": null
        },
        {
          "customAttributeId": 5,
          "value": null
        },
        {
          "customAttributeId": 6,
          "value": null
        },
        {
          "customAttributeId": 7,
          "value": null
        }
      ],
      "awardSponsorTerms": [
        {
          "sponsorTermId": 325
        },
        {
          "sponsorTermId": 505
        },
        {
          "sponsorTermId": 353
        },
        {
          "sponsorTermId": 371
        },
        {
          "sponsorTermId": 538
        },
        {
          "sponsorTermId": 318
        },
        {
          "sponsorTermId": 354
        },
        {
          "sponsorTermId": 372
        },
        {
          "sponsorTermId": 417
        },
        {
          "sponsorTermId": 544
        },
        {
          "sponsorTermId": 556
        },
        {
          "sponsorTermId": 567
        },
        {
          "sponsorTermId": 569
        },
        {
          "sponsorTermId": 493
        },
        {
          "sponsorTermId": 500
        },
        {
          "sponsorTermId": 410
        },
        {
          "sponsorTermId": 437
        },
        {
          "sponsorTermId": 383
        },
        {
          "sponsorTermId": 578
        },
        {
          "sponsorTermId": 601
        },
        {
          "sponsorTermId": 322
        },
        {
          "sponsorTermId": 367
        },
        {
          "sponsorTermId": 448
        },
        {
          "sponsorTermId": 480
        },
        {
          "sponsorTermId": 333
        },
        {
          "sponsorTermId": 369
        }
      ],
      "awardReportTerms": [
        {
          "reportClassCode": "1",
          "reportCode": "7",
          "frequencyCode": "7",
          "frequencyBaseCode": "5",
          "ospDistributionCode": "1",
          "dueDate": null
        }
      ],
      "awardComments": [
        {
          "awardCommentId": 337,
          "commentTypeCode": "21",
          "checklistPrintFlag": false,
          "comments": null
        },
        {
          "awardCommentId": 338,
          "commentTypeCode": "9",
          "checklistPrintFlag": true,
          "comments": null
        },
        {
          "awardCommentId": 339,
          "commentTypeCode": "8",
          "checklistPrintFlag": true,
          "comments": null
        },
        {
          "awardCommentId": 340,
          "commentTypeCode": "20",
          "checklistPrintFlag": true,
          "comments": null
        },
        {
          "awardCommentId": 341,
          "commentTypeCode": "18",
          "checklistPrintFlag": false,
          "comments": null
        },
        {
          "awardCommentId": 342,
          "commentTypeCode": "19",
          "checklistPrintFlag": false,
          "comments": null
        }
      ],
      "awardSponsorContacts": [
        {
          "rolodexId": 1736,
          "roleCode": "1",
          "awardContactId": 4263,
          "orgName": "Office of Naval Research"
        }
      ],
      "awardCostShares": [],
      "awardFandaRate": [
        {
          "awardFandaRateId": 2810,
          "applicableFandaRate": 10,
          "fandaRateTypeCode": "1",
          "fiscalYear": "2016",
          "onCampusFlag": "N",
          "underrecoveryOfIndirectCost": null,
          "sourceAccount": null,
          "destinationAccount": null,
          "startDate": "2015-07-01",
          "endDate": "2016-06-30"
        },
        {
          "awardFandaRateId": 2811,
          "applicableFandaRate": 10,
          "fandaRateTypeCode": "1",
          "fiscalYear": "2016",
          "onCampusFlag": "F",
          "underrecoveryOfIndirectCost": null,
          "sourceAccount": null,
          "destinationAccount": null,
          "startDate": "2015-07-01",
          "endDate": "2016-06-30"
        }
      ],
      "awardDirectFandADistributions": [],
      "awardUnitContacts": [
        {
          "unitAdministratorType": {
            "code": "9",
            "description": "Fund Manager"
          },
          "unitNumber": "000001",
          "person": {
            "personId": "10000000018",
            "firstName": "ALAN",
            "lastName": "MCAFEE",
            "middleName": "",
            "fullName": "ALAN MCAFEE",
            "userName": "aemcafee",
            "emailAddress": "kcnotification+aemcafee@gmail.com",
            "addressLine1": "1135 Kuali Drive",
            "addressLine2": "",
            "addressLine3": "",
            "city": "Coeus",
            "state": "MA",
            "postalCode": "53421"
          }
        }
      ],
      "approvedEquipmentItems": [],
      "approvedForeignTravelTrips": [],
      "paymentScheduleItems": [],
      "awardTransferringSponsors": [],
      "awardAmountInfos": [
        {
          "awardAmountInfoId": 2813,
          "transactionId": null,
          "timeAndMoneyDocumentNumber": null,
          "anticipatedTotalAmount": 100000,
          "antDistributableAmount": 100000,
          "finalExpirationDate": "2016-06-30",
          "currentFundEffectiveDate": "2016-06-30",
          "amountObligatedToDate": 100000,
          "obliDistributableAmount": 100000,
          "obligationExpirationDate": "2016-06-30",
          "anticipatedChange": 0,
          "obligatedChange": 0,
          "obligatedChangeDirect": 0,
          "obligatedChangeIndirect": 0,
          "anticipatedChangeDirect": 0,
          "anticipatedChangeIndirect": 0,
          "anticipatedTotalDirect": 0,
          "anticipatedTotalIndirect": 0,
          "obligatedTotalDirect": 0,
          "obligatedTotalIndirect": 0,
          "originatingAwardVersion": 9,
          "awardNumber": "000023-00001",
          "awardId": 2799
        },
        {
          "awardAmountInfoId": 2818,
          "transactionId": null,
          "timeAndMoneyDocumentNumber": "4478",
          "anticipatedTotalAmount": 100000,
          "antDistributableAmount": 100000,
          "finalExpirationDate": "2016-06-30",
          "currentFundEffectiveDate": "2016-06-30",
          "amountObligatedToDate": 100000,
          "obliDistributableAmount": 100000,
          "obligationExpirationDate": "2016-07-29",
          "anticipatedChange": 0,
          "obligatedChange": 0,
          "obligatedChangeDirect": 0,
          "obligatedChangeIndirect": 0,
          "anticipatedChangeDirect": 0,
          "anticipatedChangeIndirect": 0,
          "anticipatedTotalDirect": 0,
          "anticipatedTotalIndirect": 0,
          "obligatedTotalDirect": 0,
          "obligatedTotalIndirect": 0,
          "originatingAwardVersion": 9,
          "awardNumber": "000023-00001",
          "awardId": 2799
        },
        {
          "awardAmountInfoId": 2819,
          "transactionId": null,
          "timeAndMoneyDocumentNumber": "4478",
          "anticipatedTotalAmount": 100000,
          "antDistributableAmount": 100000,
          "finalExpirationDate": "2016-07-29",
          "currentFundEffectiveDate": "2016-06-30",
          "amountObligatedToDate": 100000,
          "obliDistributableAmount": 100000,
          "obligationExpirationDate": "2016-07-29",
          "anticipatedChange": 0,
          "obligatedChange": 0,
          "obligatedChangeDirect": 0,
          "obligatedChangeIndirect": 0,
          "anticipatedChangeDirect": 0,
          "anticipatedChangeIndirect": 0,
          "anticipatedTotalDirect": 0,
          "anticipatedTotalIndirect": 0,
          "obligatedTotalDirect": 0,
          "obligatedTotalIndirect": 0,
          "originatingAwardVersion": 9,
          "awardNumber": "000023-00001",
          "awardId": 2799
        }
      ],
      "awardCloseoutItems": [
        {
          "awardCloseoutId": 120,
          "finalSubmissionDate": null,
          "dueDate": null,
          "closeoutReportCode": "1",
          "closeoutReportName": "Financial",
          "multiple": false
        },
        {
          "awardCloseoutId": 121,
          "finalSubmissionDate": null,
          "dueDate": null,
          "closeoutReportCode": "4",
          "closeoutReportName": "Technical",
          "multiple": false
        },
        {
          "awardCloseoutId": 122,
          "finalSubmissionDate": null,
          "dueDate": null,
          "closeoutReportCode": "3",
          "closeoutReportName": "Patent",
          "multiple": false
        },
        {
          "awardCloseoutId": 123,
          "finalSubmissionDate": null,
          "dueDate": null,
          "closeoutReportCode": "2",
          "closeoutReportName": "Property",
          "multiple": false
        },
        {
          "awardCloseoutId": 124,
          "finalSubmissionDate": null,
          "dueDate": null,
          "closeoutReportCode": "6",
          "closeoutReportName": "Invoice",
          "multiple": false
        }
      ],
      "awardCloseoutNewItems": [],
      "fundingProposals": [],
      "allFundingProposals": [],
      "awardBudgetLimits": [
        {
          "budgetLimitId": 19,
          "awardId": null,
          "budgetId": null,
          "limitTypeCode": "directCost",
          "limit": null
        },
        {
          "budgetLimitId": 20,
          "awardId": null,
          "budgetId": null,
          "limitTypeCode": "indirectCost",
          "limit": null
        },
        {
          "budgetLimitId": 21,
          "awardId": null,
          "budgetId": null,
          "limitTypeCode": "totalCost",
          "limit": null
        }
      ],
      "budgets": [
        {
          "awardId": 2710,
          "budgetId": 1,
          "budgetVersionNumber": 1,
          "budgetInitiator": "10000000001",
          "awardBudgetStatusCode": "9",
          "awardBudgetStatus": {
            "awardBudgetStatusCode": "9",
            "description": "Posted"
          },
          "awardBudgetTypeCode": "1",
          "awardBudgetType": {
            "awardBudgetTypeCode": "1",
            "description": "New"
          },
          "obligatedTotal": 100000,
          "obligatedAmount": 0,
          "description": "New",
          "onOffCampusFlag": "D",
          "endDate": "2016-06-29",
          "startDate": "2016-06-29",
          "totalCost": 100000,
          "totalDirectCost": 100000,
          "totalIndirectCost": 0,
          "costSharingAmount": 0,
          "underrecoveryAmount": 0,
          "totalCostLimit": 100000,
          "residualFunds": null,
          "ohRateClassCode": "13",
          "ohRateClass": {
            "code": "13",
            "description": "MTDC - AWARD"
          },
          "ohRateTypeCode": "1",
          "comments": null,
          "modularBudgetFlag": false,
          "urRateClassCode": "13",
          "totalDirectCostLimit": 0,
          "totalDirectCostInclPrev": 100000,
          "totalIndirectCostInclPrev": 0,
          "totalCostInclPrev": 100000,
          "budgetRates": [
            {
              "activityTypeCode": "3",
              "applicableRate": 10,
              "fiscalYear": "2016",
              "onOffCampusFlag": false,
              "rateClassCode": "13",
              "rateClass": {
                "code": "13",
                "description": "MTDC - AWARD"
              },
              "rateTypeCode": "1",
              "rateType": {
                "rateClassCode": "13",
                "rateTypeCode": "1",
                "description": "MTDC"
              },
              "startDate": "2015-07-01",
              "instituteRate": 9
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 10,
              "fiscalYear": "2016",
              "onOffCampusFlag": true,
              "rateClassCode": "13",
              "rateClass": {
                "code": "13",
                "description": "MTDC - AWARD"
              },
              "rateTypeCode": "1",
              "rateType": {
                "rateClassCode": "13",
                "rateTypeCode": "1",
                "description": "MTDC"
              },
              "startDate": "2015-07-01",
              "instituteRate": 62
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 25,
              "fiscalYear": "2006",
              "onOffCampusFlag": false,
              "rateClassCode": "5",
              "rateClass": {
                "code": "5",
                "description": "Employee Benefits"
              },
              "rateTypeCode": "1",
              "rateType": {
                "rateClassCode": "5",
                "rateTypeCode": "1",
                "description": "Research Rate"
              },
              "startDate": "2005-07-01",
              "instituteRate": 25
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 27,
              "fiscalYear": "2006",
              "onOffCampusFlag": true,
              "rateClassCode": "5",
              "rateClass": {
                "code": "5",
                "description": "Employee Benefits"
              },
              "rateTypeCode": "1",
              "rateType": {
                "rateClassCode": "5",
                "rateTypeCode": "1",
                "description": "Research Rate"
              },
              "startDate": "2005-07-01",
              "instituteRate": 27
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 0,
              "fiscalYear": "2004",
              "onOffCampusFlag": false,
              "rateClassCode": "5",
              "rateClass": {
                "code": "5",
                "description": "Employee Benefits"
              },
              "rateTypeCode": "2",
              "rateType": {
                "rateClassCode": "5",
                "rateTypeCode": "2",
                "description": "UROP Rate"
              },
              "startDate": "2003-07-01",
              "instituteRate": 0
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 0,
              "fiscalYear": "2004",
              "onOffCampusFlag": true,
              "rateClassCode": "5",
              "rateClass": {
                "code": "5",
                "description": "Employee Benefits"
              },
              "rateTypeCode": "2",
              "rateType": {
                "rateClassCode": "5",
                "rateTypeCode": "2",
                "description": "UROP Rate"
              },
              "startDate": "2003-07-01",
              "instituteRate": 0
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 25,
              "fiscalYear": "2006",
              "onOffCampusFlag": false,
              "rateClassCode": "5",
              "rateClass": {
                "code": "5",
                "description": "Employee Benefits"
              },
              "rateTypeCode": "3",
              "rateType": {
                "rateClassCode": "5",
                "rateTypeCode": "3",
                "description": "EB on LA"
              },
              "startDate": "2005-07-01",
              "instituteRate": 25
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 27,
              "fiscalYear": "2006",
              "onOffCampusFlag": true,
              "rateClassCode": "5",
              "rateClass": {
                "code": "5",
                "description": "Employee Benefits"
              },
              "rateTypeCode": "3",
              "rateType": {
                "rateClassCode": "5",
                "rateTypeCode": "3",
                "description": "EB on LA"
              },
              "startDate": "2005-07-01",
              "instituteRate": 27
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 3,
              "fiscalYear": "2016",
              "onOffCampusFlag": false,
              "rateClassCode": "7",
              "rateClass": {
                "code": "7",
                "description": "Inflation"
              },
              "rateTypeCode": "1",
              "rateType": {
                "rateClassCode": "7",
                "rateTypeCode": "1",
                "description": "Faculty Salaries (6/1)"
              },
              "startDate": "2016-01-07",
              "instituteRate": 3
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 3,
              "fiscalYear": "2016",
              "onOffCampusFlag": true,
              "rateClassCode": "7",
              "rateClass": {
                "code": "7",
                "description": "Inflation"
              },
              "rateTypeCode": "1",
              "rateType": {
                "rateClassCode": "7",
                "rateTypeCode": "1",
                "description": "Faculty Salaries (6/1)"
              },
              "startDate": "2016-01-07",
              "instituteRate": 3
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 3,
              "fiscalYear": "2016",
              "onOffCampusFlag": false,
              "rateClassCode": "7",
              "rateClass": {
                "code": "7",
                "description": "Inflation"
              },
              "rateTypeCode": "2",
              "rateType": {
                "rateClassCode": "7",
                "rateTypeCode": "2",
                "description": "Administrative Salaries (7/1)"
              },
              "startDate": "2016-01-07",
              "instituteRate": 3
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 3,
              "fiscalYear": "2016",
              "onOffCampusFlag": true,
              "rateClassCode": "7",
              "rateClass": {
                "code": "7",
                "description": "Inflation"
              },
              "rateTypeCode": "2",
              "rateType": {
                "rateClassCode": "7",
                "rateTypeCode": "2",
                "description": "Administrative Salaries (7/1)"
              },
              "startDate": "2016-01-07",
              "instituteRate": 3
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 3,
              "fiscalYear": "2016",
              "onOffCampusFlag": false,
              "rateClassCode": "7",
              "rateClass": {
                "code": "7",
                "description": "Inflation"
              },
              "rateTypeCode": "3",
              "rateType": {
                "rateClassCode": "7",
                "rateTypeCode": "3",
                "description": "Support Staff Salaries (4/1)"
              },
              "startDate": "2016-01-04",
              "instituteRate": 3
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 3,
              "fiscalYear": "2016",
              "onOffCampusFlag": true,
              "rateClassCode": "7",
              "rateClass": {
                "code": "7",
                "description": "Inflation"
              },
              "rateTypeCode": "3",
              "rateType": {
                "rateClassCode": "7",
                "rateTypeCode": "3",
                "description": "Support Staff Salaries (4/1)"
              },
              "startDate": "2016-01-04",
              "instituteRate": 3
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 3,
              "fiscalYear": "2016",
              "onOffCampusFlag": false,
              "rateClassCode": "7",
              "rateClass": {
                "code": "7",
                "description": "Inflation"
              },
              "rateTypeCode": "4",
              "rateType": {
                "rateClassCode": "7",
                "rateTypeCode": "4",
                "description": "Materials and Services"
              },
              "startDate": "2016-01-07",
              "instituteRate": 3
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 3,
              "fiscalYear": "2016",
              "onOffCampusFlag": true,
              "rateClassCode": "7",
              "rateClass": {
                "code": "7",
                "description": "Inflation"
              },
              "rateTypeCode": "4",
              "rateType": {
                "rateClassCode": "7",
                "rateTypeCode": "4",
                "description": "Materials and Services"
              },
              "startDate": "2016-01-07",
              "instituteRate": 3
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 3,
              "fiscalYear": "2016",
              "onOffCampusFlag": false,
              "rateClassCode": "7",
              "rateClass": {
                "code": "7",
                "description": "Inflation"
              },
              "rateTypeCode": "5",
              "rateType": {
                "rateClassCode": "7",
                "rateTypeCode": "5",
                "description": "Research Staff (1/1)"
              },
              "startDate": "2016-01-01",
              "instituteRate": 3
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 3,
              "fiscalYear": "2016",
              "onOffCampusFlag": true,
              "rateClassCode": "7",
              "rateClass": {
                "code": "7",
                "description": "Inflation"
              },
              "rateTypeCode": "5",
              "rateType": {
                "rateClassCode": "7",
                "rateTypeCode": "5",
                "description": "Research Staff (1/1)"
              },
              "startDate": "2016-01-01",
              "instituteRate": 3
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 3,
              "fiscalYear": "2011",
              "onOffCampusFlag": false,
              "rateClassCode": "7",
              "rateClass": {
                "code": "7",
                "description": "Inflation"
              },
              "rateTypeCode": "6",
              "rateType": {
                "rateClassCode": "7",
                "rateTypeCode": "6",
                "description": "Students (6/1)"
              },
              "startDate": "2011-06-01",
              "instituteRate": 3
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 3,
              "fiscalYear": "2011",
              "onOffCampusFlag": true,
              "rateClassCode": "7",
              "rateClass": {
                "code": "7",
                "description": "Inflation"
              },
              "rateTypeCode": "6",
              "rateType": {
                "rateClassCode": "7",
                "rateTypeCode": "6",
                "description": "Students (6/1)"
              },
              "startDate": "2011-06-01",
              "instituteRate": 3
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 9.5,
              "fiscalYear": "2006",
              "onOffCampusFlag": false,
              "rateClassCode": "8",
              "rateClass": {
                "code": "8",
                "description": "Vacation"
              },
              "rateTypeCode": "1",
              "rateType": {
                "rateClassCode": "8",
                "rateTypeCode": "1",
                "description": "Vacation "
              },
              "startDate": "2005-07-01",
              "instituteRate": 9.5
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 10.5,
              "fiscalYear": "2006",
              "onOffCampusFlag": true,
              "rateClassCode": "8",
              "rateClass": {
                "code": "8",
                "description": "Vacation"
              },
              "rateTypeCode": "1",
              "rateType": {
                "rateClassCode": "8",
                "rateTypeCode": "1",
                "description": "Vacation "
              },
              "startDate": "2005-07-01",
              "instituteRate": 10.5
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 8,
              "fiscalYear": "2006",
              "onOffCampusFlag": false,
              "rateClassCode": "8",
              "rateClass": {
                "code": "8",
                "description": "Vacation"
              },
              "rateTypeCode": "2",
              "rateType": {
                "rateClassCode": "8",
                "rateTypeCode": "2",
                "description": "Vacation on LA"
              },
              "startDate": "2005-07-01",
              "instituteRate": 8
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 8,
              "fiscalYear": "2006",
              "onOffCampusFlag": true,
              "rateClassCode": "8",
              "rateClass": {
                "code": "8",
                "description": "Vacation"
              },
              "rateTypeCode": "2",
              "rateType": {
                "rateClassCode": "8",
                "rateTypeCode": "2",
                "description": "Vacation on LA"
              },
              "startDate": "2005-07-01",
              "instituteRate": 8
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 0,
              "fiscalYear": "2000",
              "onOffCampusFlag": false,
              "rateClassCode": "9",
              "rateClass": {
                "code": "9",
                "description": "Other"
              },
              "rateTypeCode": "1",
              "rateType": {
                "rateClassCode": "9",
                "rateTypeCode": "1",
                "description": "Other"
              },
              "startDate": "1999-07-01",
              "instituteRate": 0
            },
            {
              "activityTypeCode": "3",
              "applicableRate": 0,
              "fiscalYear": "2000",
              "onOffCampusFlag": true,
              "rateClassCode": "9",
              "rateClass": {
                "code": "9",
                "description": "Other"
              },
              "rateTypeCode": "1",
              "rateType": {
                "rateClassCode": "9",
                "rateTypeCode": "1",
                "description": "Other"
              },
              "startDate": "1999-07-01",
              "instituteRate": 0
            }
          ],
          "budgetLaRates": [
            {
              "activityTypeCode": null,
              "applicableRate": 8,
              "fiscalYear": "2005",
              "onOffCampusFlag": false,
              "rateClassCode": "12",
              "rateClass": {
                "code": "12",
                "description": "Lab Allocation - Utilities"
              },
              "rateTypeCode": "1",
              "rateType": {
                "rateClassCode": "12",
                "rateTypeCode": "1",
                "description": "Lab Allocation - Utilities"
              },
              "startDate": "2004-07-01",
              "instituteRate": 8
            },
            {
              "activityTypeCode": null,
              "applicableRate": 8,
              "fiscalYear": "2005",
              "onOffCampusFlag": true,
              "rateClassCode": "12",
              "rateClass": {
                "code": "12",
                "description": "Lab Allocation - Utilities"
              },
              "rateTypeCode": "1",
              "rateType": {
                "rateClassCode": "12",
                "rateTypeCode": "1",
                "description": "Lab Allocation - Utilities"
              },
              "startDate": "2004-07-01",
              "instituteRate": 8
            },
            {
              "activityTypeCode": null,
              "applicableRate": 1,
              "fiscalYear": "2011",
              "onOffCampusFlag": false,
              "rateClassCode": "11",
              "rateClass": {
                "code": "11",
                "description": "Lab Allocation - M&S"
              },
              "rateTypeCode": "1",
              "rateType": {
                "rateClassCode": "11",
                "rateTypeCode": "1",
                "description": "Lab Allocation - M&S"
              },
              "startDate": "2010-07-01",
              "instituteRate": 1
            },
            {
              "activityTypeCode": null,
              "applicableRate": 1,
              "fiscalYear": "2011",
              "onOffCampusFlag": true,
              "rateClassCode": "11",
              "rateClass": {
                "code": "11",
                "description": "Lab Allocation - M&S"
              },
              "rateTypeCode": "1",
              "rateType": {
                "rateClassCode": "11",
                "rateTypeCode": "1",
                "description": "Lab Allocation - M&S"
              },
              "startDate": "2010-07-01",
              "instituteRate": 1
            },
            {
              "activityTypeCode": null,
              "applicableRate": 8,
              "fiscalYear": "2012",
              "onOffCampusFlag": false,
              "rateClassCode": "10",
              "rateClass": {
                "code": "10",
                "description": "Lab Allocation - Salaries"
              },
              "rateTypeCode": "1",
              "rateType": {
                "rateClassCode": "10",
                "rateTypeCode": "1",
                "description": "Lab Allocation - Salaries"
              },
              "startDate": "2011-07-01",
              "instituteRate": 8
            },
            {
              "activityTypeCode": null,
              "applicableRate": 8,
              "fiscalYear": "2012",
              "onOffCampusFlag": true,
              "rateClassCode": "10",
              "rateClass": {
                "code": "10",
                "description": "Lab Allocation - Salaries"
              },
              "rateTypeCode": "1",
              "rateType": {
                "rateClassCode": "10",
                "rateTypeCode": "1",
                "description": "Lab Allocation - Salaries"
              },
              "startDate": "2011-07-01",
              "instituteRate": 8
            }
          ],
          "budgetPeriods": [
            {
              "comments": null,
              "costSharingAmount": 0,
              "endDate": "2016-06-30",
              "startDate": "2016-06-30",
              "totalCost": 100000,
              "totalCostLimit": 100000,
              "totalDirectCost": 100000,
              "totalIndirectCost": 0,
              "underrecoveryAmount": 0,
              "budgetLineItems": [
                {
                  "costSharingAmount": 0,
                  "budgetLineItemId": 9,
                  "lineItemNumber": 1,
                  "applyInRateFlag": true,
                  "basedOnLineItem": null,
                  "budgetJustification": null,
                  "groupName": null,
                  "endDate": "2016-06-30",
                  "lineItemCost": 100000,
                  "obligatedAmount": 0,
                  "lineItemDescription": null,
                  "lineItemSequence": 1,
                  "onOffCampusFlag": true,
                  "quantity": 1,
                  "startDate": "2016-06-30",
                  "underrecoveryAmount": 0,
                  "formulatedCostElementFlag": false,
                  "costElement": "421818",
                  "costElementBO": {
                    "costElement": "421818",
                    "description": "Equipment - Not MTDC",
                    "onOffCampusFlag": true,
                    "active": true
                  },
                  "budgetCategoryCode": "20",
                  "budgetCategory": {
                    "code": "20",
                    "description": "Equipment"
                  },
                  "budgetPersonnelDetailsList": [],
                  "budgetLineItemCalculatedAmounts": []
                }
              ],
              "numberOfParticipants": null,
              "directCostLimit": 0,
              "expenseTotal": null,
              "budgetId": 1
            }
          ],
          "awardBudgetLimits": [
            {
              "budgetLimitId": 4,
              "awardId": null,
              "budgetId": 1,
              "limitTypeCode": "directCost",
              "limit": null
            },
            {
              "budgetLimitId": 5,
              "awardId": null,
              "budgetId": 1,
              "limitTypeCode": "indirectCost",
              "limit": null
            },
            {
              "budgetLimitId": 6,
              "awardId": null,
              "budgetId": 1,
              "limitTypeCode": "totalCost",
              "limit": null
            }
          ],
          "budgetPersons": [
            {
              "effectiveDate": "2016-06-30",
              "jobCode": "AA000",
              "nonEmployeeFlag": false,
              "personId": "10000000002",
              "rolodexId": null,
              "appointmentTypeCode": "6",
              "calculationBase": 0,
              "personName": "Joe Tester",
              "salaryAnniversaryDate": null
            }
          ]
        }
      ]
    }
  }
]

Update Award Post
PUT`/award/api/v1/award-posts/16`

Set various fields on an the award-post. Fields not provided will not be updated.

Example URI

PUT /award/api/v1/award-posts/16

URI Parameters

HideShow

awardPostId: number (required) Example: 16
Returns the award post record associated with the awardPostId.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "id": 16,
  "accountNumber": "55555",
  "posted": true,
  "active": false,
  "documentNumber": "4469",
  "updateUser": "quickstart",
  "updateTimestamp": 1468434837000,
  "awardId": 2799,
  "awardDto": null
}

Response 200

HideShow

Headers

Content-Length: 0

Body

{
  "id": 16,
  "accountNumber": "55555",
  "posted": true,
  "active": false,
  "documentNumber": "4469",
  "updateUser": "quickstart",
  "updateTimestamp": 1468434837000,
  "awardId": 2799,
  "awardDto": null
}

Award Report Term Recipients ¶

Get Award Report Term Recipients by Key
GET`/award/api/v1/award-report-term-recipients/(key)`

Example URI

GET /award/api/v1/award-report-term-recipients/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardReportTermRecipientId": "(val)",
  "contactId": "(val)",
  "contactTypeCode": "(val)",
  "rolodexId": "(val)",
  "numberOfCopies": "(val)",
  "awardReportTerm.awardReportTermId": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Report Term Recipients
GET`/award/api/v1/award-report-term-recipients/`

Example URI

GET /award/api/v1/award-report-term-recipients/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardReportTermRecipientId": "(val)",
    "contactId": "(val)",
    "contactTypeCode": "(val)",
    "rolodexId": "(val)",
    "numberOfCopies": "(val)",
    "awardReportTerm.awardReportTermId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardReportTermRecipientId": "(val)",
    "contactId": "(val)",
    "contactTypeCode": "(val)",
    "rolodexId": "(val)",
    "numberOfCopies": "(val)",
    "awardReportTerm.awardReportTermId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Report Term Recipients with Filtering
GET`/award/api/v1/award-report-term-recipients/`

Example URI

GET /award/api/v1/award-report-term-recipients/

URI Parameters

HideShow

awardReportTermRecipientId: string (optional)
Award Report Terms Recipient Id. Maximum length is 22.
contactId: string (optional)
Contact Type. Maximum length is 12.
contactTypeCode: string (optional)
Contact Type. Maximum length is 22.
rolodexId: string (optional)
Name/Organization. Maximum length is 22.
numberOfCopies: string (optional)
Number of Copies. Maximum length is 22.
awardReportTerm.awardReportTermId: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardReportTermRecipientId": "(val)",
    "contactId": "(val)",
    "contactTypeCode": "(val)",
    "rolodexId": "(val)",
    "numberOfCopies": "(val)",
    "awardReportTerm.awardReportTermId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardReportTermRecipientId": "(val)",
    "contactId": "(val)",
    "contactTypeCode": "(val)",
    "rolodexId": "(val)",
    "numberOfCopies": "(val)",
    "awardReportTerm.awardReportTermId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Report Term Recipients
GET`/award/api/v1/award-report-term-recipients/`

Example URI

GET /award/api/v1/award-report-term-recipients/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardReportTermRecipientId",
    "contactId",
    "contactTypeCode",
    "rolodexId",
    "numberOfCopies",
    "awardReportTerm.awardReportTermId"
  ],
  "primaryKey": "awardReportTermRecipientId"
}

Get Blueprint API specification for Award Report Term Recipients
GET`/award/api/v1/award-report-term-recipients/`

Example URI

GET /award/api/v1/award-report-term-recipients/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Report Term Recipients.md"
transfer-encoding: chunked

Update Award Report Term Recipients
PUT`/award/api/v1/award-report-term-recipients/(key)`

Example URI

PUT /award/api/v1/award-report-term-recipients/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardReportTermRecipientId": "(val)",
  "contactId": "(val)",
  "contactTypeCode": "(val)",
  "rolodexId": "(val)",
  "numberOfCopies": "(val)",
  "awardReportTerm.awardReportTermId": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Report Term Recipients
PUT`/award/api/v1/award-report-term-recipients/`

Example URI

PUT /award/api/v1/award-report-term-recipients/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardReportTermRecipientId": "(val)",
    "contactId": "(val)",
    "contactTypeCode": "(val)",
    "rolodexId": "(val)",
    "numberOfCopies": "(val)",
    "awardReportTerm.awardReportTermId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardReportTermRecipientId": "(val)",
    "contactId": "(val)",
    "contactTypeCode": "(val)",
    "rolodexId": "(val)",
    "numberOfCopies": "(val)",
    "awardReportTerm.awardReportTermId": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Report Term Recipients
PATCH`/award/api/v1/award-report-term-recipients/(key)`

Example URI

PATCH /award/api/v1/award-report-term-recipients/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardReportTermRecipientId": "(val)",
  "contactId": "(val)",
  "contactTypeCode": "(val)",
  "rolodexId": "(val)",
  "numberOfCopies": "(val)",
  "awardReportTerm.awardReportTermId": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardReportTermRecipientId": "(val)",
  "contactId": "(val)",
  "contactTypeCode": "(val)",
  "rolodexId": "(val)",
  "numberOfCopies": "(val)",
  "awardReportTerm.awardReportTermId": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Report Term Recipients
POST`/award/api/v1/award-report-term-recipients/`

Example URI

POST /award/api/v1/award-report-term-recipients/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardReportTermRecipientId": "(val)",
  "contactId": "(val)",
  "contactTypeCode": "(val)",
  "rolodexId": "(val)",
  "numberOfCopies": "(val)",
  "awardReportTerm.awardReportTermId": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardReportTermRecipientId": "(val)",
  "contactId": "(val)",
  "contactTypeCode": "(val)",
  "rolodexId": "(val)",
  "numberOfCopies": "(val)",
  "awardReportTerm.awardReportTermId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Report Term Recipients
POST`/award/api/v1/award-report-term-recipients/`

Example URI

POST /award/api/v1/award-report-term-recipients/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardReportTermRecipientId": "(val)",
    "contactId": "(val)",
    "contactTypeCode": "(val)",
    "rolodexId": "(val)",
    "numberOfCopies": "(val)",
    "awardReportTerm.awardReportTermId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardReportTermRecipientId": "(val)",
    "contactId": "(val)",
    "contactTypeCode": "(val)",
    "rolodexId": "(val)",
    "numberOfCopies": "(val)",
    "awardReportTerm.awardReportTermId": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardReportTermRecipientId": "(val)",
    "contactId": "(val)",
    "contactTypeCode": "(val)",
    "rolodexId": "(val)",
    "numberOfCopies": "(val)",
    "awardReportTerm.awardReportTermId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardReportTermRecipientId": "(val)",
    "contactId": "(val)",
    "contactTypeCode": "(val)",
    "rolodexId": "(val)",
    "numberOfCopies": "(val)",
    "awardReportTerm.awardReportTermId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Report Term Recipients by Key
DELETE`/award/api/v1/award-report-term-recipients/(key)`

Example URI

DELETE /award/api/v1/award-report-term-recipients/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Report Term Recipients
DELETE`/award/api/v1/award-report-term-recipients/`

Example URI

DELETE /award/api/v1/award-report-term-recipients/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Report Term Recipients with Matching
DELETE`/award/api/v1/award-report-term-recipients/`

Example URI

DELETE /award/api/v1/award-report-term-recipients/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardReportTermRecipientId: string (optional)
Award Report Terms Recipient Id. Maximum length is 22.
contactId: string (optional)
Contact Type. Maximum length is 12.
contactTypeCode: string (optional)
Contact Type. Maximum length is 22.
rolodexId: string (optional)
Name/Organization. Maximum length is 22.
numberOfCopies: string (optional)
Number of Copies. Maximum length is 22.
awardReportTerm.awardReportTermId: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Report Terms ¶

Get Award Report Terms by Key
GET`/award/api/v1/award-report-terms/(key)`

Example URI

GET /award/api/v1/award-report-terms/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardReportTermId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "frequencyCode": "(val)",
  "frequencyBaseCode": "(val)",
  "ospDistributionCode": "(val)",
  "dueDate": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Report Terms
GET`/award/api/v1/award-report-terms/`

Example URI

GET /award/api/v1/award-report-terms/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardReportTermId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "dueDate": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardReportTermId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "dueDate": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Report Terms with Filtering
GET`/award/api/v1/award-report-terms/`

Example URI

GET /award/api/v1/award-report-terms/

URI Parameters

HideShow

awardReportTermId: string (optional)
Award Report Terms Id. Maximum length is 22.
awardNumber: string (optional)
Award ID. Maximum length is 12.
sequenceNumber: string (optional)
Sequence Number. Maximum length is 22.
reportClassCode: string (optional)
Report Class Code. Maximum length is 22.
reportCode: string (optional)
Type. Maximum length is 22.
frequencyCode: string (optional)
Frequency. Maximum length is 22.
frequencyBaseCode: string (optional)
Frequency Base. Maximum length is 22.
ospDistributionCode: string (optional)
OSP File Copy. Maximum length is 22.
dueDate: string (optional)
Due Date. Maximum length is 10.
award.awardId: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardReportTermId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "dueDate": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardReportTermId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "dueDate": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Report Terms
GET`/award/api/v1/award-report-terms/`

Example URI

GET /award/api/v1/award-report-terms/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardReportTermId",
    "awardNumber",
    "sequenceNumber",
    "reportClassCode",
    "reportCode",
    "frequencyCode",
    "frequencyBaseCode",
    "ospDistributionCode",
    "dueDate",
    "award.awardId"
  ],
  "primaryKey": "awardReportTermId"
}

Get Blueprint API specification for Award Report Terms
GET`/award/api/v1/award-report-terms/`

Example URI

GET /award/api/v1/award-report-terms/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Report Terms.md"
transfer-encoding: chunked

Update Award Report Terms
PUT`/award/api/v1/award-report-terms/(key)`

Example URI

PUT /award/api/v1/award-report-terms/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardReportTermId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "frequencyCode": "(val)",
  "frequencyBaseCode": "(val)",
  "ospDistributionCode": "(val)",
  "dueDate": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Report Terms
PUT`/award/api/v1/award-report-terms/`

Example URI

PUT /award/api/v1/award-report-terms/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardReportTermId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "dueDate": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardReportTermId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "dueDate": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Report Terms
PATCH`/award/api/v1/award-report-terms/(key)`

Example URI

PATCH /award/api/v1/award-report-terms/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardReportTermId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "frequencyCode": "(val)",
  "frequencyBaseCode": "(val)",
  "ospDistributionCode": "(val)",
  "dueDate": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardReportTermId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "frequencyCode": "(val)",
  "frequencyBaseCode": "(val)",
  "ospDistributionCode": "(val)",
  "dueDate": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Report Terms
POST`/award/api/v1/award-report-terms/`

Example URI

POST /award/api/v1/award-report-terms/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardReportTermId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "frequencyCode": "(val)",
  "frequencyBaseCode": "(val)",
  "ospDistributionCode": "(val)",
  "dueDate": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardReportTermId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "frequencyCode": "(val)",
  "frequencyBaseCode": "(val)",
  "ospDistributionCode": "(val)",
  "dueDate": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Report Terms
POST`/award/api/v1/award-report-terms/`

Example URI

POST /award/api/v1/award-report-terms/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardReportTermId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "dueDate": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardReportTermId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "dueDate": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardReportTermId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "dueDate": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardReportTermId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "dueDate": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Report Terms by Key
DELETE`/award/api/v1/award-report-terms/(key)`

Example URI

DELETE /award/api/v1/award-report-terms/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Report Terms
DELETE`/award/api/v1/award-report-terms/`

Example URI

DELETE /award/api/v1/award-report-terms/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Report Terms with Matching
DELETE`/award/api/v1/award-report-terms/`

Example URI

DELETE /award/api/v1/award-report-terms/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardReportTermId: string (optional)
Award Report Terms Id. Maximum length is 22.
awardNumber: string (optional)
Award ID. Maximum length is 12.
sequenceNumber: string (optional)
Sequence Number. Maximum length is 22.
reportClassCode: string (optional)
Report Class Code. Maximum length is 22.
reportCode: string (optional)
Type. Maximum length is 22.
frequencyCode: string (optional)
Frequency. Maximum length is 22.
frequencyBaseCode: string (optional)
Frequency Base. Maximum length is 22.
ospDistributionCode: string (optional)
OSP File Copy. Maximum length is 22.
dueDate: string (optional)
Due Date. Maximum length is 10.
award.awardId: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Science Keywords ¶

Get Award Science Keywords by Key
GET`/award/api/v1/award-science-keywords/(key)`

Example URI

GET /award/api/v1/award-science-keywords/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardScienceKeywordId": "(val)",
  "scienceKeywordCode": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Science Keywords
GET`/award/api/v1/award-science-keywords/`

Example URI

GET /award/api/v1/award-science-keywords/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardScienceKeywordId": "(val)",
    "scienceKeywordCode": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardScienceKeywordId": "(val)",
    "scienceKeywordCode": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Science Keywords with Filtering
GET`/award/api/v1/award-science-keywords/`

Example URI

GET /award/api/v1/award-science-keywords/

URI Parameters

HideShow

awardScienceKeywordId: string (optional)
Award Science Code Id. Maximum length is 22.
scienceKeywordCode: string (optional)
Science Code. Maximum length is 15.
award.awardId: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardScienceKeywordId": "(val)",
    "scienceKeywordCode": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardScienceKeywordId": "(val)",
    "scienceKeywordCode": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Science Keywords
GET`/award/api/v1/award-science-keywords/`

Example URI

GET /award/api/v1/award-science-keywords/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardScienceKeywordId",
    "scienceKeywordCode",
    "award.awardId"
  ],
  "primaryKey": "awardScienceKeywordId"
}

Get Blueprint API specification for Award Science Keywords
GET`/award/api/v1/award-science-keywords/`

Example URI

GET /award/api/v1/award-science-keywords/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Science Keywords.md"
transfer-encoding: chunked

Award Special Review Exemptions ¶

Get Award Special Review Exemptions by Key
GET`/award/api/v1/award-special-review-exemptions/(key)`

Example URI

GET /award/api/v1/award-special-review-exemptions/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardSpecialReviewExemptionId": "(val)",
  "exemptionTypeCode": "(val)",
  "awardSpecialReview.awardSpecialReviewId": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Special Review Exemptions
GET`/award/api/v1/award-special-review-exemptions/`

Example URI

GET /award/api/v1/award-special-review-exemptions/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "awardSpecialReview.awardSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "awardSpecialReview.awardSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Special Review Exemptions with Filtering
GET`/award/api/v1/award-special-review-exemptions/`

Example URI

GET /award/api/v1/award-special-review-exemptions/

URI Parameters

HideShow

awardSpecialReviewExemptionId: string (optional)
Award Special Review Exemption Id. Maximum length is 22.
exemptionTypeCode: string (optional)
Exemption #. Maximum length is 3.
awardSpecialReview.awardSpecialReviewId: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "awardSpecialReview.awardSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "awardSpecialReview.awardSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Special Review Exemptions
GET`/award/api/v1/award-special-review-exemptions/`

Example URI

GET /award/api/v1/award-special-review-exemptions/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardSpecialReviewExemptionId",
    "exemptionTypeCode",
    "awardSpecialReview.awardSpecialReviewId"
  ],
  "primaryKey": "awardSpecialReviewExemptionId"
}

Get Blueprint API specification for Award Special Review Exemptions
GET`/award/api/v1/award-special-review-exemptions/`

Example URI

GET /award/api/v1/award-special-review-exemptions/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Special Review Exemptions.md"
transfer-encoding: chunked

Update Award Special Review Exemptions
PUT`/award/api/v1/award-special-review-exemptions/(key)`

Example URI

PUT /award/api/v1/award-special-review-exemptions/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardSpecialReviewExemptionId": "(val)",
  "exemptionTypeCode": "(val)",
  "awardSpecialReview.awardSpecialReviewId": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Special Review Exemptions
PUT`/award/api/v1/award-special-review-exemptions/`

Example URI

PUT /award/api/v1/award-special-review-exemptions/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "awardSpecialReview.awardSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "awardSpecialReview.awardSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Special Review Exemptions
PATCH`/award/api/v1/award-special-review-exemptions/(key)`

Example URI

PATCH /award/api/v1/award-special-review-exemptions/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardSpecialReviewExemptionId": "(val)",
  "exemptionTypeCode": "(val)",
  "awardSpecialReview.awardSpecialReviewId": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardSpecialReviewExemptionId": "(val)",
  "exemptionTypeCode": "(val)",
  "awardSpecialReview.awardSpecialReviewId": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Special Review Exemptions
POST`/award/api/v1/award-special-review-exemptions/`

Example URI

POST /award/api/v1/award-special-review-exemptions/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardSpecialReviewExemptionId": "(val)",
  "exemptionTypeCode": "(val)",
  "awardSpecialReview.awardSpecialReviewId": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardSpecialReviewExemptionId": "(val)",
  "exemptionTypeCode": "(val)",
  "awardSpecialReview.awardSpecialReviewId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Special Review Exemptions
POST`/award/api/v1/award-special-review-exemptions/`

Example URI

POST /award/api/v1/award-special-review-exemptions/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "awardSpecialReview.awardSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "awardSpecialReview.awardSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "awardSpecialReview.awardSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "awardSpecialReview.awardSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Special Review Exemptions by Key
DELETE`/award/api/v1/award-special-review-exemptions/(key)`

Example URI

DELETE /award/api/v1/award-special-review-exemptions/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Special Review Exemptions
DELETE`/award/api/v1/award-special-review-exemptions/`

Example URI

DELETE /award/api/v1/award-special-review-exemptions/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Special Review Exemptions with Matching
DELETE`/award/api/v1/award-special-review-exemptions/`

Example URI

DELETE /award/api/v1/award-special-review-exemptions/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardSpecialReviewExemptionId: string (optional)
Award Special Review Exemption Id. Maximum length is 22.
exemptionTypeCode: string (optional)
Exemption #. Maximum length is 3.
awardSpecialReview.awardSpecialReviewId: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Special Reviews ¶

Get Award Special Reviews by Key
GET`/award/api/v1/award-special-reviews/(key)`

Example URI

GET /award/api/v1/award-special-reviews/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardSpecialReviewId": "(val)",
  "specialReviewNumber": "(val)",
  "specialReviewTypeCode": "(val)",
  "approvalTypeCode": "(val)",
  "protocolNumber": "(val)",
  "applicationDate": "(val)",
  "approvalDate": "(val)",
  "expirationDate": "(val)",
  "comments": "(val)",
  "sequenceOwner.awardId": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Special Reviews
GET`/award/api/v1/award-special-reviews/`

Example URI

GET /award/api/v1/award-special-reviews/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardSpecialReviewId": "(val)",
    "specialReviewNumber": "(val)",
    "specialReviewTypeCode": "(val)",
    "approvalTypeCode": "(val)",
    "protocolNumber": "(val)",
    "applicationDate": "(val)",
    "approvalDate": "(val)",
    "expirationDate": "(val)",
    "comments": "(val)",
    "sequenceOwner.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSpecialReviewId": "(val)",
    "specialReviewNumber": "(val)",
    "specialReviewTypeCode": "(val)",
    "approvalTypeCode": "(val)",
    "protocolNumber": "(val)",
    "applicationDate": "(val)",
    "approvalDate": "(val)",
    "expirationDate": "(val)",
    "comments": "(val)",
    "sequenceOwner.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Special Reviews with Filtering
GET`/award/api/v1/award-special-reviews/`

Example URI

GET /award/api/v1/award-special-reviews/

URI Parameters

HideShow

awardSpecialReviewId: string (optional)
Award Special Review Id. Maximum length is 22.
specialReviewNumber: string (optional)
Special Review Number. Maximum length is 22.
specialReviewTypeCode: string (optional)
Special Review Type Code. Maximum length is 3.
approvalTypeCode: string (optional)
Approval Status Type Code. Maximum length is 3.
protocolNumber: string (optional)
Protocol Number. Maximum length is 20.
applicationDate: string (optional)
Application Date. Maximum length is 10.
approvalDate: string (optional)
Approval Date. Maximum length is 10.
expirationDate: string (optional)
Expiration Date. Maximum length is 10.
comments: string (optional)
Comments. Maximum length is 2000.
sequenceOwner.awardId: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardSpecialReviewId": "(val)",
    "specialReviewNumber": "(val)",
    "specialReviewTypeCode": "(val)",
    "approvalTypeCode": "(val)",
    "protocolNumber": "(val)",
    "applicationDate": "(val)",
    "approvalDate": "(val)",
    "expirationDate": "(val)",
    "comments": "(val)",
    "sequenceOwner.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSpecialReviewId": "(val)",
    "specialReviewNumber": "(val)",
    "specialReviewTypeCode": "(val)",
    "approvalTypeCode": "(val)",
    "protocolNumber": "(val)",
    "applicationDate": "(val)",
    "approvalDate": "(val)",
    "expirationDate": "(val)",
    "comments": "(val)",
    "sequenceOwner.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Special Reviews
GET`/award/api/v1/award-special-reviews/`

Example URI

GET /award/api/v1/award-special-reviews/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardSpecialReviewId",
    "specialReviewNumber",
    "specialReviewTypeCode",
    "approvalTypeCode",
    "protocolNumber",
    "applicationDate",
    "approvalDate",
    "expirationDate",
    "comments",
    "sequenceOwner.awardId"
  ],
  "primaryKey": "awardSpecialReviewId"
}

Get Blueprint API specification for Award Special Reviews
GET`/award/api/v1/award-special-reviews/`

Example URI

GET /award/api/v1/award-special-reviews/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Special Reviews.md"
transfer-encoding: chunked

Update Award Special Reviews
PUT`/award/api/v1/award-special-reviews/(key)`

Example URI

PUT /award/api/v1/award-special-reviews/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardSpecialReviewId": "(val)",
  "specialReviewNumber": "(val)",
  "specialReviewTypeCode": "(val)",
  "approvalTypeCode": "(val)",
  "protocolNumber": "(val)",
  "applicationDate": "(val)",
  "approvalDate": "(val)",
  "expirationDate": "(val)",
  "comments": "(val)",
  "sequenceOwner.awardId": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Special Reviews
PUT`/award/api/v1/award-special-reviews/`

Example URI

PUT /award/api/v1/award-special-reviews/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardSpecialReviewId": "(val)",
    "specialReviewNumber": "(val)",
    "specialReviewTypeCode": "(val)",
    "approvalTypeCode": "(val)",
    "protocolNumber": "(val)",
    "applicationDate": "(val)",
    "approvalDate": "(val)",
    "expirationDate": "(val)",
    "comments": "(val)",
    "sequenceOwner.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSpecialReviewId": "(val)",
    "specialReviewNumber": "(val)",
    "specialReviewTypeCode": "(val)",
    "approvalTypeCode": "(val)",
    "protocolNumber": "(val)",
    "applicationDate": "(val)",
    "approvalDate": "(val)",
    "expirationDate": "(val)",
    "comments": "(val)",
    "sequenceOwner.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Special Reviews
PATCH`/award/api/v1/award-special-reviews/(key)`

Example URI

PATCH /award/api/v1/award-special-reviews/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardSpecialReviewId": "(val)",
  "specialReviewNumber": "(val)",
  "specialReviewTypeCode": "(val)",
  "approvalTypeCode": "(val)",
  "protocolNumber": "(val)",
  "applicationDate": "(val)",
  "approvalDate": "(val)",
  "expirationDate": "(val)",
  "comments": "(val)",
  "sequenceOwner.awardId": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardSpecialReviewId": "(val)",
  "specialReviewNumber": "(val)",
  "specialReviewTypeCode": "(val)",
  "approvalTypeCode": "(val)",
  "protocolNumber": "(val)",
  "applicationDate": "(val)",
  "approvalDate": "(val)",
  "expirationDate": "(val)",
  "comments": "(val)",
  "sequenceOwner.awardId": "(val)",
  "_primaryKey": "(val)"
}

Award Sponsor Contacts ¶

Get Award Sponsor Contacts by Key
GET`/award/api/v1/award-sponsor-contacts/(key)`

Example URI

GET /award/api/v1/award-sponsor-contacts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardContactId": "(val)",
  "rolodexId": "(val)",
  "fullName": "(val)",
  "roleCode": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Sponsor Contacts
GET`/award/api/v1/award-sponsor-contacts/`

Example URI

GET /award/api/v1/award-sponsor-contacts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardContactId": "(val)",
    "rolodexId": "(val)",
    "fullName": "(val)",
    "roleCode": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardContactId": "(val)",
    "rolodexId": "(val)",
    "fullName": "(val)",
    "roleCode": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Sponsor Contacts with Filtering
GET`/award/api/v1/award-sponsor-contacts/`

Example URI

GET /award/api/v1/award-sponsor-contacts/

URI Parameters

HideShow

awardContactId: string (optional)
rolodexId: string (optional)
fullName: string (optional)
roleCode: string (optional)
awardNumber: string (optional)
sequenceNumber: string (optional)
award.awardId: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardContactId": "(val)",
    "rolodexId": "(val)",
    "fullName": "(val)",
    "roleCode": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardContactId": "(val)",
    "rolodexId": "(val)",
    "fullName": "(val)",
    "roleCode": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Sponsor Contacts
GET`/award/api/v1/award-sponsor-contacts/`

Example URI

GET /award/api/v1/award-sponsor-contacts/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardContactId",
    "rolodexId",
    "fullName",
    "roleCode",
    "awardNumber",
    "sequenceNumber",
    "award.awardId"
  ],
  "primaryKey": "awardContactId"
}

Get Blueprint API specification for Award Sponsor Contacts
GET`/award/api/v1/award-sponsor-contacts/`

Example URI

GET /award/api/v1/award-sponsor-contacts/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Sponsor Contacts.md"
transfer-encoding: chunked

Award Sponsor Terms ¶

Get Award Sponsor Terms by Key
GET`/award/api/v1/award-sponsor-terms/(key)`

Example URI

GET /award/api/v1/award-sponsor-terms/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardSponsorTermId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "sponsorTermId": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Sponsor Terms
GET`/award/api/v1/award-sponsor-terms/`

Example URI

GET /award/api/v1/award-sponsor-terms/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardSponsorTermId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "sponsorTermId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSponsorTermId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "sponsorTermId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Sponsor Terms with Filtering
GET`/award/api/v1/award-sponsor-terms/`

Example URI

GET /award/api/v1/award-sponsor-terms/

URI Parameters

HideShow

awardSponsorTermId: string (optional)
Award Sponsor Term Id. Maximum length is 22.
awardNumber: string (optional)
sequenceNumber: string (optional)
sponsorTermId: string (optional)
Sponsor Term Id. Maximum length is 22.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardSponsorTermId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "sponsorTermId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSponsorTermId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "sponsorTermId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Sponsor Terms
GET`/award/api/v1/award-sponsor-terms/`

Example URI

GET /award/api/v1/award-sponsor-terms/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardSponsorTermId",
    "awardNumber",
    "sequenceNumber",
    "sponsorTermId"
  ],
  "primaryKey": "awardSponsorTermId"
}

Get Blueprint API specification for Award Sponsor Terms
GET`/award/api/v1/award-sponsor-terms/`

Example URI

GET /award/api/v1/award-sponsor-terms/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Sponsor Terms.md"
transfer-encoding: chunked

Award Statuses ¶

Get Award Statuses by Key
GET`/award/api/v1/award-statuses/(key)`

Example URI

GET /award/api/v1/award-statuses/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "statusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Statuses
GET`/award/api/v1/award-statuses/`

Example URI

GET /award/api/v1/award-statuses/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "statusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "statusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Statuses with Filtering
GET`/award/api/v1/award-statuses/`

Example URI

GET /award/api/v1/award-statuses/

URI Parameters

HideShow

statusCode: string (optional)
Status Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "statusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "statusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Statuses
GET`/award/api/v1/award-statuses/`

Example URI

GET /award/api/v1/award-statuses/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "statusCode",
    "description"
  ],
  "primaryKey": "statusCode"
}

Get Blueprint API specification for Award Statuses
GET`/award/api/v1/award-statuses/`

Example URI

GET /award/api/v1/award-statuses/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Statuses.md"
transfer-encoding: chunked

Update Award Statuses
PUT`/award/api/v1/award-statuses/(key)`

Example URI

PUT /award/api/v1/award-statuses/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "statusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Statuses
PUT`/award/api/v1/award-statuses/`

Example URI

PUT /award/api/v1/award-statuses/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "statusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "statusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Statuses
PATCH`/award/api/v1/award-statuses/(key)`

Example URI

PATCH /award/api/v1/award-statuses/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "statusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "statusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Statuses
POST`/award/api/v1/award-statuses/`

Example URI

POST /award/api/v1/award-statuses/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "statusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "statusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Statuses
POST`/award/api/v1/award-statuses/`

Example URI

POST /award/api/v1/award-statuses/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "statusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "statusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "statusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "statusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Statuses by Key
DELETE`/award/api/v1/award-statuses/(key)`

Example URI

DELETE /award/api/v1/award-statuses/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Statuses
DELETE`/award/api/v1/award-statuses/`

Example URI

DELETE /award/api/v1/award-statuses/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Statuses with Matching
DELETE`/award/api/v1/award-statuses/`

Example URI

DELETE /award/api/v1/award-statuses/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
statusCode: string (optional)
Status Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Subcontracting Budgeted Goals ¶

Get Award Subcontracting Budgeted Goals by Key
GET`/award/api/v1/award-subcontracting-budgeted-goals/(key)`

Example URI

GET /award/api/v1/award-subcontracting-budgeted-goals/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardNumber": "(val)",
  "largeBusinessGoalAmount": "(val)",
  "smallBusinessGoalAmount": "(val)",
  "womanOwnedGoalAmount": "(val)",
  "eightADisadvantageGoalAmount": "(val)",
  "hubZoneGoalAmount": "(val)",
  "veteranOwnedGoalAmount": "(val)",
  "serviceDisabledVeteranOwnedGoalAmount": "(val)",
  "historicalBlackCollegeGoalAmount": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Subcontracting Budgeted Goals
GET`/award/api/v1/award-subcontracting-budgeted-goals/`

Example URI

GET /award/api/v1/award-subcontracting-budgeted-goals/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardNumber": "(val)",
    "largeBusinessGoalAmount": "(val)",
    "smallBusinessGoalAmount": "(val)",
    "womanOwnedGoalAmount": "(val)",
    "eightADisadvantageGoalAmount": "(val)",
    "hubZoneGoalAmount": "(val)",
    "veteranOwnedGoalAmount": "(val)",
    "serviceDisabledVeteranOwnedGoalAmount": "(val)",
    "historicalBlackCollegeGoalAmount": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNumber": "(val)",
    "largeBusinessGoalAmount": "(val)",
    "smallBusinessGoalAmount": "(val)",
    "womanOwnedGoalAmount": "(val)",
    "eightADisadvantageGoalAmount": "(val)",
    "hubZoneGoalAmount": "(val)",
    "veteranOwnedGoalAmount": "(val)",
    "serviceDisabledVeteranOwnedGoalAmount": "(val)",
    "historicalBlackCollegeGoalAmount": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Subcontracting Budgeted Goals with Filtering
GET`/award/api/v1/award-subcontracting-budgeted-goals/`

Example URI

GET /award/api/v1/award-subcontracting-budgeted-goals/

URI Parameters

HideShow

awardNumber: string (optional)
Award ID. Maximum length is 12.
largeBusinessGoalAmount: string (optional)
Large Business Goal Amount. Maximum length is 22.
smallBusinessGoalAmount: string (optional)
Small Business Goal Amount. Maximum length is 22.
womanOwnedGoalAmount: string (optional)
Woman Owned Goal Amount. Maximum length is 22.
eightADisadvantageGoalAmount: string (optional)
8A Disadvantage Goal Amount. Maximum length is 22.
hubZoneGoalAmount: string (optional)
Hub Zone Goal Amount. Maximum length is 22.
veteranOwnedGoalAmount: string (optional)
Veteran Owned Goal Amount. Maximum length is 22.
serviceDisabledVeteranOwnedGoalAmount: string (optional)
Service Disabled Veteran Owned Goal Amount. Maximum length is 22.
historicalBlackCollegeGoalAmount: string (optional)
Historical Black College Goal Amount. Maximum length is 22.
comments: string (optional)
Comments. Maximum length is 800.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardNumber": "(val)",
    "largeBusinessGoalAmount": "(val)",
    "smallBusinessGoalAmount": "(val)",
    "womanOwnedGoalAmount": "(val)",
    "eightADisadvantageGoalAmount": "(val)",
    "hubZoneGoalAmount": "(val)",
    "veteranOwnedGoalAmount": "(val)",
    "serviceDisabledVeteranOwnedGoalAmount": "(val)",
    "historicalBlackCollegeGoalAmount": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNumber": "(val)",
    "largeBusinessGoalAmount": "(val)",
    "smallBusinessGoalAmount": "(val)",
    "womanOwnedGoalAmount": "(val)",
    "eightADisadvantageGoalAmount": "(val)",
    "hubZoneGoalAmount": "(val)",
    "veteranOwnedGoalAmount": "(val)",
    "serviceDisabledVeteranOwnedGoalAmount": "(val)",
    "historicalBlackCollegeGoalAmount": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Subcontracting Budgeted Goals
GET`/award/api/v1/award-subcontracting-budgeted-goals/`

Example URI

GET /award/api/v1/award-subcontracting-budgeted-goals/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardNumber",
    "largeBusinessGoalAmount",
    "smallBusinessGoalAmount",
    "womanOwnedGoalAmount",
    "eightADisadvantageGoalAmount",
    "hubZoneGoalAmount",
    "veteranOwnedGoalAmount",
    "serviceDisabledVeteranOwnedGoalAmount",
    "historicalBlackCollegeGoalAmount",
    "comments"
  ],
  "primaryKey": "awardNumber"
}

Get Blueprint API specification for Award Subcontracting Budgeted Goals
GET`/award/api/v1/award-subcontracting-budgeted-goals/`

Example URI

GET /award/api/v1/award-subcontracting-budgeted-goals/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Subcontracting Budgeted Goals.md"
transfer-encoding: chunked

Update Award Subcontracting Budgeted Goals
PUT`/award/api/v1/award-subcontracting-budgeted-goals/(key)`

Example URI

PUT /award/api/v1/award-subcontracting-budgeted-goals/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardNumber": "(val)",
  "largeBusinessGoalAmount": "(val)",
  "smallBusinessGoalAmount": "(val)",
  "womanOwnedGoalAmount": "(val)",
  "eightADisadvantageGoalAmount": "(val)",
  "hubZoneGoalAmount": "(val)",
  "veteranOwnedGoalAmount": "(val)",
  "serviceDisabledVeteranOwnedGoalAmount": "(val)",
  "historicalBlackCollegeGoalAmount": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Subcontracting Budgeted Goals
PUT`/award/api/v1/award-subcontracting-budgeted-goals/`

Example URI

PUT /award/api/v1/award-subcontracting-budgeted-goals/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardNumber": "(val)",
    "largeBusinessGoalAmount": "(val)",
    "smallBusinessGoalAmount": "(val)",
    "womanOwnedGoalAmount": "(val)",
    "eightADisadvantageGoalAmount": "(val)",
    "hubZoneGoalAmount": "(val)",
    "veteranOwnedGoalAmount": "(val)",
    "serviceDisabledVeteranOwnedGoalAmount": "(val)",
    "historicalBlackCollegeGoalAmount": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNumber": "(val)",
    "largeBusinessGoalAmount": "(val)",
    "smallBusinessGoalAmount": "(val)",
    "womanOwnedGoalAmount": "(val)",
    "eightADisadvantageGoalAmount": "(val)",
    "hubZoneGoalAmount": "(val)",
    "veteranOwnedGoalAmount": "(val)",
    "serviceDisabledVeteranOwnedGoalAmount": "(val)",
    "historicalBlackCollegeGoalAmount": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Subcontracting Budgeted Goals
PATCH`/award/api/v1/award-subcontracting-budgeted-goals/(key)`

Example URI

PATCH /award/api/v1/award-subcontracting-budgeted-goals/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardNumber": "(val)",
  "largeBusinessGoalAmount": "(val)",
  "smallBusinessGoalAmount": "(val)",
  "womanOwnedGoalAmount": "(val)",
  "eightADisadvantageGoalAmount": "(val)",
  "hubZoneGoalAmount": "(val)",
  "veteranOwnedGoalAmount": "(val)",
  "serviceDisabledVeteranOwnedGoalAmount": "(val)",
  "historicalBlackCollegeGoalAmount": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardNumber": "(val)",
  "largeBusinessGoalAmount": "(val)",
  "smallBusinessGoalAmount": "(val)",
  "womanOwnedGoalAmount": "(val)",
  "eightADisadvantageGoalAmount": "(val)",
  "hubZoneGoalAmount": "(val)",
  "veteranOwnedGoalAmount": "(val)",
  "serviceDisabledVeteranOwnedGoalAmount": "(val)",
  "historicalBlackCollegeGoalAmount": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Subcontracting Budgeted Goals
POST`/award/api/v1/award-subcontracting-budgeted-goals/`

Example URI

POST /award/api/v1/award-subcontracting-budgeted-goals/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardNumber": "(val)",
  "largeBusinessGoalAmount": "(val)",
  "smallBusinessGoalAmount": "(val)",
  "womanOwnedGoalAmount": "(val)",
  "eightADisadvantageGoalAmount": "(val)",
  "hubZoneGoalAmount": "(val)",
  "veteranOwnedGoalAmount": "(val)",
  "serviceDisabledVeteranOwnedGoalAmount": "(val)",
  "historicalBlackCollegeGoalAmount": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardNumber": "(val)",
  "largeBusinessGoalAmount": "(val)",
  "smallBusinessGoalAmount": "(val)",
  "womanOwnedGoalAmount": "(val)",
  "eightADisadvantageGoalAmount": "(val)",
  "hubZoneGoalAmount": "(val)",
  "veteranOwnedGoalAmount": "(val)",
  "serviceDisabledVeteranOwnedGoalAmount": "(val)",
  "historicalBlackCollegeGoalAmount": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Subcontracting Budgeted Goals
POST`/award/api/v1/award-subcontracting-budgeted-goals/`

Example URI

POST /award/api/v1/award-subcontracting-budgeted-goals/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardNumber": "(val)",
    "largeBusinessGoalAmount": "(val)",
    "smallBusinessGoalAmount": "(val)",
    "womanOwnedGoalAmount": "(val)",
    "eightADisadvantageGoalAmount": "(val)",
    "hubZoneGoalAmount": "(val)",
    "veteranOwnedGoalAmount": "(val)",
    "serviceDisabledVeteranOwnedGoalAmount": "(val)",
    "historicalBlackCollegeGoalAmount": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNumber": "(val)",
    "largeBusinessGoalAmount": "(val)",
    "smallBusinessGoalAmount": "(val)",
    "womanOwnedGoalAmount": "(val)",
    "eightADisadvantageGoalAmount": "(val)",
    "hubZoneGoalAmount": "(val)",
    "veteranOwnedGoalAmount": "(val)",
    "serviceDisabledVeteranOwnedGoalAmount": "(val)",
    "historicalBlackCollegeGoalAmount": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardNumber": "(val)",
    "largeBusinessGoalAmount": "(val)",
    "smallBusinessGoalAmount": "(val)",
    "womanOwnedGoalAmount": "(val)",
    "eightADisadvantageGoalAmount": "(val)",
    "hubZoneGoalAmount": "(val)",
    "veteranOwnedGoalAmount": "(val)",
    "serviceDisabledVeteranOwnedGoalAmount": "(val)",
    "historicalBlackCollegeGoalAmount": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNumber": "(val)",
    "largeBusinessGoalAmount": "(val)",
    "smallBusinessGoalAmount": "(val)",
    "womanOwnedGoalAmount": "(val)",
    "eightADisadvantageGoalAmount": "(val)",
    "hubZoneGoalAmount": "(val)",
    "veteranOwnedGoalAmount": "(val)",
    "serviceDisabledVeteranOwnedGoalAmount": "(val)",
    "historicalBlackCollegeGoalAmount": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Subcontracting Budgeted Goals by Key
DELETE`/award/api/v1/award-subcontracting-budgeted-goals/(key)`

Example URI

DELETE /award/api/v1/award-subcontracting-budgeted-goals/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Subcontracting Budgeted Goals
DELETE`/award/api/v1/award-subcontracting-budgeted-goals/`

Example URI

DELETE /award/api/v1/award-subcontracting-budgeted-goals/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Subcontracting Budgeted Goals with Matching
DELETE`/award/api/v1/award-subcontracting-budgeted-goals/`

Example URI

DELETE /award/api/v1/award-subcontracting-budgeted-goals/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardNumber: string (optional)
Award ID. Maximum length is 12.
largeBusinessGoalAmount: string (optional)
Large Business Goal Amount. Maximum length is 22.
smallBusinessGoalAmount: string (optional)
Small Business Goal Amount. Maximum length is 22.
womanOwnedGoalAmount: string (optional)
Woman Owned Goal Amount. Maximum length is 22.
eightADisadvantageGoalAmount: string (optional)
8A Disadvantage Goal Amount. Maximum length is 22.
hubZoneGoalAmount: string (optional)
Hub Zone Goal Amount. Maximum length is 22.
veteranOwnedGoalAmount: string (optional)
Veteran Owned Goal Amount. Maximum length is 22.
serviceDisabledVeteranOwnedGoalAmount: string (optional)
Service Disabled Veteran Owned Goal Amount. Maximum length is 22.
historicalBlackCollegeGoalAmount: string (optional)
Historical Black College Goal Amount. Maximum length is 22.
comments: string (optional)
Comments. Maximum length is 800.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Sync Changes ¶

Get Award Sync Changes by Key
GET`/award/api/v1/award-sync-changes/(key)`

Example URI

GET /award/api/v1/award-sync-changes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardSyncChangeId": "(val)",
  "awardId": "(val)",
  "xml": "(val)",
  "className": "(val)",
  "attrName": "(val)",
  "objectDesc": "(val)",
  "dataDesc": "(val)",
  "syncType": "(val)",
  "syncDescendants": "(val)",
  "syncFabricated": "(val)",
  "syncCostSharing": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Sync Changes
GET`/award/api/v1/award-sync-changes/`

Example URI

GET /award/api/v1/award-sync-changes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardSyncChangeId": "(val)",
    "awardId": "(val)",
    "xml": "(val)",
    "className": "(val)",
    "attrName": "(val)",
    "objectDesc": "(val)",
    "dataDesc": "(val)",
    "syncType": "(val)",
    "syncDescendants": "(val)",
    "syncFabricated": "(val)",
    "syncCostSharing": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSyncChangeId": "(val)",
    "awardId": "(val)",
    "xml": "(val)",
    "className": "(val)",
    "attrName": "(val)",
    "objectDesc": "(val)",
    "dataDesc": "(val)",
    "syncType": "(val)",
    "syncDescendants": "(val)",
    "syncFabricated": "(val)",
    "syncCostSharing": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Sync Changes with Filtering
GET`/award/api/v1/award-sync-changes/`

Example URI

GET /award/api/v1/award-sync-changes/

URI Parameters

HideShow

awardSyncChangeId: string (optional)
Award Sync Change Id. Maximum length is 40.
awardId: string (optional)
Award Id. Maximum length is 12.
xml: string (optional)
XML describing the change for persistence. Maximum length is 999999999.
className: string (optional)
Class Name. Maximum length is 100.
attrName: string (optional)
Attribute Name. Maximum length is 50.
objectDesc: string (optional)
Text description of the object changed. Maximum length is 500.
dataDesc: string (optional)
Text description of the data changed. Maximum length is 500.
syncType: string (optional)
Type of syncronization. Maximum length is 1.
syncDescendants: string (optional)
Syncronize Descendents. Maximum length is 6.
syncFabricated: string (optional)
Syncronize Fabricated Descendents. Maximum length is 1.
syncCostSharing: string (optional)
Syncronize Cost Sharing Accounts. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardSyncChangeId": "(val)",
    "awardId": "(val)",
    "xml": "(val)",
    "className": "(val)",
    "attrName": "(val)",
    "objectDesc": "(val)",
    "dataDesc": "(val)",
    "syncType": "(val)",
    "syncDescendants": "(val)",
    "syncFabricated": "(val)",
    "syncCostSharing": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSyncChangeId": "(val)",
    "awardId": "(val)",
    "xml": "(val)",
    "className": "(val)",
    "attrName": "(val)",
    "objectDesc": "(val)",
    "dataDesc": "(val)",
    "syncType": "(val)",
    "syncDescendants": "(val)",
    "syncFabricated": "(val)",
    "syncCostSharing": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Sync Changes
GET`/award/api/v1/award-sync-changes/`

Example URI

GET /award/api/v1/award-sync-changes/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardSyncChangeId",
    "awardId",
    "xml",
    "className",
    "attrName",
    "objectDesc",
    "dataDesc",
    "syncType",
    "syncDescendants",
    "syncFabricated",
    "syncCostSharing"
  ],
  "primaryKey": "awardSyncChangeId"
}

Get Blueprint API specification for Award Sync Changes
GET`/award/api/v1/award-sync-changes/`

Example URI

GET /award/api/v1/award-sync-changes/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Sync Changes.md"
transfer-encoding: chunked

Update Award Sync Changes
PUT`/award/api/v1/award-sync-changes/(key)`

Example URI

PUT /award/api/v1/award-sync-changes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardSyncChangeId": "(val)",
  "awardId": "(val)",
  "xml": "(val)",
  "className": "(val)",
  "attrName": "(val)",
  "objectDesc": "(val)",
  "dataDesc": "(val)",
  "syncType": "(val)",
  "syncDescendants": "(val)",
  "syncFabricated": "(val)",
  "syncCostSharing": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Sync Changes
PUT`/award/api/v1/award-sync-changes/`

Example URI

PUT /award/api/v1/award-sync-changes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardSyncChangeId": "(val)",
    "awardId": "(val)",
    "xml": "(val)",
    "className": "(val)",
    "attrName": "(val)",
    "objectDesc": "(val)",
    "dataDesc": "(val)",
    "syncType": "(val)",
    "syncDescendants": "(val)",
    "syncFabricated": "(val)",
    "syncCostSharing": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSyncChangeId": "(val)",
    "awardId": "(val)",
    "xml": "(val)",
    "className": "(val)",
    "attrName": "(val)",
    "objectDesc": "(val)",
    "dataDesc": "(val)",
    "syncType": "(val)",
    "syncDescendants": "(val)",
    "syncFabricated": "(val)",
    "syncCostSharing": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Sync Changes
PATCH`/award/api/v1/award-sync-changes/(key)`

Example URI

PATCH /award/api/v1/award-sync-changes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardSyncChangeId": "(val)",
  "awardId": "(val)",
  "xml": "(val)",
  "className": "(val)",
  "attrName": "(val)",
  "objectDesc": "(val)",
  "dataDesc": "(val)",
  "syncType": "(val)",
  "syncDescendants": "(val)",
  "syncFabricated": "(val)",
  "syncCostSharing": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardSyncChangeId": "(val)",
  "awardId": "(val)",
  "xml": "(val)",
  "className": "(val)",
  "attrName": "(val)",
  "objectDesc": "(val)",
  "dataDesc": "(val)",
  "syncType": "(val)",
  "syncDescendants": "(val)",
  "syncFabricated": "(val)",
  "syncCostSharing": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Sync Changes
POST`/award/api/v1/award-sync-changes/`

Example URI

POST /award/api/v1/award-sync-changes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardSyncChangeId": "(val)",
  "awardId": "(val)",
  "xml": "(val)",
  "className": "(val)",
  "attrName": "(val)",
  "objectDesc": "(val)",
  "dataDesc": "(val)",
  "syncType": "(val)",
  "syncDescendants": "(val)",
  "syncFabricated": "(val)",
  "syncCostSharing": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardSyncChangeId": "(val)",
  "awardId": "(val)",
  "xml": "(val)",
  "className": "(val)",
  "attrName": "(val)",
  "objectDesc": "(val)",
  "dataDesc": "(val)",
  "syncType": "(val)",
  "syncDescendants": "(val)",
  "syncFabricated": "(val)",
  "syncCostSharing": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Sync Changes
POST`/award/api/v1/award-sync-changes/`

Example URI

POST /award/api/v1/award-sync-changes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardSyncChangeId": "(val)",
    "awardId": "(val)",
    "xml": "(val)",
    "className": "(val)",
    "attrName": "(val)",
    "objectDesc": "(val)",
    "dataDesc": "(val)",
    "syncType": "(val)",
    "syncDescendants": "(val)",
    "syncFabricated": "(val)",
    "syncCostSharing": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSyncChangeId": "(val)",
    "awardId": "(val)",
    "xml": "(val)",
    "className": "(val)",
    "attrName": "(val)",
    "objectDesc": "(val)",
    "dataDesc": "(val)",
    "syncType": "(val)",
    "syncDescendants": "(val)",
    "syncFabricated": "(val)",
    "syncCostSharing": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardSyncChangeId": "(val)",
    "awardId": "(val)",
    "xml": "(val)",
    "className": "(val)",
    "attrName": "(val)",
    "objectDesc": "(val)",
    "dataDesc": "(val)",
    "syncType": "(val)",
    "syncDescendants": "(val)",
    "syncFabricated": "(val)",
    "syncCostSharing": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSyncChangeId": "(val)",
    "awardId": "(val)",
    "xml": "(val)",
    "className": "(val)",
    "attrName": "(val)",
    "objectDesc": "(val)",
    "dataDesc": "(val)",
    "syncType": "(val)",
    "syncDescendants": "(val)",
    "syncFabricated": "(val)",
    "syncCostSharing": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Sync Changes by Key
DELETE`/award/api/v1/award-sync-changes/(key)`

Example URI

DELETE /award/api/v1/award-sync-changes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Sync Changes
DELETE`/award/api/v1/award-sync-changes/`

Example URI

DELETE /award/api/v1/award-sync-changes/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Sync Changes with Matching
DELETE`/award/api/v1/award-sync-changes/`

Example URI

DELETE /award/api/v1/award-sync-changes/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardSyncChangeId: string (optional)
Award Sync Change Id. Maximum length is 40.
awardId: string (optional)
Award Id. Maximum length is 12.
xml: string (optional)
XML describing the change for persistence. Maximum length is 999999999.
className: string (optional)
Class Name. Maximum length is 100.
attrName: string (optional)
Attribute Name. Maximum length is 50.
objectDesc: string (optional)
Text description of the object changed. Maximum length is 500.
dataDesc: string (optional)
Text description of the data changed. Maximum length is 500.
syncType: string (optional)
Type of syncronization. Maximum length is 1.
syncDescendants: string (optional)
Syncronize Descendents. Maximum length is 6.
syncFabricated: string (optional)
Syncronize Fabricated Descendents. Maximum length is 1.
syncCostSharing: string (optional)
Syncronize Cost Sharing Accounts. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Sync Logs ¶

Get Award Sync Logs by Key
GET`/award/api/v1/award-sync-logs/(key)`

Example URI

GET /award/api/v1/award-sync-logs/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardSyncLogId": "(val)",
  "awardSyncStatusId": "(val)",
  "awardSyncChangeId": "(val)",
  "success": "(val)",
  "logTypeCode": "(val)",
  "status": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Sync Logs
GET`/award/api/v1/award-sync-logs/`

Example URI

GET /award/api/v1/award-sync-logs/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardSyncLogId": "(val)",
    "awardSyncStatusId": "(val)",
    "awardSyncChangeId": "(val)",
    "success": "(val)",
    "logTypeCode": "(val)",
    "status": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSyncLogId": "(val)",
    "awardSyncStatusId": "(val)",
    "awardSyncChangeId": "(val)",
    "success": "(val)",
    "logTypeCode": "(val)",
    "status": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Sync Logs with Filtering
GET`/award/api/v1/award-sync-logs/`

Example URI

GET /award/api/v1/award-sync-logs/

URI Parameters

HideShow

awardSyncLogId: string (optional)
Award Sync Log Id. Maximum length is 40.
awardSyncStatusId: string (optional)
Award Sync Status Id. Maximum length is 40.
awardSyncChangeId: string (optional)
Award Sync Change Id. Maximum length is 40.
success: string (optional)
Success. Maximum length is 1.
logTypeCode: string (optional)
Log Type. Maximum length is 2.
status: string (optional)
Result Message. Maximum length is 4000.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardSyncLogId": "(val)",
    "awardSyncStatusId": "(val)",
    "awardSyncChangeId": "(val)",
    "success": "(val)",
    "logTypeCode": "(val)",
    "status": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSyncLogId": "(val)",
    "awardSyncStatusId": "(val)",
    "awardSyncChangeId": "(val)",
    "success": "(val)",
    "logTypeCode": "(val)",
    "status": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Sync Logs
GET`/award/api/v1/award-sync-logs/`

Example URI

GET /award/api/v1/award-sync-logs/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardSyncLogId",
    "awardSyncStatusId",
    "awardSyncChangeId",
    "success",
    "logTypeCode",
    "status"
  ],
  "primaryKey": "awardSyncLogId"
}

Get Blueprint API specification for Award Sync Logs
GET`/award/api/v1/award-sync-logs/`

Example URI

GET /award/api/v1/award-sync-logs/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Sync Logs.md"
transfer-encoding: chunked

Update Award Sync Logs
PUT`/award/api/v1/award-sync-logs/(key)`

Example URI

PUT /award/api/v1/award-sync-logs/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardSyncLogId": "(val)",
  "awardSyncStatusId": "(val)",
  "awardSyncChangeId": "(val)",
  "success": "(val)",
  "logTypeCode": "(val)",
  "status": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Sync Logs
PUT`/award/api/v1/award-sync-logs/`

Example URI

PUT /award/api/v1/award-sync-logs/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardSyncLogId": "(val)",
    "awardSyncStatusId": "(val)",
    "awardSyncChangeId": "(val)",
    "success": "(val)",
    "logTypeCode": "(val)",
    "status": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSyncLogId": "(val)",
    "awardSyncStatusId": "(val)",
    "awardSyncChangeId": "(val)",
    "success": "(val)",
    "logTypeCode": "(val)",
    "status": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Sync Logs
PATCH`/award/api/v1/award-sync-logs/(key)`

Example URI

PATCH /award/api/v1/award-sync-logs/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardSyncLogId": "(val)",
  "awardSyncStatusId": "(val)",
  "awardSyncChangeId": "(val)",
  "success": "(val)",
  "logTypeCode": "(val)",
  "status": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardSyncLogId": "(val)",
  "awardSyncStatusId": "(val)",
  "awardSyncChangeId": "(val)",
  "success": "(val)",
  "logTypeCode": "(val)",
  "status": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Sync Logs
POST`/award/api/v1/award-sync-logs/`

Example URI

POST /award/api/v1/award-sync-logs/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardSyncLogId": "(val)",
  "awardSyncStatusId": "(val)",
  "awardSyncChangeId": "(val)",
  "success": "(val)",
  "logTypeCode": "(val)",
  "status": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardSyncLogId": "(val)",
  "awardSyncStatusId": "(val)",
  "awardSyncChangeId": "(val)",
  "success": "(val)",
  "logTypeCode": "(val)",
  "status": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Sync Logs
POST`/award/api/v1/award-sync-logs/`

Example URI

POST /award/api/v1/award-sync-logs/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardSyncLogId": "(val)",
    "awardSyncStatusId": "(val)",
    "awardSyncChangeId": "(val)",
    "success": "(val)",
    "logTypeCode": "(val)",
    "status": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSyncLogId": "(val)",
    "awardSyncStatusId": "(val)",
    "awardSyncChangeId": "(val)",
    "success": "(val)",
    "logTypeCode": "(val)",
    "status": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardSyncLogId": "(val)",
    "awardSyncStatusId": "(val)",
    "awardSyncChangeId": "(val)",
    "success": "(val)",
    "logTypeCode": "(val)",
    "status": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSyncLogId": "(val)",
    "awardSyncStatusId": "(val)",
    "awardSyncChangeId": "(val)",
    "success": "(val)",
    "logTypeCode": "(val)",
    "status": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Sync Logs by Key
DELETE`/award/api/v1/award-sync-logs/(key)`

Example URI

DELETE /award/api/v1/award-sync-logs/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Sync Logs
DELETE`/award/api/v1/award-sync-logs/`

Example URI

DELETE /award/api/v1/award-sync-logs/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Sync Logs with Matching
DELETE`/award/api/v1/award-sync-logs/`

Example URI

DELETE /award/api/v1/award-sync-logs/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardSyncLogId: string (optional)
Award Sync Log Id. Maximum length is 40.
awardSyncStatusId: string (optional)
Award Sync Status Id. Maximum length is 40.
awardSyncChangeId: string (optional)
Award Sync Change Id. Maximum length is 40.
success: string (optional)
Success. Maximum length is 1.
logTypeCode: string (optional)
Log Type. Maximum length is 2.
status: string (optional)
Result Message. Maximum length is 4000.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Sync Statuses ¶

Get Award Sync Statuses by Key
GET`/award/api/v1/award-sync-statuses/(key)`

Example URI

GET /award/api/v1/award-sync-statuses/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardSyncStatusId": "(val)",
  "awardId": "(val)",
  "awardNumber": "(val)",
  "parentAwardId": "(val)",
  "success": "(val)",
  "status": "(val)",
  "syncComplete": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Sync Statuses
GET`/award/api/v1/award-sync-statuses/`

Example URI

GET /award/api/v1/award-sync-statuses/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardSyncStatusId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "parentAwardId": "(val)",
    "success": "(val)",
    "status": "(val)",
    "syncComplete": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSyncStatusId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "parentAwardId": "(val)",
    "success": "(val)",
    "status": "(val)",
    "syncComplete": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Sync Statuses with Filtering
GET`/award/api/v1/award-sync-statuses/`

Example URI

GET /award/api/v1/award-sync-statuses/

URI Parameters

HideShow

awardSyncStatusId: string (optional)
Award Sync Status Id. Maximum length is 40.
awardId: string (optional)
Award Id. Maximum length is 12.
awardNumber: string (optional)
Award ID. Maximum length is 12.
parentAwardId: string (optional)
Award Id. Maximum length is 12.
success: string (optional)
Success. Maximum length is 1.
status: string (optional)
Result Message. Maximum length is 4000.
syncComplete: string (optional)
Sync Complete. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardSyncStatusId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "parentAwardId": "(val)",
    "success": "(val)",
    "status": "(val)",
    "syncComplete": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSyncStatusId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "parentAwardId": "(val)",
    "success": "(val)",
    "status": "(val)",
    "syncComplete": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Sync Statuses
GET`/award/api/v1/award-sync-statuses/`

Example URI

GET /award/api/v1/award-sync-statuses/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardSyncStatusId",
    "awardId",
    "awardNumber",
    "parentAwardId",
    "success",
    "status",
    "syncComplete"
  ],
  "primaryKey": "awardSyncStatusId"
}

Get Blueprint API specification for Award Sync Statuses
GET`/award/api/v1/award-sync-statuses/`

Example URI

GET /award/api/v1/award-sync-statuses/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Sync Statuses.md"
transfer-encoding: chunked

Update Award Sync Statuses
PUT`/award/api/v1/award-sync-statuses/(key)`

Example URI

PUT /award/api/v1/award-sync-statuses/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardSyncStatusId": "(val)",
  "awardId": "(val)",
  "awardNumber": "(val)",
  "parentAwardId": "(val)",
  "success": "(val)",
  "status": "(val)",
  "syncComplete": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Sync Statuses
PUT`/award/api/v1/award-sync-statuses/`

Example URI

PUT /award/api/v1/award-sync-statuses/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardSyncStatusId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "parentAwardId": "(val)",
    "success": "(val)",
    "status": "(val)",
    "syncComplete": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSyncStatusId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "parentAwardId": "(val)",
    "success": "(val)",
    "status": "(val)",
    "syncComplete": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Sync Statuses
PATCH`/award/api/v1/award-sync-statuses/(key)`

Example URI

PATCH /award/api/v1/award-sync-statuses/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardSyncStatusId": "(val)",
  "awardId": "(val)",
  "awardNumber": "(val)",
  "parentAwardId": "(val)",
  "success": "(val)",
  "status": "(val)",
  "syncComplete": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardSyncStatusId": "(val)",
  "awardId": "(val)",
  "awardNumber": "(val)",
  "parentAwardId": "(val)",
  "success": "(val)",
  "status": "(val)",
  "syncComplete": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Sync Statuses
POST`/award/api/v1/award-sync-statuses/`

Example URI

POST /award/api/v1/award-sync-statuses/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardSyncStatusId": "(val)",
  "awardId": "(val)",
  "awardNumber": "(val)",
  "parentAwardId": "(val)",
  "success": "(val)",
  "status": "(val)",
  "syncComplete": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardSyncStatusId": "(val)",
  "awardId": "(val)",
  "awardNumber": "(val)",
  "parentAwardId": "(val)",
  "success": "(val)",
  "status": "(val)",
  "syncComplete": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Sync Statuses
POST`/award/api/v1/award-sync-statuses/`

Example URI

POST /award/api/v1/award-sync-statuses/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardSyncStatusId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "parentAwardId": "(val)",
    "success": "(val)",
    "status": "(val)",
    "syncComplete": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSyncStatusId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "parentAwardId": "(val)",
    "success": "(val)",
    "status": "(val)",
    "syncComplete": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardSyncStatusId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "parentAwardId": "(val)",
    "success": "(val)",
    "status": "(val)",
    "syncComplete": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardSyncStatusId": "(val)",
    "awardId": "(val)",
    "awardNumber": "(val)",
    "parentAwardId": "(val)",
    "success": "(val)",
    "status": "(val)",
    "syncComplete": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Sync Statuses by Key
DELETE`/award/api/v1/award-sync-statuses/(key)`

Example URI

DELETE /award/api/v1/award-sync-statuses/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Sync Statuses
DELETE`/award/api/v1/award-sync-statuses/`

Example URI

DELETE /award/api/v1/award-sync-statuses/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Sync Statuses with Matching
DELETE`/award/api/v1/award-sync-statuses/`

Example URI

DELETE /award/api/v1/award-sync-statuses/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardSyncStatusId: string (optional)
Award Sync Status Id. Maximum length is 40.
awardId: string (optional)
Award Id. Maximum length is 12.
awardNumber: string (optional)
Award ID. Maximum length is 12.
parentAwardId: string (optional)
Award Id. Maximum length is 12.
success: string (optional)
Success. Maximum length is 1.
status: string (optional)
Result Message. Maximum length is 4000.
syncComplete: string (optional)
Sync Complete. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Template Comments ¶

Get Award Template Comments by Key
GET`/award/api/v1/award-template-comments/(key)`

Example URI

GET /award/api/v1/award-template-comments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "templateCommentsId": "(val)",
  "commentTypeCode": "(val)",
  "checklistPrintFlag": "(val)",
  "comments": "(val)",
  "template.templateCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Template Comments
GET`/award/api/v1/award-template-comments/`

Example URI

GET /award/api/v1/award-template-comments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "templateCommentsId": "(val)",
    "commentTypeCode": "(val)",
    "checklistPrintFlag": "(val)",
    "comments": "(val)",
    "template.templateCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateCommentsId": "(val)",
    "commentTypeCode": "(val)",
    "checklistPrintFlag": "(val)",
    "comments": "(val)",
    "template.templateCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Template Comments with Filtering
GET`/award/api/v1/award-template-comments/`

Example URI

GET /award/api/v1/award-template-comments/

URI Parameters

HideShow

templateCommentsId: string (optional)
Template Comments Id. Maximum length is 22.
commentTypeCode: string (optional)
Comment Type. Maximum length is 3.
checklistPrintFlag: string (optional)
Checklist Print Flag. Maximum length is 1.
comments: string (optional)
Comments. Maximum length is 2000.
template.templateCode: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "templateCommentsId": "(val)",
    "commentTypeCode": "(val)",
    "checklistPrintFlag": "(val)",
    "comments": "(val)",
    "template.templateCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateCommentsId": "(val)",
    "commentTypeCode": "(val)",
    "checklistPrintFlag": "(val)",
    "comments": "(val)",
    "template.templateCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Template Comments
GET`/award/api/v1/award-template-comments/`

Example URI

GET /award/api/v1/award-template-comments/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "templateCommentsId",
    "commentTypeCode",
    "checklistPrintFlag",
    "comments",
    "template.templateCode"
  ],
  "primaryKey": "templateCommentsId"
}

Get Blueprint API specification for Award Template Comments
GET`/award/api/v1/award-template-comments/`

Example URI

GET /award/api/v1/award-template-comments/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Template Comments.md"
transfer-encoding: chunked

Update Award Template Comments
PUT`/award/api/v1/award-template-comments/(key)`

Example URI

PUT /award/api/v1/award-template-comments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "templateCommentsId": "(val)",
  "commentTypeCode": "(val)",
  "checklistPrintFlag": "(val)",
  "comments": "(val)",
  "template.templateCode": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Template Comments
PUT`/award/api/v1/award-template-comments/`

Example URI

PUT /award/api/v1/award-template-comments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "templateCommentsId": "(val)",
    "commentTypeCode": "(val)",
    "checklistPrintFlag": "(val)",
    "comments": "(val)",
    "template.templateCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateCommentsId": "(val)",
    "commentTypeCode": "(val)",
    "checklistPrintFlag": "(val)",
    "comments": "(val)",
    "template.templateCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Template Comments
PATCH`/award/api/v1/award-template-comments/(key)`

Example URI

PATCH /award/api/v1/award-template-comments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "templateCommentsId": "(val)",
  "commentTypeCode": "(val)",
  "checklistPrintFlag": "(val)",
  "comments": "(val)",
  "template.templateCode": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "templateCommentsId": "(val)",
  "commentTypeCode": "(val)",
  "checklistPrintFlag": "(val)",
  "comments": "(val)",
  "template.templateCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Template Comments
POST`/award/api/v1/award-template-comments/`

Example URI

POST /award/api/v1/award-template-comments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "templateCommentsId": "(val)",
  "commentTypeCode": "(val)",
  "checklistPrintFlag": "(val)",
  "comments": "(val)",
  "template.templateCode": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "templateCommentsId": "(val)",
  "commentTypeCode": "(val)",
  "checklistPrintFlag": "(val)",
  "comments": "(val)",
  "template.templateCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Template Comments
POST`/award/api/v1/award-template-comments/`

Example URI

POST /award/api/v1/award-template-comments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "templateCommentsId": "(val)",
    "commentTypeCode": "(val)",
    "checklistPrintFlag": "(val)",
    "comments": "(val)",
    "template.templateCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateCommentsId": "(val)",
    "commentTypeCode": "(val)",
    "checklistPrintFlag": "(val)",
    "comments": "(val)",
    "template.templateCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "templateCommentsId": "(val)",
    "commentTypeCode": "(val)",
    "checklistPrintFlag": "(val)",
    "comments": "(val)",
    "template.templateCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateCommentsId": "(val)",
    "commentTypeCode": "(val)",
    "checklistPrintFlag": "(val)",
    "comments": "(val)",
    "template.templateCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Template Comments by Key
DELETE`/award/api/v1/award-template-comments/(key)`

Example URI

DELETE /award/api/v1/award-template-comments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Template Comments
DELETE`/award/api/v1/award-template-comments/`

Example URI

DELETE /award/api/v1/award-template-comments/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Template Comments with Matching
DELETE`/award/api/v1/award-template-comments/`

Example URI

DELETE /award/api/v1/award-template-comments/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
templateCommentsId: string (optional)
Template Comments Id. Maximum length is 22.
commentTypeCode: string (optional)
Comment Type. Maximum length is 3.
checklistPrintFlag: string (optional)
Checklist Print Flag. Maximum length is 1.
comments: string (optional)
Comments. Maximum length is 2000.
template.templateCode: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Template Contacts ¶

Get Award Template Contacts by Key
GET`/award/api/v1/award-template-contacts/(key)`

Example URI

GET /award/api/v1/award-template-contacts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "templateContactId": "(val)",
  "roleCode": "(val)",
  "rolodexId": "(val)",
  "awardTemplate.templateCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Template Contacts
GET`/award/api/v1/award-template-contacts/`

Example URI

GET /award/api/v1/award-template-contacts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "templateContactId": "(val)",
    "roleCode": "(val)",
    "rolodexId": "(val)",
    "awardTemplate.templateCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateContactId": "(val)",
    "roleCode": "(val)",
    "rolodexId": "(val)",
    "awardTemplate.templateCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Template Contacts with Filtering
GET`/award/api/v1/award-template-contacts/`

Example URI

GET /award/api/v1/award-template-contacts/

URI Parameters

HideShow

templateContactId: string (optional)
Template Contact Id. Maximum length is 22.
roleCode: string (optional)
Contact Type. Maximum length is 22.
rolodexId: string (optional)
Rolodex Id. Maximum length is 22.
awardTemplate.templateCode: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "templateContactId": "(val)",
    "roleCode": "(val)",
    "rolodexId": "(val)",
    "awardTemplate.templateCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateContactId": "(val)",
    "roleCode": "(val)",
    "rolodexId": "(val)",
    "awardTemplate.templateCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Template Contacts
GET`/award/api/v1/award-template-contacts/`

Example URI

GET /award/api/v1/award-template-contacts/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "templateContactId",
    "roleCode",
    "rolodexId",
    "awardTemplate.templateCode"
  ],
  "primaryKey": "templateContactId"
}

Get Blueprint API specification for Award Template Contacts
GET`/award/api/v1/award-template-contacts/`

Example URI

GET /award/api/v1/award-template-contacts/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Template Contacts.md"
transfer-encoding: chunked

Award Template Report Term Recipients ¶

Get Award Template Report Term Recipients by Key
GET`/award/api/v1/award-template-report-term-recipients/(key)`

Example URI

GET /award/api/v1/award-template-report-term-recipients/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "templateReportTermRecipientId": "(val)",
  "contactTypeCode": "(val)",
  "rolodexId": "(val)",
  "numberOfCopies": "(val)",
  "awardTemplateReportTerm.templateReportTermId": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Template Report Term Recipients
GET`/award/api/v1/award-template-report-term-recipients/`

Example URI

GET /award/api/v1/award-template-report-term-recipients/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "templateReportTermRecipientId": "(val)",
    "contactTypeCode": "(val)",
    "rolodexId": "(val)",
    "numberOfCopies": "(val)",
    "awardTemplateReportTerm.templateReportTermId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateReportTermRecipientId": "(val)",
    "contactTypeCode": "(val)",
    "rolodexId": "(val)",
    "numberOfCopies": "(val)",
    "awardTemplateReportTerm.templateReportTermId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Template Report Term Recipients with Filtering
GET`/award/api/v1/award-template-report-term-recipients/`

Example URI

GET /award/api/v1/award-template-report-term-recipients/

URI Parameters

HideShow

templateReportTermRecipientId: string (optional)
Templ Rep Terms Recnt Id. Maximum length is 22.
contactTypeCode: string (optional)
Contact Type Code. Maximum length is 3.
rolodexId: string (optional)
Rolodex Id. Maximum length is 22.
numberOfCopies: string (optional)
Number Of Copies. Maximum length is 22.
awardTemplateReportTerm.templateReportTermId: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "templateReportTermRecipientId": "(val)",
    "contactTypeCode": "(val)",
    "rolodexId": "(val)",
    "numberOfCopies": "(val)",
    "awardTemplateReportTerm.templateReportTermId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateReportTermRecipientId": "(val)",
    "contactTypeCode": "(val)",
    "rolodexId": "(val)",
    "numberOfCopies": "(val)",
    "awardTemplateReportTerm.templateReportTermId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Template Report Term Recipients
GET`/award/api/v1/award-template-report-term-recipients/`

Example URI

GET /award/api/v1/award-template-report-term-recipients/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "templateReportTermRecipientId",
    "contactTypeCode",
    "rolodexId",
    "numberOfCopies",
    "awardTemplateReportTerm.templateReportTermId"
  ],
  "primaryKey": "templateReportTermRecipientId"
}

Get Blueprint API specification for Award Template Report Term Recipients
GET`/award/api/v1/award-template-report-term-recipients/`

Example URI

GET /award/api/v1/award-template-report-term-recipients/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Template Report Term Recipients.md"
transfer-encoding: chunked

Award Template Report Terms ¶

Get Award Template Report Terms by Key
GET`/award/api/v1/award-template-report-terms/(key)`

Example URI

GET /award/api/v1/award-template-report-terms/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "templateReportTermId": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "frequencyCode": "(val)",
  "frequencyBaseCode": "(val)",
  "ospDistributionCode": "(val)",
  "dueDate": "(val)",
  "awardTemplate.templateCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Template Report Terms
GET`/award/api/v1/award-template-report-terms/`

Example URI

GET /award/api/v1/award-template-report-terms/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "templateReportTermId": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "dueDate": "(val)",
    "awardTemplate.templateCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateReportTermId": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "dueDate": "(val)",
    "awardTemplate.templateCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Template Report Terms with Filtering
GET`/award/api/v1/award-template-report-terms/`

Example URI

GET /award/api/v1/award-template-report-terms/

URI Parameters

HideShow

templateReportTermId: string (optional)
Template Report Terms Id. Maximum length is 22.
reportClassCode: string (optional)
Report Class Code. Maximum length is 3.
reportCode: string (optional)
Report Type Code. Maximum length is 3.
frequencyCode: string (optional)
Frequency Code. Maximum length is 3.
frequencyBaseCode: string (optional)
Frequency Base Code. Maximum length is 3.
ospDistributionCode: string (optional)
OSP File Copy Code. Maximum length is 3.
dueDate: string (optional)
Due Date. Maximum length is 10.
awardTemplate.templateCode: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "templateReportTermId": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "dueDate": "(val)",
    "awardTemplate.templateCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateReportTermId": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "dueDate": "(val)",
    "awardTemplate.templateCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Template Report Terms
GET`/award/api/v1/award-template-report-terms/`

Example URI

GET /award/api/v1/award-template-report-terms/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "templateReportTermId",
    "reportClassCode",
    "reportCode",
    "frequencyCode",
    "frequencyBaseCode",
    "ospDistributionCode",
    "dueDate",
    "awardTemplate.templateCode"
  ],
  "primaryKey": "templateReportTermId"
}

Get Blueprint API specification for Award Template Report Terms
GET`/award/api/v1/award-template-report-terms/`

Example URI

GET /award/api/v1/award-template-report-terms/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Template Report Terms.md"
transfer-encoding: chunked

Award Template Terms ¶

Get Award Template Terms by Key
GET`/award/api/v1/award-template-terms/(key)`

Example URI

GET /award/api/v1/award-template-terms/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardTemplateTermId": "(val)",
  "sponsorTermId": "(val)",
  "awardTemplate.templateCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Template Terms
GET`/award/api/v1/award-template-terms/`

Example URI

GET /award/api/v1/award-template-terms/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardTemplateTermId": "(val)",
    "sponsorTermId": "(val)",
    "awardTemplate.templateCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardTemplateTermId": "(val)",
    "sponsorTermId": "(val)",
    "awardTemplate.templateCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Template Terms with Filtering
GET`/award/api/v1/award-template-terms/`

Example URI

GET /award/api/v1/award-template-terms/

URI Parameters

HideShow

awardTemplateTermId: string (optional)
Award Template Terms Id. Maximum length is 22.
sponsorTermId: string (optional)
Sponsor Term.
awardTemplate.templateCode: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardTemplateTermId": "(val)",
    "sponsorTermId": "(val)",
    "awardTemplate.templateCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardTemplateTermId": "(val)",
    "sponsorTermId": "(val)",
    "awardTemplate.templateCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Template Terms
GET`/award/api/v1/award-template-terms/`

Example URI

GET /award/api/v1/award-template-terms/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardTemplateTermId",
    "sponsorTermId",
    "awardTemplate.templateCode"
  ],
  "primaryKey": "awardTemplateTermId"
}

Get Blueprint API specification for Award Template Terms
GET`/award/api/v1/award-template-terms/`

Example URI

GET /award/api/v1/award-template-terms/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Template Terms.md"
transfer-encoding: chunked

Award Templates ¶

Get Award Templates by Key
GET`/award/api/v1/award-templates/(key)`

Example URI

GET /award/api/v1/award-templates/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "templateCode": "(val)",
  "statusCode": "(val)",
  "primeSponsorCode": "(val)",
  "description": "(val)",
  "basisOfPaymentCode": "(val)",
  "methodOfPaymentCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Templates
GET`/award/api/v1/award-templates/`

Example URI

GET /award/api/v1/award-templates/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "templateCode": "(val)",
    "statusCode": "(val)",
    "primeSponsorCode": "(val)",
    "description": "(val)",
    "basisOfPaymentCode": "(val)",
    "methodOfPaymentCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateCode": "(val)",
    "statusCode": "(val)",
    "primeSponsorCode": "(val)",
    "description": "(val)",
    "basisOfPaymentCode": "(val)",
    "methodOfPaymentCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Templates with Filtering
GET`/award/api/v1/award-templates/`

Example URI

GET /award/api/v1/award-templates/

URI Parameters

HideShow

templateCode: string (optional)
Sponsor Template Code. Maximum length is 5.
statusCode: string (optional)
Status Code. Maximum length is 22.
primeSponsorCode: string (optional)
Prime Sponsor Code. Maximum length is 20.
description: string (optional)
Description. Maximum length is 200.
basisOfPaymentCode: string (optional)
Payment Basis. Maximum length is 22.
methodOfPaymentCode: string (optional)
Payment Method. Maximum length is 22.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "templateCode": "(val)",
    "statusCode": "(val)",
    "primeSponsorCode": "(val)",
    "description": "(val)",
    "basisOfPaymentCode": "(val)",
    "methodOfPaymentCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateCode": "(val)",
    "statusCode": "(val)",
    "primeSponsorCode": "(val)",
    "description": "(val)",
    "basisOfPaymentCode": "(val)",
    "methodOfPaymentCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Templates
GET`/award/api/v1/award-templates/`

Example URI

GET /award/api/v1/award-templates/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "templateCode",
    "statusCode",
    "primeSponsorCode",
    "description",
    "basisOfPaymentCode",
    "methodOfPaymentCode"
  ],
  "primaryKey": "templateCode"
}

Get Blueprint API specification for Award Templates
GET`/award/api/v1/award-templates/`

Example URI

GET /award/api/v1/award-templates/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Templates.md"
transfer-encoding: chunked

Update Award Templates
PUT`/award/api/v1/award-templates/(key)`

Example URI

PUT /award/api/v1/award-templates/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "templateCode": "(val)",
  "statusCode": "(val)",
  "primeSponsorCode": "(val)",
  "description": "(val)",
  "basisOfPaymentCode": "(val)",
  "methodOfPaymentCode": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Templates
PUT`/award/api/v1/award-templates/`

Example URI

PUT /award/api/v1/award-templates/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "templateCode": "(val)",
    "statusCode": "(val)",
    "primeSponsorCode": "(val)",
    "description": "(val)",
    "basisOfPaymentCode": "(val)",
    "methodOfPaymentCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateCode": "(val)",
    "statusCode": "(val)",
    "primeSponsorCode": "(val)",
    "description": "(val)",
    "basisOfPaymentCode": "(val)",
    "methodOfPaymentCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Templates
PATCH`/award/api/v1/award-templates/(key)`

Example URI

PATCH /award/api/v1/award-templates/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "templateCode": "(val)",
  "statusCode": "(val)",
  "primeSponsorCode": "(val)",
  "description": "(val)",
  "basisOfPaymentCode": "(val)",
  "methodOfPaymentCode": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "templateCode": "(val)",
  "statusCode": "(val)",
  "primeSponsorCode": "(val)",
  "description": "(val)",
  "basisOfPaymentCode": "(val)",
  "methodOfPaymentCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Templates
POST`/award/api/v1/award-templates/`

Example URI

POST /award/api/v1/award-templates/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "templateCode": "(val)",
  "statusCode": "(val)",
  "primeSponsorCode": "(val)",
  "description": "(val)",
  "basisOfPaymentCode": "(val)",
  "methodOfPaymentCode": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "templateCode": "(val)",
  "statusCode": "(val)",
  "primeSponsorCode": "(val)",
  "description": "(val)",
  "basisOfPaymentCode": "(val)",
  "methodOfPaymentCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Templates
POST`/award/api/v1/award-templates/`

Example URI

POST /award/api/v1/award-templates/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "templateCode": "(val)",
    "statusCode": "(val)",
    "primeSponsorCode": "(val)",
    "description": "(val)",
    "basisOfPaymentCode": "(val)",
    "methodOfPaymentCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateCode": "(val)",
    "statusCode": "(val)",
    "primeSponsorCode": "(val)",
    "description": "(val)",
    "basisOfPaymentCode": "(val)",
    "methodOfPaymentCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "templateCode": "(val)",
    "statusCode": "(val)",
    "primeSponsorCode": "(val)",
    "description": "(val)",
    "basisOfPaymentCode": "(val)",
    "methodOfPaymentCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateCode": "(val)",
    "statusCode": "(val)",
    "primeSponsorCode": "(val)",
    "description": "(val)",
    "basisOfPaymentCode": "(val)",
    "methodOfPaymentCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Templates by Key
DELETE`/award/api/v1/award-templates/(key)`

Example URI

DELETE /award/api/v1/award-templates/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Templates
DELETE`/award/api/v1/award-templates/`

Example URI

DELETE /award/api/v1/award-templates/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Templates with Matching
DELETE`/award/api/v1/award-templates/`

Example URI

DELETE /award/api/v1/award-templates/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
templateCode: string (optional)
Sponsor Template Code. Maximum length is 5.
statusCode: string (optional)
Status Code. Maximum length is 22.
primeSponsorCode: string (optional)
Prime Sponsor Code. Maximum length is 20.
description: string (optional)
Description. Maximum length is 200.
basisOfPaymentCode: string (optional)
Payment Basis. Maximum length is 22.
methodOfPaymentCode: string (optional)
Payment Method. Maximum length is 22.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Transaction Types ¶

Get Award Transaction Types by Key
GET`/award/api/v1/award-transaction-types/(key)`

Example URI

GET /award/api/v1/award-transaction-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardTransactionTypeCode": "(val)",
  "description": "(val)",
  "showInActionSummary": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Transaction Types
GET`/award/api/v1/award-transaction-types/`

Example URI

GET /award/api/v1/award-transaction-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardTransactionTypeCode": "(val)",
    "description": "(val)",
    "showInActionSummary": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardTransactionTypeCode": "(val)",
    "description": "(val)",
    "showInActionSummary": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Transaction Types with Filtering
GET`/award/api/v1/award-transaction-types/`

Example URI

GET /award/api/v1/award-transaction-types/

URI Parameters

HideShow

awardTransactionTypeCode: string (optional)
Award Transaction Type Code. Maximum length is 22.
description: string (optional)
Description. Maximum length is 200.
showInActionSummary: string (optional)
Show In Action Summary. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardTransactionTypeCode": "(val)",
    "description": "(val)",
    "showInActionSummary": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardTransactionTypeCode": "(val)",
    "description": "(val)",
    "showInActionSummary": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Transaction Types
GET`/award/api/v1/award-transaction-types/`

Example URI

GET /award/api/v1/award-transaction-types/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardTransactionTypeCode",
    "description",
    "showInActionSummary"
  ],
  "primaryKey": "awardTransactionTypeCode"
}

Get Blueprint API specification for Award Transaction Types
GET`/award/api/v1/award-transaction-types/`

Example URI

GET /award/api/v1/award-transaction-types/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Transaction Types.md"
transfer-encoding: chunked

Update Award Transaction Types
PUT`/award/api/v1/award-transaction-types/(key)`

Example URI

PUT /award/api/v1/award-transaction-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardTransactionTypeCode": "(val)",
  "description": "(val)",
  "showInActionSummary": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Transaction Types
PUT`/award/api/v1/award-transaction-types/`

Example URI

PUT /award/api/v1/award-transaction-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardTransactionTypeCode": "(val)",
    "description": "(val)",
    "showInActionSummary": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardTransactionTypeCode": "(val)",
    "description": "(val)",
    "showInActionSummary": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Transaction Types
PATCH`/award/api/v1/award-transaction-types/(key)`

Example URI

PATCH /award/api/v1/award-transaction-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardTransactionTypeCode": "(val)",
  "description": "(val)",
  "showInActionSummary": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardTransactionTypeCode": "(val)",
  "description": "(val)",
  "showInActionSummary": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Transaction Types
POST`/award/api/v1/award-transaction-types/`

Example URI

POST /award/api/v1/award-transaction-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardTransactionTypeCode": "(val)",
  "description": "(val)",
  "showInActionSummary": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardTransactionTypeCode": "(val)",
  "description": "(val)",
  "showInActionSummary": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Transaction Types
POST`/award/api/v1/award-transaction-types/`

Example URI

POST /award/api/v1/award-transaction-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardTransactionTypeCode": "(val)",
    "description": "(val)",
    "showInActionSummary": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardTransactionTypeCode": "(val)",
    "description": "(val)",
    "showInActionSummary": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardTransactionTypeCode": "(val)",
    "description": "(val)",
    "showInActionSummary": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardTransactionTypeCode": "(val)",
    "description": "(val)",
    "showInActionSummary": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Transaction Types by Key
DELETE`/award/api/v1/award-transaction-types/(key)`

Example URI

DELETE /award/api/v1/award-transaction-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Transaction Types
DELETE`/award/api/v1/award-transaction-types/`

Example URI

DELETE /award/api/v1/award-transaction-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Transaction Types with Matching
DELETE`/award/api/v1/award-transaction-types/`

Example URI

DELETE /award/api/v1/award-transaction-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardTransactionTypeCode: string (optional)
Award Transaction Type Code. Maximum length is 22.
description: string (optional)
Description. Maximum length is 200.
showInActionSummary: string (optional)
Show In Action Summary. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Transferring Sponsors ¶

Get Award Transferring Sponsors by Key
GET`/award/api/v1/award-transferring-sponsors/(key)`

Example URI

GET /award/api/v1/award-transferring-sponsors/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardTransferringSponsorId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "sponsorCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Transferring Sponsors
GET`/award/api/v1/award-transferring-sponsors/`

Example URI

GET /award/api/v1/award-transferring-sponsors/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardTransferringSponsorId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "sponsorCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardTransferringSponsorId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "sponsorCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Transferring Sponsors with Filtering
GET`/award/api/v1/award-transferring-sponsors/`

Example URI

GET /award/api/v1/award-transferring-sponsors/

URI Parameters

HideShow

awardTransferringSponsorId: string (optional)
Award Transferring Sponsor Id. Maximum length is 22.
awardNumber: string (optional)
sequenceNumber: string (optional)
sponsorCode: string (optional)
Sponsor Code. Maximum length is 20.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardTransferringSponsorId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "sponsorCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardTransferringSponsorId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "sponsorCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Transferring Sponsors
GET`/award/api/v1/award-transferring-sponsors/`

Example URI

GET /award/api/v1/award-transferring-sponsors/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardTransferringSponsorId",
    "awardNumber",
    "sequenceNumber",
    "sponsorCode"
  ],
  "primaryKey": "awardTransferringSponsorId"
}

Get Blueprint API specification for Award Transferring Sponsors
GET`/award/api/v1/award-transferring-sponsors/`

Example URI

GET /award/api/v1/award-transferring-sponsors/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Transferring Sponsors.md"
transfer-encoding: chunked

Award Types ¶

Get Award Types by Key
GET`/award/api/v1/award-types/(key)`

Example URI

GET /award/api/v1/award-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Types
GET`/award/api/v1/award-types/`

Example URI

GET /award/api/v1/award-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Types with Filtering
GET`/award/api/v1/award-types/`

Example URI

GET /award/api/v1/award-types/

URI Parameters

HideShow

code: string (optional)
Award Type Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Types
GET`/award/api/v1/award-types/`

Example URI

GET /award/api/v1/award-types/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "code",
    "description"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Award Types
GET`/award/api/v1/award-types/`

Example URI

GET /award/api/v1/award-types/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Types.md"
transfer-encoding: chunked

Update Award Types
PUT`/award/api/v1/award-types/(key)`

Example URI

PUT /award/api/v1/award-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Award Types
PUT`/award/api/v1/award-types/`

Example URI

PUT /award/api/v1/award-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Award Types
PATCH`/award/api/v1/award-types/(key)`

Example URI

PATCH /award/api/v1/award-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Award Types
POST`/award/api/v1/award-types/`

Example URI

POST /award/api/v1/award-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Award Types
POST`/award/api/v1/award-types/`

Example URI

POST /award/api/v1/award-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Award Types by Key
DELETE`/award/api/v1/award-types/(key)`

Example URI

DELETE /award/api/v1/award-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Types
DELETE`/award/api/v1/award-types/`

Example URI

DELETE /award/api/v1/award-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Award Types with Matching
DELETE`/award/api/v1/award-types/`

Example URI

DELETE /award/api/v1/award-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
code: string (optional)
Award Type Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Award Unit Contacts ¶

Get Award Unit Contacts by Key
GET`/award/api/v1/award-unit-contacts/(key)`

Example URI

GET /award/api/v1/award-unit-contacts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardContactId": "(val)",
  "personId": "(val)",
  "fullName": "(val)",
  "unitContactType": "(val)",
  "unitAdministratorTypeCode": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "unitAdministratorUnitNumber": "(val)",
  "defaultUnitContact": "(val)",
  "award.awardId": "(val)",
  "_primaryKey": "(val)"
}

Get All Award Unit Contacts
GET`/award/api/v1/award-unit-contacts/`

Example URI

GET /award/api/v1/award-unit-contacts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardContactId": "(val)",
    "personId": "(val)",
    "fullName": "(val)",
    "unitContactType": "(val)",
    "unitAdministratorTypeCode": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "unitAdministratorUnitNumber": "(val)",
    "defaultUnitContact": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardContactId": "(val)",
    "personId": "(val)",
    "fullName": "(val)",
    "unitContactType": "(val)",
    "unitAdministratorTypeCode": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "unitAdministratorUnitNumber": "(val)",
    "defaultUnitContact": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Award Unit Contacts with Filtering
GET`/award/api/v1/award-unit-contacts/`

Example URI

GET /award/api/v1/award-unit-contacts/

URI Parameters

HideShow

awardContactId: string (optional)
personId: string (optional)
fullName: string (optional)
Full Name. Maximum length is 90.
unitContactType: string (optional)
unitAdministratorTypeCode: string (optional)
Project Role. Maximum length is 3.
awardNumber: string (optional)
sequenceNumber: string (optional)
unitAdministratorUnitNumber: string (optional)
defaultUnitContact: string (optional)
award.awardId: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardContactId": "(val)",
    "personId": "(val)",
    "fullName": "(val)",
    "unitContactType": "(val)",
    "unitAdministratorTypeCode": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "unitAdministratorUnitNumber": "(val)",
    "defaultUnitContact": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardContactId": "(val)",
    "personId": "(val)",
    "fullName": "(val)",
    "unitContactType": "(val)",
    "unitAdministratorTypeCode": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "unitAdministratorUnitNumber": "(val)",
    "defaultUnitContact": "(val)",
    "award.awardId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Award Unit Contacts
GET`/award/api/v1/award-unit-contacts/`

Example URI

GET /award/api/v1/award-unit-contacts/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardContactId",
    "personId",
    "fullName",
    "unitContactType",
    "unitAdministratorTypeCode",
    "awardNumber",
    "sequenceNumber",
    "unitAdministratorUnitNumber",
    "defaultUnitContact",
    "award.awardId"
  ],
  "primaryKey": "awardContactId"
}

Get Blueprint API specification for Award Unit Contacts
GET`/award/api/v1/award-unit-contacts/`

Example URI

GET /award/api/v1/award-unit-contacts/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Award Unit Contacts.md"
transfer-encoding: chunked

Award Accounts ¶

List All Accounts
GET`/award/api/v1/accounts/`

Get all accounts that are available for use

Example URI

GET /award/api/v1/accounts/

URI Parameters

HideShow

startIndex: number (optional) Example: 0
Starting index of the results to be returned. If not included, all available accounts are returned.
size: number (optional) Example: 5
Size of the results to be returned. If not included, all available accounts are returned.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;

Body

{
  "totalFound": 1,
  "count": 1,
  "accounts": [
    {
      "id": 1,
      "accountNumber": "55555",
      "createdByAwardId": 2609,
      "status": "AVAILABLE",
      "budgeted": 0,
      "pending": 0,
      "income": 0,
      "expense": 0,
      "available": 0,
      "comment": "Lorem ipsum dolor sit amet"
    }
  ]
}

Get Account
GET`/award/api/v1/accounts/55555`

Get information on a particular account

Example URI

GET /award/api/v1/accounts/55555

URI Parameters

HideShow

showAwards: boolean (optional) Example: true
Flag to indicate if award ids linked to account should be returned.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "totalFound": 1,
  "count": 1,
  "accounts": [
    {
      "id": 9,
      "accountNumber": "55555",
      "createdByAwardId": 2742,
      "status": "CLOSED",
      "budgeted": 6.69,
      "pending": 7.7,
      "income": 999.99,
      "expense": 8.8,
      "available": 5.5,
      "comment": "Lorem ipsum dolor sit amet"
    }
  ],
  "awards": [
    2742,
    2778
  ]
}

Update Account
PUT`/award/api/v1/accounts/878787`

Set various fields on an account. Fields not provided will not be updated.

Example URI

PUT /award/api/v1/accounts/878787

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "status": "CLOSED",
  "budgeted": 6.69,
  "pending": 7.7,
  "income": 999.99,
  "expense": 8.8,
  "available": 5.5,
  "comment": "Lorem ipsum dolor sit amet"
}

Response 200

HideShow

Headers

Content-Length: 0

Awards ¶

Kuali Research Awards providing Post Award management

Awards Summary
GET`/award/api/v1/awards/?summary`

Summary of Awards

Example URI

GET /award/api/v1/awards/?summary

URI Parameters

HideShow

summary: boolean (required)
Renders the awards in a summary view instead of the full data from the award. Currently the only option and required.
updatedSince: date (optional) Example: 1446630596000
Criteria to restrict the awards returned to those updated since the date specified. Formatted as milliseconds since epoch.
limit: number (optional) Example: 50
Number of results to return. If not included, all awards matching the date, if specified, are returned.
page: number (optional) Example: 8
If a limit is specified this determines what page of the result set will be returned on this request.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
   "count" : 1,
   "awards" : [
       {
         "awardId" : 2238,
         "awardNumber" : "999901-00001",
         "sequenceNumber": 1,
         "accountNumber" : "0211401",
         "title" : "LOC - by award",
         "sponsorAwardNumber" : null,
         "modificationNumber" : null,
         "cfdaNumber" : "00.000",
         "fundingProposals" : [
            {
              "proposalSequenceNumber": 1,
              "awardNumber": "999908-00001",
              "awardSequenceNumber": 1,
              "awardId": 2511,
              "proposalId": 7,
              "proposalNumber": "80068"
            }
         ],
         "activityType" : {
            "code" : "3",
            "description" : "Public Service"
         },
         "sponsor" : {
            "sponsorCode" : "055125",
            "sponsorName" : "Kuali LOC Testing3",
            "acronym" : null
         },
         "leadUnit": {
            "unitNumber": "000001",
            "unitName": "University",
            "parentUnitNumber": null,
            "organizationId": "000001"
          },
         "awardStatus" : {
            "code" : "1",
            "description" : "Active"
         },
         "principalInvestigator" : {
            "emailAddress" : "kcnotification@gmail.com",
            "personId" : "10000000002",
            "roleCode" : "PI",
            "projectRole" : "Principal Investigator",
            "fullName" : "Joe  Tester",
            "userName" : "jtester",
            "person": {
              "state": "MA",
              "emailAddress": "kcnotification+jtester@gmail.com",
              "addressLine2": "",
              "firstName": "Joe",
              "addressLine3": "",
              "lastName": "Tester",
              "personId": "10000000002",
              "middleName": "",
              "userName": "jtester",
              "fullName": "Joe Tester",
              "city": "Coeus",
              "postalCode": "53421",
              "addressLine1": "1119 Kuali Drive"
            },
         }
      },
   ],
   "totalFound" : 112
}

Get Award
GET`/award/api/v2/awards/13163?includeBudgets=true`

GET Award

Example URI

GET /award/api/v2/awards/13163?includeBudgets=true

URI Parameters

HideShow

awardId: number (required) Example: 13163
Gets the award associated with the awardId.
includeBudgets: String (optional)
Includes budget information with the award if true.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "docNbr": null,
  "documentDescription": null,
  "docStatus": null,
  "awardId": 13163,
  "awardNumber": "000224-00001",
  "sequenceNumber": 1,
  "sponsorCode": "000100",
  "sponsor": {
    "sponsorCode": "000340",
    "sponsorName": "NIH",
    "acronym": "NIH",
    "sponsorType": {
      "code": "0",
      "description": "Federal"
    }
  },
  "statusCode": 1,
  "accountNumber": null,
  "awardEffectiveDate": "2015-07-01",
  "awardExecutionDate": null,
  "beginDate": null,
  "obligationStartDate": null,
  "projectEndDate": "2018-06-30",
  "costSharingIndicator": "N",
  "indirectCostIndicator": "N",
  "nsfSequenceNumber": null,
  "paymentScheduleIndicator": "N",
  "scienceCodeIndicator": "N",
  "specialReviewIndicator": "N",
  "sponsorAwardNumber": null,
  "transferSponsorIndicator": "N",
  "accountTypeCode": null,
  "activityTypeCode": "1",
  "primeSponsorCode": "000340",
  "primeSponsor": {
    "sponsorCode": "000340",
    "sponsorName": "NIH",
    "acronym": "NIH",
    "sponsorType": {
      "code": "0",
      "description": "Federal"
    }
  },
  "awardTypeCode": 1,
  "cfdaNumber": null,
  "methodOfPaymentCode": "1",
  "proposalNumber": null,
  "title": "retest ab",
  "basisOfPaymentCode": "2",
  "awardTransactionTypeCode": 9,
  "noticeDate": null,
  "leadUnitNumber": "BL-IIDC",
  "awardSequenceStatus": "PENDING",
  "unitNumber": "BL-IIDC",
  "approvedEquipmentIndicator": "N",
  "approvedForeignTripIndicator": "N",
  "subContractIndicator": "N",
  "modificationNumber": null,
  "documentFundingId": null,
  "preAwardAuthorizedAmount": null,
  "preAwardEffectiveDate": null,
  "preAwardInstitutionalAuthorizedAmount": null,
  "obligationEndDate": null,
  "preAwardInstitutionalEffectiveDate": null,
  "procurementPriorityCode": null,
  "specialEbRateOffCampus": null,
  "specialEbRateOnCampus": null,
  "anticipatedTotalDirect": 0,
  "anticipatedTotalIndirect": 0,
  "obligatedTotalDirect": 0,
  "obligatedTotalIndirect": 0,
  "subPlanFlag": null,
  "archiveLocation": null,
  "closeoutDate": null,
  "currentActionComments": "",
  "awardSequenceStatusResult": "Saved",
  "templateCode": 1,
  "awardBasisOfPayment": null,
  "awardMethodOfPayment": null,
  "fainId": null,
  "fedAwardYear": null,
  "fedAwardDate": null,
  "posted": false,
  "projectPersons": [
    {
      "awardContactId": 13188,
      "personId": "10000000051",
      "roleCode": "PI",
      "keyPersonRole": null,
      "rolodexId": null,
      "fullName": "SOME PI",
      "academicYearEffort": 80,
      "calendarYearEffort": 100,
      "summerEffort": 20,
      "totalEffort": 100,
      "kcPerson.emailAddress": "kcnotification+someone@gmail.com",
      "kcPerson.phoneNumber": "321-321-1197",
      "creditSplits": [
        {
          "awardPersonCreditSplitId": 27026,
          "credit": 75,
          "investigatorCreditType": {
            "code": "0",
            "addsToHundred": true,
            "active": true,
            "description": "Recognition"
          }
        },
        {
          "awardPersonCreditSplitId": 27027,
          "credit": 75,
          "investigatorCreditType": {
            "code": "1",
            "addsToHundred": true,
            "active": true,
            "description": "Responsibility"
          }
        },
        {
          "awardPersonCreditSplitId": 27028,
          "credit": 75,
          "investigatorCreditType": {
            "code": "2",
            "addsToHundred": true,
            "active": true,
            "description": "Space"
          }
        },
        {
          "awardPersonCreditSplitId": 27029,
          "credit": 75,
          "investigatorCreditType": {
            "code": "3",
            "addsToHundred": true,
            "active": true,
            "description": "Financial"
          }
        }
      ],
      "units": [
        {
          "awardPersonUnitId": 27021,
          "leadUnit": true,
          "unit": {
            "unitNumber": "000001",
            "parentUnitNumber": null,
            "organizationId": "000001",
            "unitName": "University"
          },
          "creditSplits": [
            {
              "awardPersonUnitCreditSplitId": 27022,
              "credit": 100,
              "investigatorCreditType": {
                "code": "0",
                "addsToHundred": true,
                "active": true,
                "description": "Recognition"
              }
            },
            {
              "awardPersonUnitCreditSplitId": 27023,
              "credit": 100,
              "investigatorCreditType": {
                "code": "1",
                "addsToHundred": true,
                "active": true,
                "description": "Responsibility"
              }
            },
            {
              "awardPersonUnitCreditSplitId": 27024,
              "credit": 100,
              "investigatorCreditType": {
                "code": "2",
                "addsToHundred": true,
                "active": true,
                "description": "Space"
              }
            },
            {
              "awardPersonUnitCreditSplitId": 27025,
              "credit": 100,
              "investigatorCreditType": {
                "code": "3",
                "addsToHundred": true,
                "active": true,
                "description": "Financial"
              }
            }
          ]
        }
      ]
    }
  ],
  "awardCustomDataList": [
    {
      "customAttributeId": 1,
      "value": "435454"
    },
    {
      "customAttributeId": 2,
      "value": null
    },
    {
      "customAttributeId": 3,
      "value": null
    },
    {
      "customAttributeId": 4,
      "value": "32"
    },
    {
      "customAttributeId": 5,
      "value": null
    },
    {
      "customAttributeId": 6,
      "value": null
    },
    {
      "customAttributeId": 7,
      "value": null
    }
  ],
  "awardSponsorTerms": [
    {
      "sponsorTermId": 325
    },
    {
      "sponsorTermId": 505
    },
    {
      "sponsorTermId": 316
    },
    {
      "sponsorTermId": 353
    },
    {
      "sponsorTermId": 371
    },
    {
      "sponsorTermId": 538
    },
    {
      "sponsorTermId": 318
    },
    {
      "sponsorTermId": 354
    },
    {
      "sponsorTermId": 372
    },
    {
      "sponsorTermId": 417
    },
    {
      "sponsorTermId": 544
    },
    {
      "sponsorTermId": 556
    },
    {
      "sponsorTermId": 567
    },
    {
      "sponsorTermId": 569
    },
    {
      "sponsorTermId": 493
    },
    {
      "sponsorTermId": 500
    },
    {
      "sponsorTermId": 410
    },
    {
      "sponsorTermId": 437
    },
    {
      "sponsorTermId": 383
    },
    {
      "sponsorTermId": 578
    },
    {
      "sponsorTermId": 601
    },
    {
      "sponsorTermId": 322
    },
    {
      "sponsorTermId": 367
    },
    {
      "sponsorTermId": 448
    },
    {
      "sponsorTermId": 480
    },
    {
      "sponsorTermId": 333
    },
    {
      "sponsorTermId": 369
    }
  ],
  "awardReportTerms": [
    {
      "reportClassCode": "7",
      "reportCode": "70",
      "frequencyCode": "23",
      "frequencyBaseCode": "4",
      "ospDistributionCode": "4",
      "dueDate": null
    },
    {
      "reportClassCode": "2",
      "reportCode": "40",
      "frequencyCode": "13",
      "frequencyBaseCode": "4",
      "ospDistributionCode": "2",
      "dueDate": null
    },
    {
      "reportClassCode": "3",
      "reportCode": "36",
      "frequencyCode": "30",
      "frequencyBaseCode": "3",
      "ospDistributionCode": "1",
      "dueDate": null
    },
    {
      "reportClassCode": "1",
      "reportCode": "5",
      "frequencyCode": "12",
      "frequencyBaseCode": "4",
      "ospDistributionCode": "2",
      "dueDate": null
    },
    {
      "reportClassCode": "4",
      "reportCode": "5",
      "frequencyCode": "43",
      "frequencyBaseCode": "4",
      "ospDistributionCode": "1",
      "dueDate": null
    },
    {
      "reportClassCode": "6",
      "reportCode": "5",
      "frequencyCode": "12",
      "frequencyBaseCode": "4",
      "ospDistributionCode": "4",
      "dueDate": null
    },
    {
      "reportClassCode": "4",
      "reportCode": "9",
      "frequencyCode": "4",
      "frequencyBaseCode": "6",
      "ospDistributionCode": "3",
      "dueDate": null
    },
    {
      "reportClassCode": "7",
      "reportCode": "69",
      "frequencyCode": "16",
      "frequencyBaseCode": "4",
      "ospDistributionCode": "4",
      "dueDate": null
    },
    {
      "reportClassCode": "3",
      "reportCode": "7",
      "frequencyCode": "6",
      "frequencyBaseCode": "2",
      "ospDistributionCode": "4",
      "dueDate": null
    },
    {
      "reportClassCode": "5",
      "reportCode": "7",
      "frequencyCode": "3",
      "frequencyBaseCode": "2",
      "ospDistributionCode": "1",
      "dueDate": null
    },
    {
      "reportClassCode": "2",
      "reportCode": "39",
      "frequencyCode": "3",
      "frequencyBaseCode": "2",
      "ospDistributionCode": "1",
      "dueDate": null
    },
    {
      "reportClassCode": "1",
      "reportCode": "33",
      "frequencyCode": "7",
      "frequencyBaseCode": "3",
      "ospDistributionCode": "4",
      "dueDate": null
    },
    {
      "reportClassCode": "6",
      "reportCode": "51",
      "frequencyCode": "2",
      "frequencyBaseCode": "2",
      "ospDistributionCode": "4",
      "dueDate": null
    },
    {
      "reportClassCode": "5",
      "reportCode": "37",
      "frequencyCode": "10",
      "frequencyBaseCode": "4",
      "ospDistributionCode": "4",
      "dueDate": null
    }
  ],
  "awardComments": [
    {
      "awardCommentId": 3587,
      "commentTypeCode": "21",
      "checklistPrintFlag": false,
      "comments": null
    },
    {
      "awardCommentId": 3588,
      "commentTypeCode": "2",
      "checklistPrintFlag": false,
      "comments": "General remarks from sync to Test Sponsor Template."
    },
    {
      "awardCommentId": 3589,
      "commentTypeCode": "3",
      "checklistPrintFlag": false,
      "comments": "Financial Rpt remarks from sync to Test Sponsor Template."
    },
    {
      "awardCommentId": 3590,
      "commentTypeCode": "4",
      "checklistPrintFlag": false,
      "comments": "IP remarks from sync to Test Sponsor Template."
    },
    {
      "awardCommentId": 3591,
      "commentTypeCode": "5",
      "checklistPrintFlag": false,
      "comments": "Procurement remarks from sync to Test Sponsor Template."
    },
    {
      "awardCommentId": 3592,
      "commentTypeCode": "6",
      "checklistPrintFlag": false,
      "comments": "Property/Equipment remarks from sync to Test Sponsor Template."
    },
    {
      "awardCommentId": 3593,
      "commentTypeCode": "1",
      "checklistPrintFlag": false,
      "comments": "Invoicing remarks from sync to Test Sponsor Template."
    },
    {
      "awardCommentId": 3594,
      "commentTypeCode": "9",
      "checklistPrintFlag": false,
      "comments": "Cost sharing remarks from sync to Test Sponsor Template."
    }
  ],
  "awardSponsorContacts": [
    {
      "rolodexId": 1736,
      "roleCode": "1",
      "awardContactId": 4263,
      "orgName": "Office of Naval Research"
    }
  ],
  "awardCostShares": [],
  "awardFandaRate": [],
  "awardDirectFandADistributions": [
    {
      "awardDirectFandADistributionId": 223,
      "amountSequenceNumber": null,
      "awardAmountInfoId": null,
      "budgetPeriod": 1,
      "startDate": "2015-07-01",
      "endDate": "2016-06-30",
      "directCost": 0,
      "indirectCost": 0
    },
    {
      "awardDirectFandADistributionId": 224,
      "amountSequenceNumber": null,
      "awardAmountInfoId": null,
      "budgetPeriod": 2,
      "startDate": "2016-07-01",
      "endDate": "2017-06-30",
      "directCost": 0,
      "indirectCost": 0
    },
    {
      "awardDirectFandADistributionId": 225,
      "amountSequenceNumber": null,
      "awardAmountInfoId": null,
      "budgetPeriod": 3,
      "startDate": "2017-07-01",
      "endDate": "2018-06-30",
      "directCost": 0,
      "indirectCost": 0
    }
  ],
  "awardUnitContacts": [],
  "approvedEquipmentItems": [],
  "approvedForeignTravelTrips": [],
  "paymentScheduleItems": [],
  "awardTransferringSponsors": [],
  "awardAmountInfos": [
    {
      "awardAmountInfoId": 13164,
      "transactionId": null,
      "timeAndMoneyDocumentNumber": null,
      "anticipatedTotalAmount": 684389.73,
      "antDistributableAmount": 684389.73,
      "finalExpirationDate": "2018-06-30",
      "currentFundEffectiveDate": "2015-07-01",
      "amountObligatedToDate": 684389.73,
      "obliDistributableAmount": 684389.73,
      "obligationExpirationDate": "2018-06-30",
      "anticipatedChange": 0,
      "obligatedChange": 0,
      "obligatedChangeDirect": 0,
      "obligatedChangeIndirect": 0,
      "anticipatedChangeDirect": 0,
      "anticipatedChangeIndirect": 0,
      "anticipatedTotalDirect": 684389.73,
      "anticipatedTotalIndirect": 0,
      "obligatedTotalDirect": 684389.73,
      "obligatedTotalIndirect": 0,
      "originatingAwardVersion": 1
    },
    {
      "awardAmountInfoId": 13203,
      "transactionId": null,
      "timeAndMoneyDocumentNumber": "10781",
      "anticipatedTotalAmount": 684389.73,
      "antDistributableAmount": 684389.73,
      "finalExpirationDate": "2018-06-30",
      "currentFundEffectiveDate": "2015-07-01",
      "amountObligatedToDate": 684389.73,
      "obliDistributableAmount": 684389.73,
      "obligationExpirationDate": "2018-06-30",
      "anticipatedChange": 0,
      "obligatedChange": 0,
      "obligatedChangeDirect": 0,
      "obligatedChangeIndirect": 0,
      "anticipatedChangeDirect": 0,
      "anticipatedChangeIndirect": 0,
      "anticipatedTotalDirect": 684389.73,
      "anticipatedTotalIndirect": 0,
      "obligatedTotalDirect": 684389.73,
      "obligatedTotalIndirect": 0,
      "originatingAwardVersion": 1
    },
    {
      "awardAmountInfoId": 13205,
      "transactionId": 85,
      "timeAndMoneyDocumentNumber": "10793",
      "anticipatedTotalAmount": 682389.73,
      "antDistributableAmount": 682389.73,
      "finalExpirationDate": "2018-06-30",
      "currentFundEffectiveDate": "2015-07-01",
      "amountObligatedToDate": 682389.73,
      "obliDistributableAmount": 682389.73,
      "obligationExpirationDate": "2018-06-30",
      "anticipatedChange": 0,
      "obligatedChange": 0,
      "obligatedChangeDirect": 0,
      "obligatedChangeIndirect": 0,
      "anticipatedChangeDirect": 0,
      "anticipatedChangeIndirect": 0,
      "anticipatedTotalDirect": 682389.73,
      "anticipatedTotalIndirect": 0,
      "obligatedTotalDirect": 682389.73,
      "obligatedTotalIndirect": 0,
      "originatingAwardVersion": 1
    },
    {
      "awardAmountInfoId": 13206,
      "transactionId": 86,
      "timeAndMoneyDocumentNumber": "10802",
      "anticipatedTotalAmount": 1364779.46,
      "antDistributableAmount": 1364779.46,
      "finalExpirationDate": "2018-06-30",
      "currentFundEffectiveDate": "2015-07-01",
      "amountObligatedToDate": 1364779.46,
      "obliDistributableAmount": 1364779.46,
      "obligationExpirationDate": "2018-06-30",
      "anticipatedChange": 0,
      "obligatedChange": 0,
      "obligatedChangeDirect": 0,
      "obligatedChangeIndirect": 0,
      "anticipatedChangeDirect": 0,
      "anticipatedChangeIndirect": 0,
      "anticipatedTotalDirect": 1364779.46,
      "anticipatedTotalIndirect": 0,
      "obligatedTotalDirect": 1364779.46,
      "obligatedTotalIndirect": 0,
      "originatingAwardVersion": 1
    }
  ],
  "awardCloseoutItems": [
    {
      "awardCloseoutId": 1673,
      "finalSubmissionDate": null,
      "dueDate": null,
      "closeoutReportCode": "1",
      "closeoutReportName": "Financial",
      "multiple": false
    },
    {
      "awardCloseoutId": 1674,
      "finalSubmissionDate": null,
      "dueDate": null,
      "closeoutReportCode": "4",
      "closeoutReportName": "Technical",
      "multiple": false
    },
    {
      "awardCloseoutId": 1675,
      "finalSubmissionDate": null,
      "dueDate": null,
      "closeoutReportCode": "3",
      "closeoutReportName": "Patent",
      "multiple": false
    },
    {
      "awardCloseoutId": 1676,
      "finalSubmissionDate": null,
      "dueDate": null,
      "closeoutReportCode": "2",
      "closeoutReportName": "Property",
      "multiple": false
    },
    {
      "awardCloseoutId": 1677,
      "finalSubmissionDate": null,
      "dueDate": null,
      "closeoutReportCode": "6",
      "closeoutReportName": "Invoice",
      "multiple": false
    }
  ],
  "awardCloseoutNewItems": [],
  "fundingProposals": [],
  "allFundingProposals": [],
  "awardBudgetLimits": [
    {
      "budgetLimitId": 121,
      "awardId": null,
      "budgetId": null,
      "limitTypeCode": "directCost",
      "limit": null
    },
    {
      "budgetLimitId": 122,
      "awardId": null,
      "budgetId": null,
      "limitTypeCode": "indirectCost",
      "limit": null
    },
    {
      "budgetLimitId": 123,
      "awardId": null,
      "budgetId": null,
      "limitTypeCode": "totalCost",
      "limit": null
    }
  ],
  "budgets": []
}

Get award by award number
GET`/award/api/v2/awards?awardNumber=000224-00001&includeBudgets=false`

GET Award by award number

Example URI

GET /award/api/v2/awards?awardNumber=000224-00001&includeBudgets=false

URI Parameters

HideShow

awardNumber: String (optional)
Gets the awards associated with the awardNumber.
awardHierarchy: String (optional)
Gets all the awards in the award hierarchy with the awardHierarchy number. The awardHierarchy for an award with awardNumber 000224-00001 would be 000224. If present along with the awardNumber parameter, awardNumber gets preference.
includeBudgets: boolean (optional)
Includes budget information with the award if true.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "docNbr": null,
    "docStatus": null,
    "awardId": 13163,
    "awardNumber": "000224-00001",
    "sequenceNumber": 1,
    "sponsorCode": "000100",
    "statusCode": 1,
    "accountNumber": null,
    "awardEffectiveDate": "2015-07-01",
    "awardExecutionDate": null,
    "beginDate": null,
    "projectEndDate": "2018-06-30",
    "costSharingIndicator": "N",
    "indirectCostIndicator": "N",
    "nsfSequenceNumber": null,
    "paymentScheduleIndicator": "N",
    "scienceCodeIndicator": "N",
    "specialReviewIndicator": "N",
    "sponsorAwardNumber": null,
    "transferSponsorIndicator": "N",
    "accountTypeCode": null,
    "activityTypeCode": "1",
    "primeSponsorCode": "000340",
    "awardTypeCode": 1,
    "cfdaNumber": null,
    "methodOfPaymentCode": "1",
    "proposalNumber": null,
    "title": "retest ab",
    "basisOfPaymentCode": "2",
    "awardTransactionTypeCode": 9,
    "noticeDate": null,
    "leadUnitNumber": "BL-IIDC",
    "awardSequenceStatus": "PENDING",
    "unitNumber": "BL-IIDC",
    "projectPersons": [
      {
        "awardContactId": 13188,
        "personId": "10000000051",
        "roleCode": "PI",
        "keyPersonRole": null,
        "rolodexId": null,
        "kcPerson.emailAddress": "kcnotification+someone@gmail.com",
        "kcPerson.phoneNumber": "321-321-1197"
      }
    ],
    "awardCustomDataList": [
      {
        "customAttributeId": 1,
        "value": "435454"
      },
      {
        "customAttributeId": 2,
        "value": null
      },
      {
        "customAttributeId": 3,
        "value": null
      },
      {
        "customAttributeId": 4,
        "value": "32"
      },
      {
        "customAttributeId": 5,
        "value": null
      },
      {
        "customAttributeId": 6,
        "value": null
      },
      {
        "customAttributeId": 7,
        "value": null
      }
    ],
    "awardSponsorTerms": [
      {
        "sponsorTermId": 325
      },
      {
        "sponsorTermId": 505
      },
      {
        "sponsorTermId": 316
      },
      {
        "sponsorTermId": 353
      },
      {
        "sponsorTermId": 371
      },
      {
        "sponsorTermId": 538
      },
      {
        "sponsorTermId": 318
      },
      {
        "sponsorTermId": 354
      },
      {
        "sponsorTermId": 372
      },
      {
        "sponsorTermId": 417
      },
      {
        "sponsorTermId": 544
      },
      {
        "sponsorTermId": 556
      },
      {
        "sponsorTermId": 567
      },
      {
        "sponsorTermId": 569
      },
      {
        "sponsorTermId": 493
      },
      {
        "sponsorTermId": 500
      },
      {
        "sponsorTermId": 410
      },
      {
        "sponsorTermId": 437
      },
      {
        "sponsorTermId": 383
      },
      {
        "sponsorTermId": 578
      },
      {
        "sponsorTermId": 601
      },
      {
        "sponsorTermId": 322
      },
      {
        "sponsorTermId": 367
      },
      {
        "sponsorTermId": 448
      },
      {
        "sponsorTermId": 480
      },
      {
        "sponsorTermId": 333
      },
      {
        "sponsorTermId": 369
      }
    ],
    "awardReportTerms": [
      {
        "reportClassCode": "7",
        "reportCode": "70",
        "frequencyCode": "23",
        "frequencyBaseCode": "4",
        "ospDistributionCode": "4",
        "dueDate": null
      },
      {
        "reportClassCode": "2",
        "reportCode": "40",
        "frequencyCode": "13",
        "frequencyBaseCode": "4",
        "ospDistributionCode": "2",
        "dueDate": null
      },
      {
        "reportClassCode": "3",
        "reportCode": "36",
        "frequencyCode": "30",
        "frequencyBaseCode": "3",
        "ospDistributionCode": "1",
        "dueDate": null
      },
      {
        "reportClassCode": "1",
        "reportCode": "5",
        "frequencyCode": "12",
        "frequencyBaseCode": "4",
        "ospDistributionCode": "2",
        "dueDate": null
      },
      {
        "reportClassCode": "4",
        "reportCode": "5",
        "frequencyCode": "43",
        "frequencyBaseCode": "4",
        "ospDistributionCode": "1",
        "dueDate": null
      },
      {
        "reportClassCode": "6",
        "reportCode": "5",
        "frequencyCode": "12",
        "frequencyBaseCode": "4",
        "ospDistributionCode": "4",
        "dueDate": null
      },
      {
        "reportClassCode": "4",
        "reportCode": "9",
        "frequencyCode": "4",
        "frequencyBaseCode": "6",
        "ospDistributionCode": "3",
        "dueDate": null
      },
      {
        "reportClassCode": "7",
        "reportCode": "69",
        "frequencyCode": "16",
        "frequencyBaseCode": "4",
        "ospDistributionCode": "4",
        "dueDate": null
      },
      {
        "reportClassCode": "3",
        "reportCode": "7",
        "frequencyCode": "6",
        "frequencyBaseCode": "2",
        "ospDistributionCode": "4",
        "dueDate": null
      },
      {
        "reportClassCode": "5",
        "reportCode": "7",
        "frequencyCode": "3",
        "frequencyBaseCode": "2",
        "ospDistributionCode": "1",
        "dueDate": null
      },
      {
        "reportClassCode": "2",
        "reportCode": "39",
        "frequencyCode": "3",
        "frequencyBaseCode": "2",
        "ospDistributionCode": "1",
        "dueDate": null
      },
      {
        "reportClassCode": "1",
        "reportCode": "33",
        "frequencyCode": "7",
        "frequencyBaseCode": "3",
        "ospDistributionCode": "4",
        "dueDate": null
      },
      {
        "reportClassCode": "6",
        "reportCode": "51",
        "frequencyCode": "2",
        "frequencyBaseCode": "2",
        "ospDistributionCode": "4",
        "dueDate": null
      },
      {
        "reportClassCode": "5",
        "reportCode": "37",
        "frequencyCode": "10",
        "frequencyBaseCode": "4",
        "ospDistributionCode": "4",
        "dueDate": null
      }
    ],
    "approvedEquipmentIndicator": "N",
    "approvedForeignTripIndicator": "N",
    "subContractIndicator": "N",
    "modificationNumber": null,
    "documentFundingId": null,
    "preAwardAuthorizedAmount": null,
    "preAwardEffectiveDate": null,
    "preAwardInstitutionalAuthorizedAmount": null,
    "preAwardInstitutionalEffectiveDate": null,
    "procurementPriorityCode": null,
    "specialEbRateOffCampus": null,
    "specialEbRateOnCampus": null,
    "subPlanFlag": null,
    "archiveLocation": null,
    "closeoutDate": null,
    "currentActionComments": "",
    "awardSequenceStatusResult": "Saved",
    "templateCode": 1,
    "awardBasisOfPayment": null,
    "awardMethodOfPayment": null,
    "awardComments": [
      {
        "awardCommentId": 3587,
        "commentTypeCode": "21",
        "checklistPrintFlag": false,
        "comments": null
      },
      {
        "awardCommentId": 3588,
        "commentTypeCode": "2",
        "checklistPrintFlag": false,
        "comments": "General remarks from sync to Test Sponsor Template."
      },
      {
        "awardCommentId": 3589,
        "commentTypeCode": "3",
        "checklistPrintFlag": false,
        "comments": "Financial Rpt remarks from sync to Test Sponsor Template."
      },
      {
        "awardCommentId": 3590,
        "commentTypeCode": "4",
        "checklistPrintFlag": false,
        "comments": "IP remarks from sync to Test Sponsor Template."
      },
      {
        "awardCommentId": 3591,
        "commentTypeCode": "5",
        "checklistPrintFlag": false,
        "comments": "Procurement remarks from sync to Test Sponsor Template."
      },
      {
        "awardCommentId": 3592,
        "commentTypeCode": "6",
        "checklistPrintFlag": false,
        "comments": "Property/Equipment remarks from sync to Test Sponsor Template."
      },
      {
        "awardCommentId": 3593,
        "commentTypeCode": "1",
        "checklistPrintFlag": false,
        "comments": "Invoicing remarks from sync to Test Sponsor Template."
      },
      {
        "awardCommentId": 3594,
        "commentTypeCode": "9",
        "checklistPrintFlag": false,
        "comments": "Cost sharing remarks from sync to Test Sponsor Template."
      }
    ],
    "awardCostShares": [],
    "awardFandaRate": [],
    "awardDirectFandADistributions": [
      {
        "awardDirectFandADistributionId": 223,
        "amountSequenceNumber": null,
        "awardAmountInfoId": null,
        "budgetPeriod": 1,
        "startDate": "2015-07-01",
        "endDate": "2016-06-30",
        "directCost": 0,
        "indirectCost": 0
      },
      {
        "awardDirectFandADistributionId": 224,
        "amountSequenceNumber": null,
        "awardAmountInfoId": null,
        "budgetPeriod": 2,
        "startDate": "2016-07-01",
        "endDate": "2017-06-30",
        "directCost": 0,
        "indirectCost": 0
      },
      {
        "awardDirectFandADistributionId": 225,
        "amountSequenceNumber": null,
        "awardAmountInfoId": null,
        "budgetPeriod": 3,
        "startDate": "2017-07-01",
        "endDate": "2018-06-30",
        "directCost": 0,
        "indirectCost": 0
      }
    ],
    "awardUnitContacts": [],
    "approvedEquipmentItems": [],
    "approvedForeignTravelTrips": [],
    "paymentScheduleItems": [],
    "awardTransferringSponsors": [],
    "awardAmountInfos": [
      {
        "awardAmountInfoId": 13164,
        "transactionId": null,
        "timeAndMoneyDocumentNumber": null,
        "anticipatedTotalAmount": 684389.73,
        "antDistributableAmount": 684389.73,
        "finalExpirationDate": "2018-06-30",
        "currentFundEffectiveDate": "2015-07-01",
        "amountObligatedToDate": 684389.73,
        "obliDistributableAmount": 684389.73,
        "obligationExpirationDate": "2018-06-30",
        "anticipatedChange": 0,
        "obligatedChange": 0,
        "obligatedChangeDirect": 0,
        "obligatedChangeIndirect": 0,
        "anticipatedChangeDirect": 0,
        "anticipatedChangeIndirect": 0,
        "anticipatedTotalDirect": 684389.73,
        "anticipatedTotalIndirect": 0,
        "obligatedTotalDirect": 684389.73,
        "obligatedTotalIndirect": 0,
        "originatingAwardVersion": 1
      },
      {
        "awardAmountInfoId": 13203,
        "transactionId": null,
        "timeAndMoneyDocumentNumber": "10781",
        "anticipatedTotalAmount": 684389.73,
        "antDistributableAmount": 684389.73,
        "finalExpirationDate": "2018-06-30",
        "currentFundEffectiveDate": "2015-07-01",
        "amountObligatedToDate": 684389.73,
        "obliDistributableAmount": 684389.73,
        "obligationExpirationDate": "2018-06-30",
        "anticipatedChange": 0,
        "obligatedChange": 0,
        "obligatedChangeDirect": 0,
        "obligatedChangeIndirect": 0,
        "anticipatedChangeDirect": 0,
        "anticipatedChangeIndirect": 0,
        "anticipatedTotalDirect": 684389.73,
        "anticipatedTotalIndirect": 0,
        "obligatedTotalDirect": 684389.73,
        "obligatedTotalIndirect": 0,
        "originatingAwardVersion": 1
      },
      {
        "awardAmountInfoId": 13205,
        "transactionId": 85,
        "timeAndMoneyDocumentNumber": "10793",
        "anticipatedTotalAmount": 682389.73,
        "antDistributableAmount": 682389.73,
        "finalExpirationDate": "2018-06-30",
        "currentFundEffectiveDate": "2015-07-01",
        "amountObligatedToDate": 682389.73,
        "obliDistributableAmount": 682389.73,
        "obligationExpirationDate": "2018-06-30",
        "anticipatedChange": 0,
        "obligatedChange": 0,
        "obligatedChangeDirect": 0,
        "obligatedChangeIndirect": 0,
        "anticipatedChangeDirect": 0,
        "anticipatedChangeIndirect": 0,
        "anticipatedTotalDirect": 682389.73,
        "anticipatedTotalIndirect": 0,
        "obligatedTotalDirect": 682389.73,
        "obligatedTotalIndirect": 0,
        "originatingAwardVersion": 1
      },
      {
        "awardAmountInfoId": 13206,
        "transactionId": 86,
        "timeAndMoneyDocumentNumber": "10802",
        "anticipatedTotalAmount": 1364779.46,
        "antDistributableAmount": 1364779.46,
        "finalExpirationDate": "2018-06-30",
        "currentFundEffectiveDate": "2015-07-01",
        "amountObligatedToDate": 1364779.46,
        "obliDistributableAmount": 1364779.46,
        "obligationExpirationDate": "2018-06-30",
        "anticipatedChange": 0,
        "obligatedChange": 0,
        "obligatedChangeDirect": 0,
        "obligatedChangeIndirect": 0,
        "anticipatedChangeDirect": 0,
        "anticipatedChangeIndirect": 0,
        "anticipatedTotalDirect": 1364779.46,
        "anticipatedTotalIndirect": 0,
        "obligatedTotalDirect": 1364779.46,
        "obligatedTotalIndirect": 0,
        "originatingAwardVersion": 1
      }
    ],
    "awardCloseoutItems": [
      {
        "awardCloseoutId": 1673,
        "finalSubmissionDate": null,
        "dueDate": null,
        "closeoutReportCode": "1",
        "closeoutReportName": "Financial",
        "multiple": false
      },
      {
        "awardCloseoutId": 1674,
        "finalSubmissionDate": null,
        "dueDate": null,
        "closeoutReportCode": "4",
        "closeoutReportName": "Technical",
        "multiple": false
      },
      {
        "awardCloseoutId": 1675,
        "finalSubmissionDate": null,
        "dueDate": null,
        "closeoutReportCode": "3",
        "closeoutReportName": "Patent",
        "multiple": false
      },
      {
        "awardCloseoutId": 1676,
        "finalSubmissionDate": null,
        "dueDate": null,
        "closeoutReportCode": "2",
        "closeoutReportName": "Property",
        "multiple": false
      },
      {
        "awardCloseoutId": 1677,
        "finalSubmissionDate": null,
        "dueDate": null,
        "closeoutReportCode": "6",
        "closeoutReportName": "Invoice",
        "multiple": false
      }
    ],
    "awardCloseoutNewItems": [],
    "fundingProposals": [],
    "allFundingProposals": [],
    "awardBudgetLimits": [
      {
        "budgetLimitId": 121,
        "awardId": null,
        "budgetId": null,
        "limitTypeCode": "directCost",
        "limit": null
      },
      {
        "budgetLimitId": 122,
        "awardId": null,
        "budgetId": null,
        "limitTypeCode": "indirectCost",
        "limit": null
      },
      {
        "budgetLimitId": 123,
        "awardId": null,
        "budgetId": null,
        "limitTypeCode": "totalCost",
        "limit": null
      }
    ],
    "budgets": [],
    "fainId": null,
    "fedAwardYear": null,
    "fedAwardDate": null,
    "posted": null,
    "awardSponsorContacts": [
      {
        "rolodexId": 1736,
        "roleCode": "1",
        "awardContactId": 4263,
        "orgName": "Office of Naval Research"
      }
    ]
  }
]

Get all Budgets of an award
GET`/award/api/v2/awards/13163/budgets/`

All budgets of an award

Example URI

GET /award/api/v2/awards/13163/budgets/

URI Parameters

HideShow

awardId: number (required) Example: 13163
Returns the budgets associated with the awardId.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardId": 13163,
    "budgetId": 600,
    "budgetVersionNumber": 2,
    "budgetInitiator": "10000000001",
    "awardBudgetStatusCode": "9",
    "awardBudgetStatus": {
      "awardBudgetStatusCode": "9",
      "description": "Posted"
    },
    "awardBudgetTypeCode": "1",
    "awardBudgetType": {
      "awardBudgetTypeCode": "1",
      "description": "New"
    },
    "obligatedTotal": 0,
    "obligatedAmount": 0,
    "description": "New",
    "onOffCampusFlag": "D",
    "endDate": "2018-06-30",
    "startDate": "2015-07-01",
    "totalCost": 684389.73,
    "totalDirectCost": 684389.73,
    "totalIndirectCost": 0,
    "costSharingAmount": 0,
    "underrecoveryAmount": 0,
    "totalCostLimit": 684389.73,
    "residualFunds": null,
    "ohRateClassCode": "1",
    "ohRateClass": {
      "code": "1",
      "description": "MTDC"
    },
    "ohRateTypeCode": "1",
    "comments": null,
    "modularBudgetFlag": false,
    "urRateClassCode": "1",
    "totalDirectCostLimit": 0,
    "totalDirectCostInclPrev": 684389.73,
    "totalIndirectCostInclPrev": 0,
    "totalCostInclPrev": 684389.73,
    "budgetRates": [
      {
        "activityTypeCode": "1",
        "applicableRate": 5,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "1",
        "rateClass": {
          "code": "1",
          "description": "MTDC"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "1",
          "rateTypeCode": "1",
          "description": "MTDC"
        },
        "startDate": "2014-07-01",
        "instituteRate": 5
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 56,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "1",
        "rateClass": {
          "code": "1",
          "description": "MTDC"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "1",
          "rateTypeCode": "1",
          "description": "MTDC"
        },
        "startDate": "2014-07-01",
        "instituteRate": 56
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2007",
        "onOffCampusFlag": false,
        "rateClassCode": "13",
        "rateClass": {
          "code": "13",
          "description": "MTDC - AWARD"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "13",
          "rateTypeCode": "1",
          "description": "MTDC"
        },
        "startDate": "2007-01-07",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 48,
        "fiscalYear": "2007",
        "onOffCampusFlag": true,
        "rateClassCode": "13",
        "rateClass": {
          "code": "13",
          "description": "MTDC - AWARD"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "13",
          "rateTypeCode": "1",
          "description": "MTDC"
        },
        "startDate": "2007-01-07",
        "instituteRate": 48
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2004",
        "onOffCampusFlag": false,
        "rateClassCode": "2",
        "rateClass": {
          "code": "2",
          "description": "TDC"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "2",
          "rateTypeCode": "1",
          "description": "TDC"
        },
        "startDate": "2003-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2004",
        "onOffCampusFlag": true,
        "rateClassCode": "2",
        "rateClass": {
          "code": "2",
          "description": "TDC"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "2",
          "rateTypeCode": "1",
          "description": "TDC"
        },
        "startDate": "2003-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 62,
        "fiscalYear": "1980",
        "onOffCampusFlag": false,
        "rateClassCode": "3",
        "rateClass": {
          "code": "3",
          "description": "S&W"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "3",
          "rateTypeCode": "1",
          "description": "S&W"
        },
        "startDate": "1979-07-01",
        "instituteRate": 62
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 63,
        "fiscalYear": "1980",
        "onOffCampusFlag": true,
        "rateClassCode": "3",
        "rateClass": {
          "code": "3",
          "description": "S&W"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "3",
          "rateTypeCode": "1",
          "description": "S&W"
        },
        "startDate": "1979-07-01",
        "instituteRate": 63
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 5,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "4",
        "rateClass": {
          "code": "4",
          "description": "Fund with Transaction Fee (FUNSN)"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "4",
          "rateTypeCode": "1",
          "description": "Salaries"
        },
        "startDate": "2014-07-01",
        "instituteRate": 5
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 56,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "4",
        "rateClass": {
          "code": "4",
          "description": "Fund with Transaction Fee (FUNSN)"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "4",
          "rateTypeCode": "1",
          "description": "Salaries"
        },
        "startDate": "2014-07-01",
        "instituteRate": 56
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 10,
        "fiscalYear": "2002",
        "onOffCampusFlag": false,
        "rateClassCode": "4",
        "rateClass": {
          "code": "4",
          "description": "Fund with Transaction Fee (FUNSN)"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "4",
          "rateTypeCode": "2",
          "description": "Materials and Services"
        },
        "startDate": "2001-07-01",
        "instituteRate": 10
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 10,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "4",
        "rateClass": {
          "code": "4",
          "description": "Fund with Transaction Fee (FUNSN)"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "4",
          "rateTypeCode": "2",
          "description": "Materials and Services"
        },
        "startDate": "2014-07-01",
        "instituteRate": 10
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 25,
        "fiscalYear": "2006",
        "onOffCampusFlag": false,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "1",
          "description": "Research Rate"
        },
        "startDate": "2005-07-01",
        "instituteRate": 25
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 27,
        "fiscalYear": "2006",
        "onOffCampusFlag": true,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "1",
          "description": "Research Rate"
        },
        "startDate": "2005-07-01",
        "instituteRate": 27
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2004",
        "onOffCampusFlag": false,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "2",
          "description": "UROP Rate"
        },
        "startDate": "2003-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2004",
        "onOffCampusFlag": true,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "2",
          "description": "UROP Rate"
        },
        "startDate": "2003-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 26,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "3",
          "description": "EB on LA"
        },
        "startDate": "2014-07-01",
        "instituteRate": 26
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 24,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "3",
          "description": "EB on LA"
        },
        "startDate": "2014-07-01",
        "instituteRate": 24
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2015-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2015-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2016-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2016-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2017-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2017-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2018-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2018-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2015-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2015-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2016-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2016-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2017-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2017-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2018-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2018-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2011",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "6",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "6",
          "description": "Students (6/1)"
        },
        "startDate": "2011-06-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2011",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "6",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "6",
          "description": "Students (6/1)"
        },
        "startDate": "2011-06-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 10.5,
        "fiscalYear": "2006",
        "onOffCampusFlag": false,
        "rateClassCode": "8",
        "rateClass": {
          "code": "8",
          "description": "Vacation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "8",
          "rateTypeCode": "1",
          "description": "Vacation "
        },
        "startDate": "2005-07-01",
        "instituteRate": 10.5
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 9.5,
        "fiscalYear": "2006",
        "onOffCampusFlag": true,
        "rateClassCode": "8",
        "rateClass": {
          "code": "8",
          "description": "Vacation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "8",
          "rateTypeCode": "1",
          "description": "Vacation "
        },
        "startDate": "2005-07-01",
        "instituteRate": 9.5
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 9,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "8",
        "rateClass": {
          "code": "8",
          "description": "Vacation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "8",
          "rateTypeCode": "2",
          "description": "Vacation on LA"
        },
        "startDate": "2014-07-01",
        "instituteRate": 9
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 9,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "8",
        "rateClass": {
          "code": "8",
          "description": "Vacation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "8",
          "rateTypeCode": "2",
          "description": "Vacation on LA"
        },
        "startDate": "2014-07-01",
        "instituteRate": 9
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2000",
        "onOffCampusFlag": false,
        "rateClassCode": "9",
        "rateClass": {
          "code": "9",
          "description": "Other"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "9",
          "rateTypeCode": "1",
          "description": "Other"
        },
        "startDate": "1999-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2000",
        "onOffCampusFlag": true,
        "rateClassCode": "9",
        "rateClass": {
          "code": "9",
          "description": "Other"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "9",
          "rateTypeCode": "1",
          "description": "Other"
        },
        "startDate": "1999-07-01",
        "instituteRate": 0
      }
    ],
    "budgetLaRates": [],
    "budgetPeriods": [
      {
        "comments": null,
        "costSharingAmount": 0,
        "endDate": "2016-06-30",
        "startDate": "2015-07-01",
        "totalCost": 684389.73,
        "totalCostLimit": 0,
        "totalDirectCost": 684389.73,
        "totalIndirectCost": 0,
        "underrecoveryAmount": 0,
        "budgetLineItems": [
          {
            "costSharingAmount": 0,
            "budgetLineItemId": 4161,
            "lineItemNumber": 1,
            "applyInRateFlag": false,
            "basedOnLineItem": null,
            "budgetJustification": null,
            "groupName": null,
            "endDate": "2016-06-30",
            "lineItemCost": 684389.73,
            "obligatedAmount": 0,
            "lineItemDescription": null,
            "lineItemSequence": 1,
            "onOffCampusFlag": true,
            "quantity": null,
            "startDate": "2015-07-01",
            "underrecoveryAmount": 0,
            "formulatedCostElementFlag": false,
            "costElement": "421818",
            "costElementBO": {
              "costElement": "421818",
              "description": "Equipment - Not MTDC",
              "onOffCampusFlag": true,
              "active": true
            },
            "budgetCategoryCode": "20",
            "budgetCategory": {
              "code": "20",
              "description": "Equipment"
            },
            "budgetPersonnelDetailsList": [],
            "budgetLineItemCalculatedAmounts": []
          }
        ],
        "numberOfParticipants": null,
        "directCostLimit": 0,
        "expenseTotal": null,
        "budgetId": 600
      },
      {
        "comments": null,
        "costSharingAmount": 0,
        "endDate": "2017-06-30",
        "startDate": "2016-07-01",
        "totalCost": 0,
        "totalCostLimit": 0,
        "totalDirectCost": 0,
        "totalIndirectCost": 0,
        "underrecoveryAmount": 0,
        "budgetLineItems": [],
        "numberOfParticipants": null,
        "directCostLimit": 0,
        "expenseTotal": null,
        "budgetId": 600
      },
      {
        "comments": null,
        "costSharingAmount": 0,
        "endDate": "2018-06-30",
        "startDate": "2017-07-01",
        "totalCost": 0,
        "totalCostLimit": 0,
        "totalDirectCost": 0,
        "totalIndirectCost": 0,
        "underrecoveryAmount": 0,
        "budgetLineItems": [],
        "numberOfParticipants": null,
        "directCostLimit": 0,
        "expenseTotal": null,
        "budgetId": 600
      }
    ],
    "awardBudgetLimits": [],
    "budgetPersons": []
  },
  {
    "awardId": 13163,
    "budgetId": 601,
    "budgetVersionNumber": 3,
    "budgetInitiator": "10000000001",
    "awardBudgetStatusCode": "14",
    "awardBudgetStatus": {
      "awardBudgetStatusCode": "14",
      "description": "Cancelled"
    },
    "awardBudgetTypeCode": "2",
    "awardBudgetType": {
      "awardBudgetTypeCode": "2",
      "description": "Rebudget"
    },
    "obligatedTotal": 0,
    "obligatedAmount": 0,
    "description": "Rebudget",
    "onOffCampusFlag": "D",
    "endDate": "2018-06-30",
    "startDate": "2015-07-01",
    "totalCost": 0,
    "totalDirectCost": 0,
    "totalIndirectCost": 0,
    "costSharingAmount": 0,
    "underrecoveryAmount": 0,
    "totalCostLimit": 0,
    "residualFunds": null,
    "ohRateClassCode": "1",
    "ohRateClass": {
      "code": "1",
      "description": "MTDC"
    },
    "ohRateTypeCode": "1",
    "comments": null,
    "modularBudgetFlag": false,
    "urRateClassCode": "1",
    "totalDirectCostLimit": 0,
    "totalDirectCostInclPrev": 0,
    "totalIndirectCostInclPrev": 0,
    "totalCostInclPrev": 0,
    "budgetRates": [
      {
        "activityTypeCode": "1",
        "applicableRate": 5,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "1",
        "rateClass": {
          "code": "1",
          "description": "MTDC"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "1",
          "rateTypeCode": "1",
          "description": "MTDC"
        },
        "startDate": "2014-07-01",
        "instituteRate": 5
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 56,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "1",
        "rateClass": {
          "code": "1",
          "description": "MTDC"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "1",
          "rateTypeCode": "1",
          "description": "MTDC"
        },
        "startDate": "2014-07-01",
        "instituteRate": 56
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2007",
        "onOffCampusFlag": false,
        "rateClassCode": "13",
        "rateClass": {
          "code": "13",
          "description": "MTDC - AWARD"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "13",
          "rateTypeCode": "1",
          "description": "MTDC"
        },
        "startDate": "2007-01-07",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 48,
        "fiscalYear": "2007",
        "onOffCampusFlag": true,
        "rateClassCode": "13",
        "rateClass": {
          "code": "13",
          "description": "MTDC - AWARD"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "13",
          "rateTypeCode": "1",
          "description": "MTDC"
        },
        "startDate": "2007-01-07",
        "instituteRate": 48
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2004",
        "onOffCampusFlag": false,
        "rateClassCode": "2",
        "rateClass": {
          "code": "2",
          "description": "TDC"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "2",
          "rateTypeCode": "1",
          "description": "TDC"
        },
        "startDate": "2003-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2004",
        "onOffCampusFlag": true,
        "rateClassCode": "2",
        "rateClass": {
          "code": "2",
          "description": "TDC"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "2",
          "rateTypeCode": "1",
          "description": "TDC"
        },
        "startDate": "2003-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 62,
        "fiscalYear": "1980",
        "onOffCampusFlag": false,
        "rateClassCode": "3",
        "rateClass": {
          "code": "3",
          "description": "S&W"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "3",
          "rateTypeCode": "1",
          "description": "S&W"
        },
        "startDate": "1979-07-01",
        "instituteRate": 62
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 63,
        "fiscalYear": "1980",
        "onOffCampusFlag": true,
        "rateClassCode": "3",
        "rateClass": {
          "code": "3",
          "description": "S&W"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "3",
          "rateTypeCode": "1",
          "description": "S&W"
        },
        "startDate": "1979-07-01",
        "instituteRate": 63
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 5,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "4",
        "rateClass": {
          "code": "4",
          "description": "Fund with Transaction Fee (FUNSN)"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "4",
          "rateTypeCode": "1",
          "description": "Salaries"
        },
        "startDate": "2014-07-01",
        "instituteRate": 5
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 56,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "4",
        "rateClass": {
          "code": "4",
          "description": "Fund with Transaction Fee (FUNSN)"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "4",
          "rateTypeCode": "1",
          "description": "Salaries"
        },
        "startDate": "2014-07-01",
        "instituteRate": 56
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 10,
        "fiscalYear": "2002",
        "onOffCampusFlag": false,
        "rateClassCode": "4",
        "rateClass": {
          "code": "4",
          "description": "Fund with Transaction Fee (FUNSN)"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "4",
          "rateTypeCode": "2",
          "description": "Materials and Services"
        },
        "startDate": "2001-07-01",
        "instituteRate": 10
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 10,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "4",
        "rateClass": {
          "code": "4",
          "description": "Fund with Transaction Fee (FUNSN)"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "4",
          "rateTypeCode": "2",
          "description": "Materials and Services"
        },
        "startDate": "2014-07-01",
        "instituteRate": 10
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 25,
        "fiscalYear": "2006",
        "onOffCampusFlag": false,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "1",
          "description": "Research Rate"
        },
        "startDate": "2005-07-01",
        "instituteRate": 25
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 27,
        "fiscalYear": "2006",
        "onOffCampusFlag": true,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "1",
          "description": "Research Rate"
        },
        "startDate": "2005-07-01",
        "instituteRate": 27
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2004",
        "onOffCampusFlag": false,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "2",
          "description": "UROP Rate"
        },
        "startDate": "2003-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2004",
        "onOffCampusFlag": true,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "2",
          "description": "UROP Rate"
        },
        "startDate": "2003-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 26,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "3",
          "description": "EB on LA"
        },
        "startDate": "2014-07-01",
        "instituteRate": 26
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 24,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "3",
          "description": "EB on LA"
        },
        "startDate": "2014-07-01",
        "instituteRate": 24
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2015-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2015-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2016-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2016-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2017-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2017-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2018-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2018-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2015-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2015-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2016-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2016-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2017-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2017-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2018-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2018-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2011",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "6",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "6",
          "description": "Students (6/1)"
        },
        "startDate": "2011-06-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2011",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "6",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "6",
          "description": "Students (6/1)"
        },
        "startDate": "2011-06-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 10.5,
        "fiscalYear": "2006",
        "onOffCampusFlag": false,
        "rateClassCode": "8",
        "rateClass": {
          "code": "8",
          "description": "Vacation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "8",
          "rateTypeCode": "1",
          "description": "Vacation "
        },
        "startDate": "2005-07-01",
        "instituteRate": 10.5
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 9.5,
        "fiscalYear": "2006",
        "onOffCampusFlag": true,
        "rateClassCode": "8",
        "rateClass": {
          "code": "8",
          "description": "Vacation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "8",
          "rateTypeCode": "1",
          "description": "Vacation "
        },
        "startDate": "2005-07-01",
        "instituteRate": 9.5
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 9,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "8",
        "rateClass": {
          "code": "8",
          "description": "Vacation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "8",
          "rateTypeCode": "2",
          "description": "Vacation on LA"
        },
        "startDate": "2014-07-01",
        "instituteRate": 9
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 9,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "8",
        "rateClass": {
          "code": "8",
          "description": "Vacation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "8",
          "rateTypeCode": "2",
          "description": "Vacation on LA"
        },
        "startDate": "2014-07-01",
        "instituteRate": 9
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2000",
        "onOffCampusFlag": false,
        "rateClassCode": "9",
        "rateClass": {
          "code": "9",
          "description": "Other"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "9",
          "rateTypeCode": "1",
          "description": "Other"
        },
        "startDate": "1999-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2000",
        "onOffCampusFlag": true,
        "rateClassCode": "9",
        "rateClass": {
          "code": "9",
          "description": "Other"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "9",
          "rateTypeCode": "1",
          "description": "Other"
        },
        "startDate": "1999-07-01",
        "instituteRate": 0
      }
    ],
    "budgetLaRates": [],
    "budgetPeriods": [
      {
        "comments": null,
        "costSharingAmount": 0,
        "endDate": "2016-06-30",
        "startDate": "2015-07-01",
        "totalCost": 0,
        "totalCostLimit": 0,
        "totalDirectCost": 0,
        "totalIndirectCost": 0,
        "underrecoveryAmount": 0,
        "budgetLineItems": [
          {
            "costSharingAmount": 0,
            "budgetLineItemId": 4162,
            "lineItemNumber": 1,
            "applyInRateFlag": false,
            "basedOnLineItem": null,
            "budgetJustification": null,
            "groupName": null,
            "endDate": "2016-06-30",
            "lineItemCost": 0,
            "obligatedAmount": 684390,
            "lineItemDescription": null,
            "lineItemSequence": 1,
            "onOffCampusFlag": true,
            "quantity": null,
            "startDate": "2015-07-01",
            "underrecoveryAmount": 0,
            "formulatedCostElementFlag": false,
            "costElement": "421818",
            "costElementBO": {
              "costElement": "421818",
              "description": "Equipment - Not MTDC",
              "onOffCampusFlag": true,
              "active": true
            },
            "budgetCategoryCode": "20",
            "budgetCategory": {
              "code": "20",
              "description": "Equipment"
            },
            "budgetPersonnelDetailsList": [],
            "budgetLineItemCalculatedAmounts": []
          }
        ],
        "numberOfParticipants": null,
        "directCostLimit": 0,
        "expenseTotal": null,
        "budgetId": 601
      },
      {
        "comments": null,
        "costSharingAmount": 0,
        "endDate": "2017-06-30",
        "startDate": "2016-07-01",
        "totalCost": 0,
        "totalCostLimit": 0,
        "totalDirectCost": 0,
        "totalIndirectCost": 0,
        "underrecoveryAmount": 0,
        "budgetLineItems": [],
        "numberOfParticipants": null,
        "directCostLimit": 0,
        "expenseTotal": null,
        "budgetId": 601
      },
      {
        "comments": null,
        "costSharingAmount": 0,
        "endDate": "2018-06-30",
        "startDate": "2017-07-01",
        "totalCost": 0,
        "totalCostLimit": 0,
        "totalDirectCost": 0,
        "totalIndirectCost": 0,
        "underrecoveryAmount": 0,
        "budgetLineItems": [],
        "numberOfParticipants": null,
        "directCostLimit": 0,
        "expenseTotal": null,
        "budgetId": 601
      }
    ],
    "awardBudgetLimits": [
      {
        "budgetLimitId": 127,
        "awardId": null,
        "budgetId": 601,
        "limitTypeCode": "directCost",
        "limit": null
      },
      {
        "budgetLimitId": 128,
        "awardId": null,
        "budgetId": 601,
        "limitTypeCode": "indirectCost",
        "limit": null
      },
      {
        "budgetLimitId": 129,
        "awardId": null,
        "budgetId": 601,
        "limitTypeCode": "totalCost",
        "limit": null
      },
      {
        "budgetLimitId": 130,
        "awardId": null,
        "budgetId": 601,
        "limitTypeCode": "directCost",
        "limit": null
      },
      {
        "budgetLimitId": 131,
        "awardId": null,
        "budgetId": 601,
        "limitTypeCode": "indirectCost",
        "limit": null
      },
      {
        "budgetLimitId": 132,
        "awardId": null,
        "budgetId": 601,
        "limitTypeCode": "totalCost",
        "limit": null
      }
    ],
    "budgetPersons": []
  },
  {
    "awardId": 13163,
    "budgetId": 602,
    "budgetVersionNumber": 4,
    "budgetInitiator": "10000000001",
    "awardBudgetStatusCode": "9",
    "awardBudgetStatus": {
      "awardBudgetStatusCode": "9",
      "description": "Posted"
    },
    "awardBudgetTypeCode": "1",
    "awardBudgetType": {
      "awardBudgetTypeCode": "1",
      "description": "New"
    },
    "obligatedTotal": 0,
    "obligatedAmount": 0,
    "description": "New",
    "onOffCampusFlag": "D",
    "endDate": "2018-06-30",
    "startDate": "2015-07-01",
    "totalCost": -2000,
    "totalDirectCost": -2000,
    "totalIndirectCost": 0,
    "costSharingAmount": 0,
    "underrecoveryAmount": 0,
    "totalCostLimit": -2000,
    "residualFunds": null,
    "ohRateClassCode": "1",
    "ohRateClass": {
      "code": "1",
      "description": "MTDC"
    },
    "ohRateTypeCode": "1",
    "comments": null,
    "modularBudgetFlag": false,
    "urRateClassCode": "1",
    "totalDirectCostLimit": 0,
    "totalDirectCostInclPrev": -2000,
    "totalIndirectCostInclPrev": 0,
    "totalCostInclPrev": -2000,
    "budgetRates": [
      {
        "activityTypeCode": "1",
        "applicableRate": 5,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "1",
        "rateClass": {
          "code": "1",
          "description": "MTDC"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "1",
          "rateTypeCode": "1",
          "description": "MTDC"
        },
        "startDate": "2014-07-01",
        "instituteRate": 5
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 56,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "1",
        "rateClass": {
          "code": "1",
          "description": "MTDC"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "1",
          "rateTypeCode": "1",
          "description": "MTDC"
        },
        "startDate": "2014-07-01",
        "instituteRate": 56
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2007",
        "onOffCampusFlag": false,
        "rateClassCode": "13",
        "rateClass": {
          "code": "13",
          "description": "MTDC - AWARD"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "13",
          "rateTypeCode": "1",
          "description": "MTDC"
        },
        "startDate": "2007-01-07",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 48,
        "fiscalYear": "2007",
        "onOffCampusFlag": true,
        "rateClassCode": "13",
        "rateClass": {
          "code": "13",
          "description": "MTDC - AWARD"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "13",
          "rateTypeCode": "1",
          "description": "MTDC"
        },
        "startDate": "2007-01-07",
        "instituteRate": 48
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2004",
        "onOffCampusFlag": false,
        "rateClassCode": "2",
        "rateClass": {
          "code": "2",
          "description": "TDC"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "2",
          "rateTypeCode": "1",
          "description": "TDC"
        },
        "startDate": "2003-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2004",
        "onOffCampusFlag": true,
        "rateClassCode": "2",
        "rateClass": {
          "code": "2",
          "description": "TDC"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "2",
          "rateTypeCode": "1",
          "description": "TDC"
        },
        "startDate": "2003-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 62,
        "fiscalYear": "1980",
        "onOffCampusFlag": false,
        "rateClassCode": "3",
        "rateClass": {
          "code": "3",
          "description": "S&W"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "3",
          "rateTypeCode": "1",
          "description": "S&W"
        },
        "startDate": "1979-07-01",
        "instituteRate": 62
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 63,
        "fiscalYear": "1980",
        "onOffCampusFlag": true,
        "rateClassCode": "3",
        "rateClass": {
          "code": "3",
          "description": "S&W"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "3",
          "rateTypeCode": "1",
          "description": "S&W"
        },
        "startDate": "1979-07-01",
        "instituteRate": 63
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 5,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "4",
        "rateClass": {
          "code": "4",
          "description": "Fund with Transaction Fee (FUNSN)"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "4",
          "rateTypeCode": "1",
          "description": "Salaries"
        },
        "startDate": "2014-07-01",
        "instituteRate": 5
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 56,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "4",
        "rateClass": {
          "code": "4",
          "description": "Fund with Transaction Fee (FUNSN)"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "4",
          "rateTypeCode": "1",
          "description": "Salaries"
        },
        "startDate": "2014-07-01",
        "instituteRate": 56
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 10,
        "fiscalYear": "2002",
        "onOffCampusFlag": false,
        "rateClassCode": "4",
        "rateClass": {
          "code": "4",
          "description": "Fund with Transaction Fee (FUNSN)"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "4",
          "rateTypeCode": "2",
          "description": "Materials and Services"
        },
        "startDate": "2001-07-01",
        "instituteRate": 10
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 10,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "4",
        "rateClass": {
          "code": "4",
          "description": "Fund with Transaction Fee (FUNSN)"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "4",
          "rateTypeCode": "2",
          "description": "Materials and Services"
        },
        "startDate": "2014-07-01",
        "instituteRate": 10
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 25,
        "fiscalYear": "2006",
        "onOffCampusFlag": false,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "1",
          "description": "Research Rate"
        },
        "startDate": "2005-07-01",
        "instituteRate": 25
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 27,
        "fiscalYear": "2006",
        "onOffCampusFlag": true,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "1",
          "description": "Research Rate"
        },
        "startDate": "2005-07-01",
        "instituteRate": 27
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2004",
        "onOffCampusFlag": false,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "2",
          "description": "UROP Rate"
        },
        "startDate": "2003-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2004",
        "onOffCampusFlag": true,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "2",
          "description": "UROP Rate"
        },
        "startDate": "2003-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 26,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "3",
          "description": "EB on LA"
        },
        "startDate": "2014-07-01",
        "instituteRate": 26
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 24,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "3",
          "description": "EB on LA"
        },
        "startDate": "2014-07-01",
        "instituteRate": 24
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2015-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2015-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2016-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2016-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2017-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2017-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2018-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2018-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2015-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2015-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2016-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2016-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2017-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2017-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2018-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2018-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2011",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "6",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "6",
          "description": "Students (6/1)"
        },
        "startDate": "2011-06-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2011",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "6",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "6",
          "description": "Students (6/1)"
        },
        "startDate": "2011-06-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 10.5,
        "fiscalYear": "2006",
        "onOffCampusFlag": false,
        "rateClassCode": "8",
        "rateClass": {
          "code": "8",
          "description": "Vacation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "8",
          "rateTypeCode": "1",
          "description": "Vacation "
        },
        "startDate": "2005-07-01",
        "instituteRate": 10.5
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 9.5,
        "fiscalYear": "2006",
        "onOffCampusFlag": true,
        "rateClassCode": "8",
        "rateClass": {
          "code": "8",
          "description": "Vacation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "8",
          "rateTypeCode": "1",
          "description": "Vacation "
        },
        "startDate": "2005-07-01",
        "instituteRate": 9.5
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 9,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "8",
        "rateClass": {
          "code": "8",
          "description": "Vacation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "8",
          "rateTypeCode": "2",
          "description": "Vacation on LA"
        },
        "startDate": "2014-07-01",
        "instituteRate": 9
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 9,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "8",
        "rateClass": {
          "code": "8",
          "description": "Vacation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "8",
          "rateTypeCode": "2",
          "description": "Vacation on LA"
        },
        "startDate": "2014-07-01",
        "instituteRate": 9
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2000",
        "onOffCampusFlag": false,
        "rateClassCode": "9",
        "rateClass": {
          "code": "9",
          "description": "Other"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "9",
          "rateTypeCode": "1",
          "description": "Other"
        },
        "startDate": "1999-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2000",
        "onOffCampusFlag": true,
        "rateClassCode": "9",
        "rateClass": {
          "code": "9",
          "description": "Other"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "9",
          "rateTypeCode": "1",
          "description": "Other"
        },
        "startDate": "1999-07-01",
        "instituteRate": 0
      }
    ],
    "budgetLaRates": [],
    "budgetPeriods": [
      {
        "comments": null,
        "costSharingAmount": 0,
        "endDate": "2016-06-30",
        "startDate": "2015-07-01",
        "totalCost": -2000,
        "totalCostLimit": -2000,
        "totalDirectCost": -2000,
        "totalIndirectCost": 0,
        "underrecoveryAmount": 0,
        "budgetLineItems": [
          {
            "costSharingAmount": 0,
            "budgetLineItemId": 4163,
            "lineItemNumber": 1,
            "applyInRateFlag": false,
            "basedOnLineItem": null,
            "budgetJustification": null,
            "groupName": null,
            "endDate": "2016-06-30",
            "lineItemCost": -2000,
            "obligatedAmount": 684390,
            "lineItemDescription": null,
            "lineItemSequence": 1,
            "onOffCampusFlag": true,
            "quantity": null,
            "startDate": "2015-07-01",
            "underrecoveryAmount": 0,
            "formulatedCostElementFlag": false,
            "costElement": "421818",
            "costElementBO": {
              "costElement": "421818",
              "description": "Equipment - Not MTDC",
              "onOffCampusFlag": true,
              "active": true
            },
            "budgetCategoryCode": "20",
            "budgetCategory": {
              "code": "20",
              "description": "Equipment"
            },
            "budgetPersonnelDetailsList": [],
            "budgetLineItemCalculatedAmounts": []
          }
        ],
        "numberOfParticipants": null,
        "directCostLimit": 0,
        "expenseTotal": null,
        "budgetId": 602
      },
      {
        "comments": null,
        "costSharingAmount": 0,
        "endDate": "2017-06-30",
        "startDate": "2016-07-01",
        "totalCost": 0,
        "totalCostLimit": -2000,
        "totalDirectCost": 0,
        "totalIndirectCost": 0,
        "underrecoveryAmount": 0,
        "budgetLineItems": [],
        "numberOfParticipants": null,
        "directCostLimit": 0,
        "expenseTotal": null,
        "budgetId": 602
      },
      {
        "comments": null,
        "costSharingAmount": 0,
        "endDate": "2018-06-30",
        "startDate": "2017-07-01",
        "totalCost": 0,
        "totalCostLimit": -2000,
        "totalDirectCost": 0,
        "totalIndirectCost": 0,
        "underrecoveryAmount": 0,
        "budgetLineItems": [],
        "numberOfParticipants": null,
        "directCostLimit": 0,
        "expenseTotal": null,
        "budgetId": 602
      }
    ],
    "awardBudgetLimits": [],
    "budgetPersons": []
  },
  {
    "awardId": 13163,
    "budgetId": 603,
    "budgetVersionNumber": 5,
    "budgetInitiator": "10000000001",
    "awardBudgetStatusCode": "14",
    "awardBudgetStatus": {
      "awardBudgetStatusCode": "14",
      "description": "Cancelled"
    },
    "awardBudgetTypeCode": "1",
    "awardBudgetType": {
      "awardBudgetTypeCode": "1",
      "description": "New"
    },
    "obligatedTotal": 0,
    "obligatedAmount": 0,
    "description": "New",
    "onOffCampusFlag": "D",
    "endDate": "2018-06-29",
    "startDate": "2015-06-30",
    "totalCost": 682390,
    "totalDirectCost": 682390,
    "totalIndirectCost": 0,
    "costSharingAmount": 0,
    "underrecoveryAmount": 0,
    "totalCostLimit": -2000,
    "residualFunds": null,
    "ohRateClassCode": "1",
    "ohRateClass": {
      "code": "1",
      "description": "MTDC"
    },
    "ohRateTypeCode": "1",
    "comments": null,
    "modularBudgetFlag": false,
    "urRateClassCode": "1",
    "totalDirectCostLimit": 0,
    "totalDirectCostInclPrev": 682390,
    "totalIndirectCostInclPrev": 0,
    "totalCostInclPrev": 682390,
    "budgetRates": [
      {
        "activityTypeCode": "1",
        "applicableRate": 5,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "1",
        "rateClass": {
          "code": "1",
          "description": "MTDC"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "1",
          "rateTypeCode": "1",
          "description": "MTDC"
        },
        "startDate": "2014-07-01",
        "instituteRate": 5
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 56,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "1",
        "rateClass": {
          "code": "1",
          "description": "MTDC"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "1",
          "rateTypeCode": "1",
          "description": "MTDC"
        },
        "startDate": "2014-07-01",
        "instituteRate": 56
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2007",
        "onOffCampusFlag": false,
        "rateClassCode": "13",
        "rateClass": {
          "code": "13",
          "description": "MTDC - AWARD"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "13",
          "rateTypeCode": "1",
          "description": "MTDC"
        },
        "startDate": "2007-01-07",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 48,
        "fiscalYear": "2007",
        "onOffCampusFlag": true,
        "rateClassCode": "13",
        "rateClass": {
          "code": "13",
          "description": "MTDC - AWARD"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "13",
          "rateTypeCode": "1",
          "description": "MTDC"
        },
        "startDate": "2007-01-07",
        "instituteRate": 48
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2004",
        "onOffCampusFlag": false,
        "rateClassCode": "2",
        "rateClass": {
          "code": "2",
          "description": "TDC"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "2",
          "rateTypeCode": "1",
          "description": "TDC"
        },
        "startDate": "2003-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2004",
        "onOffCampusFlag": true,
        "rateClassCode": "2",
        "rateClass": {
          "code": "2",
          "description": "TDC"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "2",
          "rateTypeCode": "1",
          "description": "TDC"
        },
        "startDate": "2003-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 62,
        "fiscalYear": "1980",
        "onOffCampusFlag": false,
        "rateClassCode": "3",
        "rateClass": {
          "code": "3",
          "description": "S&W"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "3",
          "rateTypeCode": "1",
          "description": "S&W"
        },
        "startDate": "1979-07-01",
        "instituteRate": 62
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 63,
        "fiscalYear": "1980",
        "onOffCampusFlag": true,
        "rateClassCode": "3",
        "rateClass": {
          "code": "3",
          "description": "S&W"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "3",
          "rateTypeCode": "1",
          "description": "S&W"
        },
        "startDate": "1979-07-01",
        "instituteRate": 63
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 5,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "4",
        "rateClass": {
          "code": "4",
          "description": "Fund with Transaction Fee (FUNSN)"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "4",
          "rateTypeCode": "1",
          "description": "Salaries"
        },
        "startDate": "2014-07-01",
        "instituteRate": 5
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 56,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "4",
        "rateClass": {
          "code": "4",
          "description": "Fund with Transaction Fee (FUNSN)"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "4",
          "rateTypeCode": "1",
          "description": "Salaries"
        },
        "startDate": "2014-07-01",
        "instituteRate": 56
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 10,
        "fiscalYear": "2002",
        "onOffCampusFlag": false,
        "rateClassCode": "4",
        "rateClass": {
          "code": "4",
          "description": "Fund with Transaction Fee (FUNSN)"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "4",
          "rateTypeCode": "2",
          "description": "Materials and Services"
        },
        "startDate": "2001-07-01",
        "instituteRate": 10
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 10,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "4",
        "rateClass": {
          "code": "4",
          "description": "Fund with Transaction Fee (FUNSN)"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "4",
          "rateTypeCode": "2",
          "description": "Materials and Services"
        },
        "startDate": "2014-07-01",
        "instituteRate": 10
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 25,
        "fiscalYear": "2006",
        "onOffCampusFlag": false,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "1",
          "description": "Research Rate"
        },
        "startDate": "2005-07-01",
        "instituteRate": 25
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 27,
        "fiscalYear": "2006",
        "onOffCampusFlag": true,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "1",
          "description": "Research Rate"
        },
        "startDate": "2005-07-01",
        "instituteRate": 27
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2004",
        "onOffCampusFlag": false,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "2",
          "description": "UROP Rate"
        },
        "startDate": "2003-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2004",
        "onOffCampusFlag": true,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "2",
          "description": "UROP Rate"
        },
        "startDate": "2003-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 26,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "3",
          "description": "EB on LA"
        },
        "startDate": "2014-07-01",
        "instituteRate": 26
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 24,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "3",
          "description": "EB on LA"
        },
        "startDate": "2014-07-01",
        "instituteRate": 24
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2015-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2015-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2016-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2016-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2017-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2017-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2018-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2018-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2015-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2015-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2016-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2016-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2017-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2017-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2018-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2018-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2011",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "6",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "6",
          "description": "Students (6/1)"
        },
        "startDate": "2011-06-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2011",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "6",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "6",
          "description": "Students (6/1)"
        },
        "startDate": "2011-06-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 10.5,
        "fiscalYear": "2006",
        "onOffCampusFlag": false,
        "rateClassCode": "8",
        "rateClass": {
          "code": "8",
          "description": "Vacation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "8",
          "rateTypeCode": "1",
          "description": "Vacation "
        },
        "startDate": "2005-07-01",
        "instituteRate": 10.5
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 9.5,
        "fiscalYear": "2006",
        "onOffCampusFlag": true,
        "rateClassCode": "8",
        "rateClass": {
          "code": "8",
          "description": "Vacation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "8",
          "rateTypeCode": "1",
          "description": "Vacation "
        },
        "startDate": "2005-07-01",
        "instituteRate": 9.5
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 9,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "8",
        "rateClass": {
          "code": "8",
          "description": "Vacation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "8",
          "rateTypeCode": "2",
          "description": "Vacation on LA"
        },
        "startDate": "2014-07-01",
        "instituteRate": 9
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 9,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "8",
        "rateClass": {
          "code": "8",
          "description": "Vacation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "8",
          "rateTypeCode": "2",
          "description": "Vacation on LA"
        },
        "startDate": "2014-07-01",
        "instituteRate": 9
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2000",
        "onOffCampusFlag": false,
        "rateClassCode": "9",
        "rateClass": {
          "code": "9",
          "description": "Other"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "9",
          "rateTypeCode": "1",
          "description": "Other"
        },
        "startDate": "1999-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2000",
        "onOffCampusFlag": true,
        "rateClassCode": "9",
        "rateClass": {
          "code": "9",
          "description": "Other"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "9",
          "rateTypeCode": "1",
          "description": "Other"
        },
        "startDate": "1999-07-01",
        "instituteRate": 0
      }
    ],
    "budgetLaRates": [],
    "budgetPeriods": [
      {
        "comments": null,
        "costSharingAmount": 0,
        "endDate": "2016-06-30",
        "startDate": "2015-07-01",
        "totalCost": 684389.73,
        "totalCostLimit": 0,
        "totalDirectCost": 684389.73,
        "totalIndirectCost": 0,
        "underrecoveryAmount": 383258.25,
        "budgetLineItems": [
          {
            "costSharingAmount": 0,
            "budgetLineItemId": 4160,
            "lineItemNumber": 1,
            "applyInRateFlag": true,
            "basedOnLineItem": null,
            "budgetJustification": null,
            "groupName": "",
            "endDate": "2016-06-30",
            "lineItemCost": 684389.73,
            "obligatedAmount": 0,
            "lineItemDescription": null,
            "lineItemSequence": 1,
            "onOffCampusFlag": true,
            "quantity": 0,
            "startDate": "2015-07-01",
            "underrecoveryAmount": 383258.25,
            "formulatedCostElementFlag": false,
            "costElement": "420262",
            "costElementBO": {
              "costElement": "420262",
              "description": "Temporary Help",
              "onOffCampusFlag": true,
              "active": true
            },
            "budgetCategoryCode": "30",
            "budgetCategory": {
              "code": "30",
              "description": "Other Personnel"
            },
            "budgetPersonnelDetailsList": [],
            "budgetLineItemCalculatedAmounts": [
              {
                "budgetId": 599,
                "budgetPeriod": 1,
                "budgetPeriodId": null,
                "lineItemNumber": 1,
                "applyRateFlag": false,
                "calculatedCost": 0,
                "calculatedCostSharing": 0,
                "rateTypeDescription": "MTDC",
                "rateClassCode": "1",
                "rateClass": {
                  "code": "1",
                  "description": "MTDC"
                },
                "rateTypeCode": "1",
                "rateType": null,
                "budgetLineItemCalculatedAmountId": 42127,
                "budgetLineItemId": 4160
              },
              {
                "budgetId": 599,
                "budgetPeriod": 1,
                "budgetPeriodId": null,
                "lineItemNumber": 1,
                "applyRateFlag": false,
                "calculatedCost": 0,
                "calculatedCostSharing": 0,
                "rateTypeDescription": "Research Rate",
                "rateClassCode": "5",
                "rateClass": {
                  "code": "5",
                  "description": "Employee Benefits"
                },
                "rateTypeCode": "1",
                "rateType": null,
                "budgetLineItemCalculatedAmountId": 42128,
                "budgetLineItemId": 4160
              },
              {
                "budgetId": 599,
                "budgetPeriod": 1,
                "budgetPeriodId": null,
                "lineItemNumber": 1,
                "applyRateFlag": true,
                "calculatedCost": 0,
                "calculatedCostSharing": 0,
                "rateTypeDescription": "EB on LA",
                "rateClassCode": "5",
                "rateClass": {
                  "code": "5",
                  "description": "Employee Benefits"
                },
                "rateTypeCode": "3",
                "rateType": null,
                "budgetLineItemCalculatedAmountId": 42129,
                "budgetLineItemId": 4160
              },
              {
                "budgetId": 599,
                "budgetPeriod": 1,
                "budgetPeriodId": null,
                "lineItemNumber": 1,
                "applyRateFlag": true,
                "calculatedCost": 0,
                "calculatedCostSharing": 0,
                "rateTypeDescription": "Vacation on LA",
                "rateClassCode": "8",
                "rateClass": {
                  "code": "8",
                  "description": "Vacation"
                },
                "rateTypeCode": "2",
                "rateType": null,
                "budgetLineItemCalculatedAmountId": 42130,
                "budgetLineItemId": 4160
              }
            ]
          }
        ],
        "numberOfParticipants": null,
        "directCostLimit": 0,
        "expenseTotal": null,
        "budgetId": 603
      },
      {
        "comments": null,
        "costSharingAmount": 0,
        "endDate": "2017-06-30",
        "startDate": "2016-07-01",
        "totalCost": 0,
        "totalCostLimit": 0,
        "totalDirectCost": 0,
        "totalIndirectCost": 0,
        "underrecoveryAmount": 0,
        "budgetLineItems": [],
        "numberOfParticipants": null,
        "directCostLimit": 0,
        "expenseTotal": null,
        "budgetId": 603
      },
      {
        "comments": null,
        "costSharingAmount": 0,
        "endDate": "2018-06-30",
        "startDate": "2017-07-01",
        "totalCost": 0,
        "totalCostLimit": 0,
        "totalDirectCost": 0,
        "totalIndirectCost": 0,
        "underrecoveryAmount": 0,
        "budgetLineItems": [],
        "numberOfParticipants": null,
        "directCostLimit": 0,
        "expenseTotal": null,
        "budgetId": 603
      }
    ],
    "awardBudgetLimits": [
      {
        "budgetLimitId": 124,
        "awardId": null,
        "budgetId": 603,
        "limitTypeCode": "directCost",
        "limit": null
      },
      {
        "budgetLimitId": 125,
        "awardId": null,
        "budgetId": 603,
        "limitTypeCode": "indirectCost",
        "limit": null
      },
      {
        "budgetLimitId": 126,
        "awardId": null,
        "budgetId": 603,
        "limitTypeCode": "totalCost",
        "limit": null
      }
    ],
    "budgetPersons": [
      {
        "effectiveDate": "2015-07-01",
        "jobCode": "AA000",
        "nonEmployeeFlag": false,
        "personId": "10000000051",
        "rolodexId": null,
        "appointmentTypeCode": "6",
        "calculationBase": 0,
        "personName": "BEATRIZ BOMAN",
        "salaryAnniversaryDate": null
      }
    ]
  },
  {
    "awardId": 13163,
    "budgetId": 599,
    "budgetVersionNumber": 5,
    "budgetInitiator": "10000000001",
    "awardBudgetStatusCode": "-1",
    "awardBudgetStatus": {
      "awardBudgetStatusCode": "-1",
      "description": "Queued"
    },
    "awardBudgetTypeCode": "1",
    "awardBudgetType": {
      "awardBudgetTypeCode": "1",
      "description": "New"
    },
    "obligatedTotal": 0,
    "obligatedAmount": 0,
    "description": "New",
    "onOffCampusFlag": "D",
    "endDate": "2018-06-29",
    "startDate": "2015-06-30",
    "totalCost": 682390,
    "totalDirectCost": 0,
    "totalIndirectCost": 0,
    "costSharingAmount": 0,
    "underrecoveryAmount": 0,
    "totalCostLimit": -2000,
    "residualFunds": null,
    "ohRateClassCode": "1",
    "ohRateClass": {
      "code": "1",
      "description": "MTDC"
    },
    "ohRateTypeCode": "1",
    "comments": null,
    "modularBudgetFlag": false,
    "urRateClassCode": "1",
    "totalDirectCostLimit": 0,
    "totalDirectCostInclPrev": 0,
    "totalIndirectCostInclPrev": 0,
    "totalCostInclPrev": 682390,
    "budgetRates": [
      {
        "activityTypeCode": "1",
        "applicableRate": 5,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "1",
        "rateClass": {
          "code": "1",
          "description": "MTDC"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "1",
          "rateTypeCode": "1",
          "description": "MTDC"
        },
        "startDate": "2014-07-01",
        "instituteRate": 5
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 56,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "1",
        "rateClass": {
          "code": "1",
          "description": "MTDC"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "1",
          "rateTypeCode": "1",
          "description": "MTDC"
        },
        "startDate": "2014-07-01",
        "instituteRate": 56
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2007",
        "onOffCampusFlag": false,
        "rateClassCode": "13",
        "rateClass": {
          "code": "13",
          "description": "MTDC - AWARD"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "13",
          "rateTypeCode": "1",
          "description": "MTDC"
        },
        "startDate": "2007-01-07",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 48,
        "fiscalYear": "2007",
        "onOffCampusFlag": true,
        "rateClassCode": "13",
        "rateClass": {
          "code": "13",
          "description": "MTDC - AWARD"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "13",
          "rateTypeCode": "1",
          "description": "MTDC"
        },
        "startDate": "2007-01-07",
        "instituteRate": 48
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2004",
        "onOffCampusFlag": false,
        "rateClassCode": "2",
        "rateClass": {
          "code": "2",
          "description": "TDC"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "2",
          "rateTypeCode": "1",
          "description": "TDC"
        },
        "startDate": "2003-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2004",
        "onOffCampusFlag": true,
        "rateClassCode": "2",
        "rateClass": {
          "code": "2",
          "description": "TDC"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "2",
          "rateTypeCode": "1",
          "description": "TDC"
        },
        "startDate": "2003-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 62,
        "fiscalYear": "1980",
        "onOffCampusFlag": false,
        "rateClassCode": "3",
        "rateClass": {
          "code": "3",
          "description": "S&W"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "3",
          "rateTypeCode": "1",
          "description": "S&W"
        },
        "startDate": "1979-07-01",
        "instituteRate": 62
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 63,
        "fiscalYear": "1980",
        "onOffCampusFlag": true,
        "rateClassCode": "3",
        "rateClass": {
          "code": "3",
          "description": "S&W"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "3",
          "rateTypeCode": "1",
          "description": "S&W"
        },
        "startDate": "1979-07-01",
        "instituteRate": 63
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 5,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "4",
        "rateClass": {
          "code": "4",
          "description": "Fund with Transaction Fee (FUNSN)"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "4",
          "rateTypeCode": "1",
          "description": "Salaries"
        },
        "startDate": "2014-07-01",
        "instituteRate": 5
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 56,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "4",
        "rateClass": {
          "code": "4",
          "description": "Fund with Transaction Fee (FUNSN)"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "4",
          "rateTypeCode": "1",
          "description": "Salaries"
        },
        "startDate": "2014-07-01",
        "instituteRate": 56
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 10,
        "fiscalYear": "2002",
        "onOffCampusFlag": false,
        "rateClassCode": "4",
        "rateClass": {
          "code": "4",
          "description": "Fund with Transaction Fee (FUNSN)"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "4",
          "rateTypeCode": "2",
          "description": "Materials and Services"
        },
        "startDate": "2001-07-01",
        "instituteRate": 10
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 10,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "4",
        "rateClass": {
          "code": "4",
          "description": "Fund with Transaction Fee (FUNSN)"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "4",
          "rateTypeCode": "2",
          "description": "Materials and Services"
        },
        "startDate": "2014-07-01",
        "instituteRate": 10
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 25,
        "fiscalYear": "2006",
        "onOffCampusFlag": false,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "1",
          "description": "Research Rate"
        },
        "startDate": "2005-07-01",
        "instituteRate": 25
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 27,
        "fiscalYear": "2006",
        "onOffCampusFlag": true,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "1",
          "description": "Research Rate"
        },
        "startDate": "2005-07-01",
        "instituteRate": 27
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2004",
        "onOffCampusFlag": false,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "2",
          "description": "UROP Rate"
        },
        "startDate": "2003-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2004",
        "onOffCampusFlag": true,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "2",
          "description": "UROP Rate"
        },
        "startDate": "2003-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 26,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "3",
          "description": "EB on LA"
        },
        "startDate": "2014-07-01",
        "instituteRate": 26
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 24,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "5",
        "rateClass": {
          "code": "5",
          "description": "Employee Benefits"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "5",
          "rateTypeCode": "3",
          "description": "EB on LA"
        },
        "startDate": "2014-07-01",
        "instituteRate": 24
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "1",
          "description": "Faculty Salaries (6/1)"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "2",
          "description": "Administrative Salaries (7/1)"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2015-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2015-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2016-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2016-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2017-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2017-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2018-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "3",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "3",
          "description": "Support Staff Salaries (4/1)"
        },
        "startDate": "2018-01-04",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2015-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2016-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2017-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "4",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "4",
          "description": "Materials and Services"
        },
        "startDate": "2018-01-07",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2015-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2015-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2016-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2016",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2016-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2017-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2017",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2017-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2018-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2018",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "5",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "5",
          "description": "Research Staff (1/1)"
        },
        "startDate": "2018-01-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2011",
        "onOffCampusFlag": false,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "6",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "6",
          "description": "Students (6/1)"
        },
        "startDate": "2011-06-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 3,
        "fiscalYear": "2011",
        "onOffCampusFlag": true,
        "rateClassCode": "7",
        "rateClass": {
          "code": "7",
          "description": "Inflation"
        },
        "rateTypeCode": "6",
        "rateType": {
          "rateClassCode": "7",
          "rateTypeCode": "6",
          "description": "Students (6/1)"
        },
        "startDate": "2011-06-01",
        "instituteRate": 3
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 10.5,
        "fiscalYear": "2006",
        "onOffCampusFlag": false,
        "rateClassCode": "8",
        "rateClass": {
          "code": "8",
          "description": "Vacation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "8",
          "rateTypeCode": "1",
          "description": "Vacation "
        },
        "startDate": "2005-07-01",
        "instituteRate": 10.5
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 9.5,
        "fiscalYear": "2006",
        "onOffCampusFlag": true,
        "rateClassCode": "8",
        "rateClass": {
          "code": "8",
          "description": "Vacation"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "8",
          "rateTypeCode": "1",
          "description": "Vacation "
        },
        "startDate": "2005-07-01",
        "instituteRate": 9.5
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 9,
        "fiscalYear": "2015",
        "onOffCampusFlag": false,
        "rateClassCode": "8",
        "rateClass": {
          "code": "8",
          "description": "Vacation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "8",
          "rateTypeCode": "2",
          "description": "Vacation on LA"
        },
        "startDate": "2014-07-01",
        "instituteRate": 9
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 9,
        "fiscalYear": "2015",
        "onOffCampusFlag": true,
        "rateClassCode": "8",
        "rateClass": {
          "code": "8",
          "description": "Vacation"
        },
        "rateTypeCode": "2",
        "rateType": {
          "rateClassCode": "8",
          "rateTypeCode": "2",
          "description": "Vacation on LA"
        },
        "startDate": "2014-07-01",
        "instituteRate": 9
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2000",
        "onOffCampusFlag": false,
        "rateClassCode": "9",
        "rateClass": {
          "code": "9",
          "description": "Other"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "9",
          "rateTypeCode": "1",
          "description": "Other"
        },
        "startDate": "1999-07-01",
        "instituteRate": 0
      },
      {
        "activityTypeCode": "1",
        "applicableRate": 0,
        "fiscalYear": "2000",
        "onOffCampusFlag": true,
        "rateClassCode": "9",
        "rateClass": {
          "code": "9",
          "description": "Other"
        },
        "rateTypeCode": "1",
        "rateType": {
          "rateClassCode": "9",
          "rateTypeCode": "1",
          "description": "Other"
        },
        "startDate": "1999-07-01",
        "instituteRate": 0
      }
    ],
    "budgetLaRates": [],
    "budgetPeriods": [],
    "awardBudgetLimits": [],
    "budgetPersons": [
      {
        "effectiveDate": "2015-07-01",
        "jobCode": "AA000",
        "nonEmployeeFlag": false,
        "personId": "10000000051",
        "rolodexId": null,
        "appointmentTypeCode": "6",
        "calculationBase": 0,
        "personName": "BEATRIZ BOMAN",
        "salaryAnniversaryDate": null
      }
    ]
  }
]

Get budget based on budget id
GET`/award/api/v2/award-budgets/599`

Get Award Budget

Example URI

GET /award/api/v2/award-budgets/599

URI Parameters

HideShow

budgetId: number (required) Example: 599
Returns the budget associated with the budgetId.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardId": 13163,
  "budgetId": 599,
  "budgetVersionNumber": 5,
  "budgetInitiator": "10000000001",
  "awardBudgetStatusCode": "-1",
  "awardBudgetStatus": {
    "awardBudgetStatusCode": "-1",
    "description": "Queued"
  },
  "awardBudgetTypeCode": "1",
  "awardBudgetType": {
    "awardBudgetTypeCode": "1",
    "description": "New"
  },
  "obligatedTotal": 0,
  "obligatedAmount": 0,
  "description": "New",
  "onOffCampusFlag": "D",
  "endDate": "2018-06-29",
  "startDate": "2015-06-30",
  "totalCost": 682390,
  "totalDirectCost": 0,
  "totalIndirectCost": 0,
  "costSharingAmount": 0,
  "underrecoveryAmount": 0,
  "totalCostLimit": -2000,
  "residualFunds": null,
  "ohRateClassCode": "1",
  "ohRateClass": {
    "code": "1",
    "description": "MTDC"
  },
  "ohRateTypeCode": "1",
  "comments": null,
  "modularBudgetFlag": false,
  "urRateClassCode": "1",
  "totalDirectCostLimit": 0,
  "totalDirectCostInclPrev": 0,
  "totalIndirectCostInclPrev": 0,
  "totalCostInclPrev": 682390,
  "budgetRates": [
    {
      "activityTypeCode": "1",
      "applicableRate": 5,
      "fiscalYear": "2015",
      "onOffCampusFlag": false,
      "rateClassCode": "1",
      "rateClass": {
        "code": "1",
        "description": "MTDC"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "1",
        "rateTypeCode": "1",
        "description": "MTDC"
      },
      "startDate": "2014-07-01",
      "instituteRate": 5
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 56,
      "fiscalYear": "2015",
      "onOffCampusFlag": true,
      "rateClassCode": "1",
      "rateClass": {
        "code": "1",
        "description": "MTDC"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "1",
        "rateTypeCode": "1",
        "description": "MTDC"
      },
      "startDate": "2014-07-01",
      "instituteRate": 56
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 0,
      "fiscalYear": "2007",
      "onOffCampusFlag": false,
      "rateClassCode": "13",
      "rateClass": {
        "code": "13",
        "description": "MTDC - AWARD"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "13",
        "rateTypeCode": "1",
        "description": "MTDC"
      },
      "startDate": "2007-01-07",
      "instituteRate": 0
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 48,
      "fiscalYear": "2007",
      "onOffCampusFlag": true,
      "rateClassCode": "13",
      "rateClass": {
        "code": "13",
        "description": "MTDC - AWARD"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "13",
        "rateTypeCode": "1",
        "description": "MTDC"
      },
      "startDate": "2007-01-07",
      "instituteRate": 48
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 0,
      "fiscalYear": "2004",
      "onOffCampusFlag": false,
      "rateClassCode": "2",
      "rateClass": {
        "code": "2",
        "description": "TDC"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "2",
        "rateTypeCode": "1",
        "description": "TDC"
      },
      "startDate": "2003-07-01",
      "instituteRate": 0
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 0,
      "fiscalYear": "2004",
      "onOffCampusFlag": true,
      "rateClassCode": "2",
      "rateClass": {
        "code": "2",
        "description": "TDC"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "2",
        "rateTypeCode": "1",
        "description": "TDC"
      },
      "startDate": "2003-07-01",
      "instituteRate": 0
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 62,
      "fiscalYear": "1980",
      "onOffCampusFlag": false,
      "rateClassCode": "3",
      "rateClass": {
        "code": "3",
        "description": "S&W"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "3",
        "rateTypeCode": "1",
        "description": "S&W"
      },
      "startDate": "1979-07-01",
      "instituteRate": 62
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 63,
      "fiscalYear": "1980",
      "onOffCampusFlag": true,
      "rateClassCode": "3",
      "rateClass": {
        "code": "3",
        "description": "S&W"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "3",
        "rateTypeCode": "1",
        "description": "S&W"
      },
      "startDate": "1979-07-01",
      "instituteRate": 63
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 5,
      "fiscalYear": "2015",
      "onOffCampusFlag": false,
      "rateClassCode": "4",
      "rateClass": {
        "code": "4",
        "description": "Fund with Transaction Fee (FUNSN)"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "4",
        "rateTypeCode": "1",
        "description": "Salaries"
      },
      "startDate": "2014-07-01",
      "instituteRate": 5
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 56,
      "fiscalYear": "2015",
      "onOffCampusFlag": true,
      "rateClassCode": "4",
      "rateClass": {
        "code": "4",
        "description": "Fund with Transaction Fee (FUNSN)"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "4",
        "rateTypeCode": "1",
        "description": "Salaries"
      },
      "startDate": "2014-07-01",
      "instituteRate": 56
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 10,
      "fiscalYear": "2002",
      "onOffCampusFlag": false,
      "rateClassCode": "4",
      "rateClass": {
        "code": "4",
        "description": "Fund with Transaction Fee (FUNSN)"
      },
      "rateTypeCode": "2",
      "rateType": {
        "rateClassCode": "4",
        "rateTypeCode": "2",
        "description": "Materials and Services"
      },
      "startDate": "2001-07-01",
      "instituteRate": 10
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 10,
      "fiscalYear": "2015",
      "onOffCampusFlag": true,
      "rateClassCode": "4",
      "rateClass": {
        "code": "4",
        "description": "Fund with Transaction Fee (FUNSN)"
      },
      "rateTypeCode": "2",
      "rateType": {
        "rateClassCode": "4",
        "rateTypeCode": "2",
        "description": "Materials and Services"
      },
      "startDate": "2014-07-01",
      "instituteRate": 10
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 25,
      "fiscalYear": "2006",
      "onOffCampusFlag": false,
      "rateClassCode": "5",
      "rateClass": {
        "code": "5",
        "description": "Employee Benefits"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "5",
        "rateTypeCode": "1",
        "description": "Research Rate"
      },
      "startDate": "2005-07-01",
      "instituteRate": 25
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 27,
      "fiscalYear": "2006",
      "onOffCampusFlag": true,
      "rateClassCode": "5",
      "rateClass": {
        "code": "5",
        "description": "Employee Benefits"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "5",
        "rateTypeCode": "1",
        "description": "Research Rate"
      },
      "startDate": "2005-07-01",
      "instituteRate": 27
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 0,
      "fiscalYear": "2004",
      "onOffCampusFlag": false,
      "rateClassCode": "5",
      "rateClass": {
        "code": "5",
        "description": "Employee Benefits"
      },
      "rateTypeCode": "2",
      "rateType": {
        "rateClassCode": "5",
        "rateTypeCode": "2",
        "description": "UROP Rate"
      },
      "startDate": "2003-07-01",
      "instituteRate": 0
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 0,
      "fiscalYear": "2004",
      "onOffCampusFlag": true,
      "rateClassCode": "5",
      "rateClass": {
        "code": "5",
        "description": "Employee Benefits"
      },
      "rateTypeCode": "2",
      "rateType": {
        "rateClassCode": "5",
        "rateTypeCode": "2",
        "description": "UROP Rate"
      },
      "startDate": "2003-07-01",
      "instituteRate": 0
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 26,
      "fiscalYear": "2015",
      "onOffCampusFlag": false,
      "rateClassCode": "5",
      "rateClass": {
        "code": "5",
        "description": "Employee Benefits"
      },
      "rateTypeCode": "3",
      "rateType": {
        "rateClassCode": "5",
        "rateTypeCode": "3",
        "description": "EB on LA"
      },
      "startDate": "2014-07-01",
      "instituteRate": 26
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 24,
      "fiscalYear": "2015",
      "onOffCampusFlag": true,
      "rateClassCode": "5",
      "rateClass": {
        "code": "5",
        "description": "Employee Benefits"
      },
      "rateTypeCode": "3",
      "rateType": {
        "rateClassCode": "5",
        "rateTypeCode": "3",
        "description": "EB on LA"
      },
      "startDate": "2014-07-01",
      "instituteRate": 24
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2015",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "1",
        "description": "Faculty Salaries (6/1)"
      },
      "startDate": "2015-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2015",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "1",
        "description": "Faculty Salaries (6/1)"
      },
      "startDate": "2015-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2016",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "1",
        "description": "Faculty Salaries (6/1)"
      },
      "startDate": "2016-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2016",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "1",
        "description": "Faculty Salaries (6/1)"
      },
      "startDate": "2016-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2017",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "1",
        "description": "Faculty Salaries (6/1)"
      },
      "startDate": "2017-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2017",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "1",
        "description": "Faculty Salaries (6/1)"
      },
      "startDate": "2017-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2018",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "1",
        "description": "Faculty Salaries (6/1)"
      },
      "startDate": "2018-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2018",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "1",
        "description": "Faculty Salaries (6/1)"
      },
      "startDate": "2018-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2015",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "2",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "2",
        "description": "Administrative Salaries (7/1)"
      },
      "startDate": "2015-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2015",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "2",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "2",
        "description": "Administrative Salaries (7/1)"
      },
      "startDate": "2015-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2016",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "2",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "2",
        "description": "Administrative Salaries (7/1)"
      },
      "startDate": "2016-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2016",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "2",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "2",
        "description": "Administrative Salaries (7/1)"
      },
      "startDate": "2016-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2017",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "2",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "2",
        "description": "Administrative Salaries (7/1)"
      },
      "startDate": "2017-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2017",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "2",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "2",
        "description": "Administrative Salaries (7/1)"
      },
      "startDate": "2017-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2018",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "2",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "2",
        "description": "Administrative Salaries (7/1)"
      },
      "startDate": "2018-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2018",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "2",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "2",
        "description": "Administrative Salaries (7/1)"
      },
      "startDate": "2018-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2015",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "3",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "3",
        "description": "Support Staff Salaries (4/1)"
      },
      "startDate": "2015-01-04",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2015",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "3",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "3",
        "description": "Support Staff Salaries (4/1)"
      },
      "startDate": "2015-01-04",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2016",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "3",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "3",
        "description": "Support Staff Salaries (4/1)"
      },
      "startDate": "2016-01-04",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2016",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "3",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "3",
        "description": "Support Staff Salaries (4/1)"
      },
      "startDate": "2016-01-04",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2017",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "3",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "3",
        "description": "Support Staff Salaries (4/1)"
      },
      "startDate": "2017-01-04",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2017",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "3",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "3",
        "description": "Support Staff Salaries (4/1)"
      },
      "startDate": "2017-01-04",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2018",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "3",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "3",
        "description": "Support Staff Salaries (4/1)"
      },
      "startDate": "2018-01-04",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2018",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "3",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "3",
        "description": "Support Staff Salaries (4/1)"
      },
      "startDate": "2018-01-04",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2015",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "4",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "4",
        "description": "Materials and Services"
      },
      "startDate": "2015-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2015",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "4",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "4",
        "description": "Materials and Services"
      },
      "startDate": "2015-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2016",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "4",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "4",
        "description": "Materials and Services"
      },
      "startDate": "2016-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2016",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "4",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "4",
        "description": "Materials and Services"
      },
      "startDate": "2016-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2017",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "4",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "4",
        "description": "Materials and Services"
      },
      "startDate": "2017-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2017",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "4",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "4",
        "description": "Materials and Services"
      },
      "startDate": "2017-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2018",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "4",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "4",
        "description": "Materials and Services"
      },
      "startDate": "2018-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2018",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "4",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "4",
        "description": "Materials and Services"
      },
      "startDate": "2018-01-07",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2015",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "5",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "5",
        "description": "Research Staff (1/1)"
      },
      "startDate": "2015-01-01",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2015",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "5",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "5",
        "description": "Research Staff (1/1)"
      },
      "startDate": "2015-01-01",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2016",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "5",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "5",
        "description": "Research Staff (1/1)"
      },
      "startDate": "2016-01-01",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2016",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "5",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "5",
        "description": "Research Staff (1/1)"
      },
      "startDate": "2016-01-01",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2017",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "5",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "5",
        "description": "Research Staff (1/1)"
      },
      "startDate": "2017-01-01",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2017",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "5",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "5",
        "description": "Research Staff (1/1)"
      },
      "startDate": "2017-01-01",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2018",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "5",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "5",
        "description": "Research Staff (1/1)"
      },
      "startDate": "2018-01-01",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2018",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "5",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "5",
        "description": "Research Staff (1/1)"
      },
      "startDate": "2018-01-01",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2011",
      "onOffCampusFlag": false,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "6",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "6",
        "description": "Students (6/1)"
      },
      "startDate": "2011-06-01",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 3,
      "fiscalYear": "2011",
      "onOffCampusFlag": true,
      "rateClassCode": "7",
      "rateClass": {
        "code": "7",
        "description": "Inflation"
      },
      "rateTypeCode": "6",
      "rateType": {
        "rateClassCode": "7",
        "rateTypeCode": "6",
        "description": "Students (6/1)"
      },
      "startDate": "2011-06-01",
      "instituteRate": 3
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 10.5,
      "fiscalYear": "2006",
      "onOffCampusFlag": false,
      "rateClassCode": "8",
      "rateClass": {
        "code": "8",
        "description": "Vacation"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "8",
        "rateTypeCode": "1",
        "description": "Vacation "
      },
      "startDate": "2005-07-01",
      "instituteRate": 10.5
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 9.5,
      "fiscalYear": "2006",
      "onOffCampusFlag": true,
      "rateClassCode": "8",
      "rateClass": {
        "code": "8",
        "description": "Vacation"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "8",
        "rateTypeCode": "1",
        "description": "Vacation "
      },
      "startDate": "2005-07-01",
      "instituteRate": 9.5
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 9,
      "fiscalYear": "2015",
      "onOffCampusFlag": false,
      "rateClassCode": "8",
      "rateClass": {
        "code": "8",
        "description": "Vacation"
      },
      "rateTypeCode": "2",
      "rateType": {
        "rateClassCode": "8",
        "rateTypeCode": "2",
        "description": "Vacation on LA"
      },
      "startDate": "2014-07-01",
      "instituteRate": 9
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 9,
      "fiscalYear": "2015",
      "onOffCampusFlag": true,
      "rateClassCode": "8",
      "rateClass": {
        "code": "8",
        "description": "Vacation"
      },
      "rateTypeCode": "2",
      "rateType": {
        "rateClassCode": "8",
        "rateTypeCode": "2",
        "description": "Vacation on LA"
      },
      "startDate": "2014-07-01",
      "instituteRate": 9
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 0,
      "fiscalYear": "2000",
      "onOffCampusFlag": false,
      "rateClassCode": "9",
      "rateClass": {
        "code": "9",
        "description": "Other"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "9",
        "rateTypeCode": "1",
        "description": "Other"
      },
      "startDate": "1999-07-01",
      "instituteRate": 0
    },
    {
      "activityTypeCode": "1",
      "applicableRate": 0,
      "fiscalYear": "2000",
      "onOffCampusFlag": true,
      "rateClassCode": "9",
      "rateClass": {
        "code": "9",
        "description": "Other"
      },
      "rateTypeCode": "1",
      "rateType": {
        "rateClassCode": "9",
        "rateTypeCode": "1",
        "description": "Other"
      },
      "startDate": "1999-07-01",
      "instituteRate": 0
    }
  ],
  "budgetLaRates": [],
  "budgetPeriods": [],
  "awardBudgetLimits": [],
  "budgetPersons": [
    {
      "effectiveDate": "2015-07-01",
      "jobCode": "AA000",
      "nonEmployeeFlag": false,
      "personId": "10000000051",
      "rolodexId": null,
      "appointmentTypeCode": "6",
      "calculationBase": 0,
      "personName": "BEATRIZ BOMAN",
      "salaryAnniversaryDate": null
    }
  ]
}

Put Award Budgets
PUT`/award/api/v2/award-budgets/599/general-info/`

PUT Award Budget General Info

Example URI

PUT /award/api/v2/award-budgets/599/general-info/

URI Parameters

HideShow

budgetId: number (required) Example: 599
Operates on the budget associated with the budgetId.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardBudgetStatusCode": "10",
  "awardBudgetTypeCode": "1",
  "obligatedTotal": 1364779.46,
  "obligatedAmount": 0,
  "description": "New",
  "onOffCampusFlag": "D",
  "endDate": "2018-06-30",
  "startDate": "2015-07-01",
  "totalCost": 684389.73,
  "totalDirectCost": 684389.73,
  "totalIndirectCost": 0,
  "costSharingAmount": 0,
  "underrecoveryAmount": 383258.25,
  "totalCostLimit": 684389.73,
  "residualFunds": null,
  "ohRateClassCode": "1",
  "ohRateTypeCode": "1",
  "comments": null,
  "modularBudgetFlag": false,
  "urRateClassCode": "1",
  "totalDirectCostLimit": 0,
  "awardId": 13163,
  "budgetId": 599,
  "budgetVersionNumber": 1,
  "budgetInitiator": "10000000001"
}

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Update Award Budget Status
PUT`/award/api/v2/award-budgets/8/status/`

Set award budget status.

Example URI

PUT /award/api/v2/award-budgets/8/status/

URI Parameters

HideShow

budgetId: number (required) Example: 8

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "statusCode": "12"
}

Response 200

HideShow

Headers

Content-Length: 0

Closeout Report Types ¶

Get Closeout Report Types by Key
GET`/award/api/v1/closeout-report-types/(key)`

Example URI

GET /award/api/v1/closeout-report-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "closeoutReportCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Closeout Report Types
GET`/award/api/v1/closeout-report-types/`

Example URI

GET /award/api/v1/closeout-report-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "closeoutReportCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "closeoutReportCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Closeout Report Types with Filtering
GET`/award/api/v1/closeout-report-types/`

Example URI

GET /award/api/v1/closeout-report-types/

URI Parameters

HideShow

closeoutReportCode: string (optional)
Closeout Report Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "closeoutReportCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "closeoutReportCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Closeout Report Types
GET`/award/api/v1/closeout-report-types/`

Example URI

GET /award/api/v1/closeout-report-types/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "closeoutReportCode",
    "description"
  ],
  "primaryKey": "closeoutReportCode"
}

Get Blueprint API specification for Closeout Report Types
GET`/award/api/v1/closeout-report-types/`

Example URI

GET /award/api/v1/closeout-report-types/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Closeout Report Types.md"
transfer-encoding: chunked

Update Closeout Report Types
PUT`/award/api/v1/closeout-report-types/(key)`

Example URI

PUT /award/api/v1/closeout-report-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "closeoutReportCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Closeout Report Types
PUT`/award/api/v1/closeout-report-types/`

Example URI

PUT /award/api/v1/closeout-report-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "closeoutReportCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "closeoutReportCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Closeout Report Types
PATCH`/award/api/v1/closeout-report-types/(key)`

Example URI

PATCH /award/api/v1/closeout-report-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "closeoutReportCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "closeoutReportCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Closeout Report Types
POST`/award/api/v1/closeout-report-types/`

Example URI

POST /award/api/v1/closeout-report-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "closeoutReportCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "closeoutReportCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Closeout Report Types
POST`/award/api/v1/closeout-report-types/`

Example URI

POST /award/api/v1/closeout-report-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "closeoutReportCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "closeoutReportCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "closeoutReportCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "closeoutReportCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Closeout Report Types by Key
DELETE`/award/api/v1/closeout-report-types/(key)`

Example URI

DELETE /award/api/v1/closeout-report-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Closeout Report Types
DELETE`/award/api/v1/closeout-report-types/`

Example URI

DELETE /award/api/v1/closeout-report-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Closeout Report Types with Matching
DELETE`/award/api/v1/closeout-report-types/`

Example URI

DELETE /award/api/v1/closeout-report-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
closeoutReportCode: string (optional)
Closeout Report Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Contact Types ¶

Get Contact Types by Key
GET`/award/api/v1/contact-types/(key)`

Example URI

GET /award/api/v1/contact-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "contactTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Contact Types
GET`/award/api/v1/contact-types/`

Example URI

GET /award/api/v1/contact-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "contactTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "contactTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Contact Types with Filtering
GET`/award/api/v1/contact-types/`

Example URI

GET /award/api/v1/contact-types/

URI Parameters

HideShow

contactTypeCode: string (optional)
Contact Type Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "contactTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "contactTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Contact Types
GET`/award/api/v1/contact-types/`

Example URI

GET /award/api/v1/contact-types/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "contactTypeCode",
    "description"
  ],
  "primaryKey": "contactTypeCode"
}

Get Blueprint API specification for Contact Types
GET`/award/api/v1/contact-types/`

Example URI

GET /award/api/v1/contact-types/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Contact Types.md"
transfer-encoding: chunked

Update Contact Types
PUT`/award/api/v1/contact-types/(key)`

Example URI

PUT /award/api/v1/contact-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "contactTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Contact Types
PUT`/award/api/v1/contact-types/`

Example URI

PUT /award/api/v1/contact-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "contactTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "contactTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Contact Types
PATCH`/award/api/v1/contact-types/(key)`

Example URI

PATCH /award/api/v1/contact-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "contactTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "contactTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Contact Types
POST`/award/api/v1/contact-types/`

Example URI

POST /award/api/v1/contact-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "contactTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "contactTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Contact Types
POST`/award/api/v1/contact-types/`

Example URI

POST /award/api/v1/contact-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "contactTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "contactTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "contactTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "contactTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Contact Types by Key
DELETE`/award/api/v1/contact-types/(key)`

Example URI

DELETE /award/api/v1/contact-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Contact Types
DELETE`/award/api/v1/contact-types/`

Example URI

DELETE /award/api/v1/contact-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Contact Types with Matching
DELETE`/award/api/v1/contact-types/`

Example URI

DELETE /award/api/v1/contact-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
contactTypeCode: string (optional)
Contact Type Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Contact Usages ¶

Get Contact Usages by Key
GET`/award/api/v1/contact-usages/(key)`

Example URI

GET /award/api/v1/contact-usages/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "contactUsageId": "(val)",
  "contactTypeCode": "(val)",
  "moduleCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Contact Usages
GET`/award/api/v1/contact-usages/`

Example URI

GET /award/api/v1/contact-usages/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "contactUsageId": "(val)",
    "contactTypeCode": "(val)",
    "moduleCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "contactUsageId": "(val)",
    "contactTypeCode": "(val)",
    "moduleCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Contact Usages with Filtering
GET`/award/api/v1/contact-usages/`

Example URI

GET /award/api/v1/contact-usages/

URI Parameters

HideShow

contactUsageId: string (optional)
Contact Usage Id. Maximum length is 12.
contactTypeCode: string (optional)
Contact Type Code. Maximum length is 3.
moduleCode: string (optional)
Module Code. Maximum length is 3.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "contactUsageId": "(val)",
    "contactTypeCode": "(val)",
    "moduleCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "contactUsageId": "(val)",
    "contactTypeCode": "(val)",
    "moduleCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Contact Usages
GET`/award/api/v1/contact-usages/`

Example URI

GET /award/api/v1/contact-usages/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "contactUsageId",
    "contactTypeCode",
    "moduleCode"
  ],
  "primaryKey": "contactTypeCode:contactUsageId:moduleCode"
}

Get Blueprint API specification for Contact Usages
GET`/award/api/v1/contact-usages/`

Example URI

GET /award/api/v1/contact-usages/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Contact Usages.md"
transfer-encoding: chunked

Update Contact Usages
PUT`/award/api/v1/contact-usages/(key)`

Example URI

PUT /award/api/v1/contact-usages/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "contactUsageId": "(val)",
  "contactTypeCode": "(val)",
  "moduleCode": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Contact Usages
PUT`/award/api/v1/contact-usages/`

Example URI

PUT /award/api/v1/contact-usages/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "contactUsageId": "(val)",
    "contactTypeCode": "(val)",
    "moduleCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "contactUsageId": "(val)",
    "contactTypeCode": "(val)",
    "moduleCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Contact Usages
PATCH`/award/api/v1/contact-usages/(key)`

Example URI

PATCH /award/api/v1/contact-usages/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "contactUsageId": "(val)",
  "contactTypeCode": "(val)",
  "moduleCode": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "contactUsageId": "(val)",
  "contactTypeCode": "(val)",
  "moduleCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Contact Usages
POST`/award/api/v1/contact-usages/`

Example URI

POST /award/api/v1/contact-usages/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "contactUsageId": "(val)",
  "contactTypeCode": "(val)",
  "moduleCode": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "contactUsageId": "(val)",
  "contactTypeCode": "(val)",
  "moduleCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Contact Usages
POST`/award/api/v1/contact-usages/`

Example URI

POST /award/api/v1/contact-usages/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "contactUsageId": "(val)",
    "contactTypeCode": "(val)",
    "moduleCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "contactUsageId": "(val)",
    "contactTypeCode": "(val)",
    "moduleCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "contactUsageId": "(val)",
    "contactTypeCode": "(val)",
    "moduleCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "contactUsageId": "(val)",
    "contactTypeCode": "(val)",
    "moduleCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Contact Usages by Key
DELETE`/award/api/v1/contact-usages/(key)`

Example URI

DELETE /award/api/v1/contact-usages/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Contact Usages
DELETE`/award/api/v1/contact-usages/`

Example URI

DELETE /award/api/v1/contact-usages/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Contact Usages with Matching
DELETE`/award/api/v1/contact-usages/`

Example URI

DELETE /award/api/v1/contact-usages/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
contactUsageId: string (optional)
Contact Usage Id. Maximum length is 12.
contactTypeCode: string (optional)
Contact Type Code. Maximum length is 3.
moduleCode: string (optional)
Module Code. Maximum length is 3.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Distributions ¶

Get Distributions by Key
GET`/award/api/v1/distributions/(key)`

Example URI

GET /award/api/v1/distributions/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "ospDistributionCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Distributions
GET`/award/api/v1/distributions/`

Example URI

GET /award/api/v1/distributions/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "ospDistributionCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ospDistributionCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Distributions with Filtering
GET`/award/api/v1/distributions/`

Example URI

GET /award/api/v1/distributions/

URI Parameters

HideShow

ospDistributionCode: string (optional)
OSP File Copy Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.
active: string (optional)
Active. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "ospDistributionCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ospDistributionCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Distributions
GET`/award/api/v1/distributions/`

Example URI

GET /award/api/v1/distributions/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "ospDistributionCode",
    "description",
    "active"
  ],
  "primaryKey": "ospDistributionCode"
}

Get Blueprint API specification for Distributions
GET`/award/api/v1/distributions/`

Example URI

GET /award/api/v1/distributions/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Distributions.md"
transfer-encoding: chunked

Update Distributions
PUT`/award/api/v1/distributions/(key)`

Example URI

PUT /award/api/v1/distributions/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "ospDistributionCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Distributions
PUT`/award/api/v1/distributions/`

Example URI

PUT /award/api/v1/distributions/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "ospDistributionCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ospDistributionCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Distributions
PATCH`/award/api/v1/distributions/(key)`

Example URI

PATCH /award/api/v1/distributions/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "ospDistributionCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "ospDistributionCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Distributions
POST`/award/api/v1/distributions/`

Example URI

POST /award/api/v1/distributions/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "ospDistributionCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "ospDistributionCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Distributions
POST`/award/api/v1/distributions/`

Example URI

POST /award/api/v1/distributions/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "ospDistributionCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ospDistributionCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "ospDistributionCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ospDistributionCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Distributions by Key
DELETE`/award/api/v1/distributions/(key)`

Example URI

DELETE /award/api/v1/distributions/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Distributions
DELETE`/award/api/v1/distributions/`

Example URI

DELETE /award/api/v1/distributions/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Distributions with Matching
DELETE`/award/api/v1/distributions/`

Example URI

DELETE /award/api/v1/distributions/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
ospDistributionCode: string (optional)
OSP File Copy Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.
active: string (optional)
Active. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Fanda Rate Types ¶

Get Fanda Rate Types by Key
GET`/award/api/v1/fanda-rate-types/(key)`

Example URI

GET /award/api/v1/fanda-rate-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "fandaRateTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Fanda Rate Types
GET`/award/api/v1/fanda-rate-types/`

Example URI

GET /award/api/v1/fanda-rate-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "fandaRateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "fandaRateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Fanda Rate Types with Filtering
GET`/award/api/v1/fanda-rate-types/`

Example URI

GET /award/api/v1/fanda-rate-types/

URI Parameters

HideShow

fandaRateTypeCode: string (optional)
F&A Rate Type Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "fandaRateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "fandaRateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Fanda Rate Types
GET`/award/api/v1/fanda-rate-types/`

Example URI

GET /award/api/v1/fanda-rate-types/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "fandaRateTypeCode",
    "description"
  ],
  "primaryKey": "fandaRateTypeCode"
}

Get Blueprint API specification for Fanda Rate Types
GET`/award/api/v1/fanda-rate-types/`

Example URI

GET /award/api/v1/fanda-rate-types/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Fanda Rate Types.md"
transfer-encoding: chunked

Update Fanda Rate Types
PUT`/award/api/v1/fanda-rate-types/(key)`

Example URI

PUT /award/api/v1/fanda-rate-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "fandaRateTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Fanda Rate Types
PUT`/award/api/v1/fanda-rate-types/`

Example URI

PUT /award/api/v1/fanda-rate-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "fandaRateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "fandaRateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Fanda Rate Types
PATCH`/award/api/v1/fanda-rate-types/(key)`

Example URI

PATCH /award/api/v1/fanda-rate-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "fandaRateTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "fandaRateTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Fanda Rate Types
POST`/award/api/v1/fanda-rate-types/`

Example URI

POST /award/api/v1/fanda-rate-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "fandaRateTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "fandaRateTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Fanda Rate Types
POST`/award/api/v1/fanda-rate-types/`

Example URI

POST /award/api/v1/fanda-rate-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "fandaRateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "fandaRateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "fandaRateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "fandaRateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Fanda Rate Types by Key
DELETE`/award/api/v1/fanda-rate-types/(key)`

Example URI

DELETE /award/api/v1/fanda-rate-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Fanda Rate Types
DELETE`/award/api/v1/fanda-rate-types/`

Example URI

DELETE /award/api/v1/fanda-rate-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Fanda Rate Types with Matching
DELETE`/award/api/v1/fanda-rate-types/`

Example URI

DELETE /award/api/v1/fanda-rate-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
fandaRateTypeCode: string (optional)
F&A Rate Type Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Financial Indirect Cost Recovery Type Codes ¶

Get Financial Indirect Cost Recovery Type Codes by Key
GET`/award/api/v1/financial-indirect-cost-recovery-type-codes/(key)`

Example URI

GET /award/api/v1/financial-indirect-cost-recovery-type-codes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "icrTypeCode": "(val)",
  "rateClassCode": "(val)",
  "rateTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Financial Indirect Cost Recovery Type Codes
GET`/award/api/v1/financial-indirect-cost-recovery-type-codes/`

Example URI

GET /award/api/v1/financial-indirect-cost-recovery-type-codes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "icrTypeCode": "(val)",
    "rateClassCode": "(val)",
    "rateTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "icrTypeCode": "(val)",
    "rateClassCode": "(val)",
    "rateTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Financial Indirect Cost Recovery Type Codes with Filtering
GET`/award/api/v1/financial-indirect-cost-recovery-type-codes/`

Example URI

GET /award/api/v1/financial-indirect-cost-recovery-type-codes/

URI Parameters

HideShow

icrTypeCode: string (optional)
Icr Type Code. Maximum length is 8.
rateClassCode: string (optional)
Rate Class Code. Maximum length is 3.
rateTypeCode: string (optional)
Rate Type Code. Maximum length is 3.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "icrTypeCode": "(val)",
    "rateClassCode": "(val)",
    "rateTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "icrTypeCode": "(val)",
    "rateClassCode": "(val)",
    "rateTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Financial Indirect Cost Recovery Type Codes
GET`/award/api/v1/financial-indirect-cost-recovery-type-codes/`

Example URI

GET /award/api/v1/financial-indirect-cost-recovery-type-codes/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "icrTypeCode",
    "rateClassCode",
    "rateTypeCode"
  ],
  "primaryKey": "rateClassCode:rateTypeCode"
}

Get Blueprint API specification for Financial Indirect Cost Recovery Type Codes
GET`/award/api/v1/financial-indirect-cost-recovery-type-codes/`

Example URI

GET /award/api/v1/financial-indirect-cost-recovery-type-codes/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Financial Indirect Cost Recovery Type Codes.md"
transfer-encoding: chunked

Update Financial Indirect Cost Recovery Type Codes
PUT`/award/api/v1/financial-indirect-cost-recovery-type-codes/(key)`

Example URI

PUT /award/api/v1/financial-indirect-cost-recovery-type-codes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "icrTypeCode": "(val)",
  "rateClassCode": "(val)",
  "rateTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Financial Indirect Cost Recovery Type Codes
PUT`/award/api/v1/financial-indirect-cost-recovery-type-codes/`

Example URI

PUT /award/api/v1/financial-indirect-cost-recovery-type-codes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "icrTypeCode": "(val)",
    "rateClassCode": "(val)",
    "rateTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "icrTypeCode": "(val)",
    "rateClassCode": "(val)",
    "rateTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Financial Indirect Cost Recovery Type Codes
PATCH`/award/api/v1/financial-indirect-cost-recovery-type-codes/(key)`

Example URI

PATCH /award/api/v1/financial-indirect-cost-recovery-type-codes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "icrTypeCode": "(val)",
  "rateClassCode": "(val)",
  "rateTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "icrTypeCode": "(val)",
  "rateClassCode": "(val)",
  "rateTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Financial Indirect Cost Recovery Type Codes
POST`/award/api/v1/financial-indirect-cost-recovery-type-codes/`

Example URI

POST /award/api/v1/financial-indirect-cost-recovery-type-codes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "icrTypeCode": "(val)",
  "rateClassCode": "(val)",
  "rateTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "icrTypeCode": "(val)",
  "rateClassCode": "(val)",
  "rateTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Financial Indirect Cost Recovery Type Codes
POST`/award/api/v1/financial-indirect-cost-recovery-type-codes/`

Example URI

POST /award/api/v1/financial-indirect-cost-recovery-type-codes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "icrTypeCode": "(val)",
    "rateClassCode": "(val)",
    "rateTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "icrTypeCode": "(val)",
    "rateClassCode": "(val)",
    "rateTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "icrTypeCode": "(val)",
    "rateClassCode": "(val)",
    "rateTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "icrTypeCode": "(val)",
    "rateClassCode": "(val)",
    "rateTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Financial Indirect Cost Recovery Type Codes by Key
DELETE`/award/api/v1/financial-indirect-cost-recovery-type-codes/(key)`

Example URI

DELETE /award/api/v1/financial-indirect-cost-recovery-type-codes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Financial Indirect Cost Recovery Type Codes
DELETE`/award/api/v1/financial-indirect-cost-recovery-type-codes/`

Example URI

DELETE /award/api/v1/financial-indirect-cost-recovery-type-codes/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Financial Indirect Cost Recovery Type Codes with Matching
DELETE`/award/api/v1/financial-indirect-cost-recovery-type-codes/`

Example URI

DELETE /award/api/v1/financial-indirect-cost-recovery-type-codes/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
icrTypeCode: string (optional)
Icr Type Code. Maximum length is 8.
rateClassCode: string (optional)
Rate Class Code. Maximum length is 3.
rateTypeCode: string (optional)
Rate Type Code. Maximum length is 3.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Frequencies ¶

Get Frequencies by Key
GET`/award/api/v1/frequencies/(key)`

Example URI

GET /award/api/v1/frequencies/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "frequencyCode": "(val)",
  "description": "(val)",
  "numberOfDays": "(val)",
  "numberOfMonths": "(val)",
  "repeatFlag": "(val)",
  "advanceNumberOfDays": "(val)",
  "advanceNumberOfMonths": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Frequencies
GET`/award/api/v1/frequencies/`

Example URI

GET /award/api/v1/frequencies/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "frequencyCode": "(val)",
    "description": "(val)",
    "numberOfDays": "(val)",
    "numberOfMonths": "(val)",
    "repeatFlag": "(val)",
    "advanceNumberOfDays": "(val)",
    "advanceNumberOfMonths": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "frequencyCode": "(val)",
    "description": "(val)",
    "numberOfDays": "(val)",
    "numberOfMonths": "(val)",
    "repeatFlag": "(val)",
    "advanceNumberOfDays": "(val)",
    "advanceNumberOfMonths": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Frequencies with Filtering
GET`/award/api/v1/frequencies/`

Example URI

GET /award/api/v1/frequencies/

URI Parameters

HideShow

frequencyCode: string (optional)
Frequency Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.
numberOfDays: string (optional)
Number Of Days. Maximum length is 22.
numberOfMonths: string (optional)
Number Of Months. Maximum length is 22.
repeatFlag: string (optional)
Repeat Flag. Maximum length is 1.
advanceNumberOfDays: string (optional)
Advance Number Of Days. Maximum length is 22.
advanceNumberOfMonths: string (optional)
Advance Number Of Months. Maximum length is 22.
active: string (optional)
Active. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "frequencyCode": "(val)",
    "description": "(val)",
    "numberOfDays": "(val)",
    "numberOfMonths": "(val)",
    "repeatFlag": "(val)",
    "advanceNumberOfDays": "(val)",
    "advanceNumberOfMonths": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "frequencyCode": "(val)",
    "description": "(val)",
    "numberOfDays": "(val)",
    "numberOfMonths": "(val)",
    "repeatFlag": "(val)",
    "advanceNumberOfDays": "(val)",
    "advanceNumberOfMonths": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Frequencies
GET`/award/api/v1/frequencies/`

Example URI

GET /award/api/v1/frequencies/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "frequencyCode",
    "description",
    "numberOfDays",
    "numberOfMonths",
    "repeatFlag",
    "advanceNumberOfDays",
    "advanceNumberOfMonths",
    "active"
  ],
  "primaryKey": "frequencyCode"
}

Get Blueprint API specification for Frequencies
GET`/award/api/v1/frequencies/`

Example URI

GET /award/api/v1/frequencies/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Frequencies.md"
transfer-encoding: chunked

Update Frequencies
PUT`/award/api/v1/frequencies/(key)`

Example URI

PUT /award/api/v1/frequencies/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "frequencyCode": "(val)",
  "description": "(val)",
  "numberOfDays": "(val)",
  "numberOfMonths": "(val)",
  "repeatFlag": "(val)",
  "advanceNumberOfDays": "(val)",
  "advanceNumberOfMonths": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Frequencies
PUT`/award/api/v1/frequencies/`

Example URI

PUT /award/api/v1/frequencies/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "frequencyCode": "(val)",
    "description": "(val)",
    "numberOfDays": "(val)",
    "numberOfMonths": "(val)",
    "repeatFlag": "(val)",
    "advanceNumberOfDays": "(val)",
    "advanceNumberOfMonths": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "frequencyCode": "(val)",
    "description": "(val)",
    "numberOfDays": "(val)",
    "numberOfMonths": "(val)",
    "repeatFlag": "(val)",
    "advanceNumberOfDays": "(val)",
    "advanceNumberOfMonths": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Frequencies
PATCH`/award/api/v1/frequencies/(key)`

Example URI

PATCH /award/api/v1/frequencies/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "frequencyCode": "(val)",
  "description": "(val)",
  "numberOfDays": "(val)",
  "numberOfMonths": "(val)",
  "repeatFlag": "(val)",
  "advanceNumberOfDays": "(val)",
  "advanceNumberOfMonths": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "frequencyCode": "(val)",
  "description": "(val)",
  "numberOfDays": "(val)",
  "numberOfMonths": "(val)",
  "repeatFlag": "(val)",
  "advanceNumberOfDays": "(val)",
  "advanceNumberOfMonths": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Frequencies
POST`/award/api/v1/frequencies/`

Example URI

POST /award/api/v1/frequencies/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "frequencyCode": "(val)",
  "description": "(val)",
  "numberOfDays": "(val)",
  "numberOfMonths": "(val)",
  "repeatFlag": "(val)",
  "advanceNumberOfDays": "(val)",
  "advanceNumberOfMonths": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "frequencyCode": "(val)",
  "description": "(val)",
  "numberOfDays": "(val)",
  "numberOfMonths": "(val)",
  "repeatFlag": "(val)",
  "advanceNumberOfDays": "(val)",
  "advanceNumberOfMonths": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Frequencies
POST`/award/api/v1/frequencies/`

Example URI

POST /award/api/v1/frequencies/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "frequencyCode": "(val)",
    "description": "(val)",
    "numberOfDays": "(val)",
    "numberOfMonths": "(val)",
    "repeatFlag": "(val)",
    "advanceNumberOfDays": "(val)",
    "advanceNumberOfMonths": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "frequencyCode": "(val)",
    "description": "(val)",
    "numberOfDays": "(val)",
    "numberOfMonths": "(val)",
    "repeatFlag": "(val)",
    "advanceNumberOfDays": "(val)",
    "advanceNumberOfMonths": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "frequencyCode": "(val)",
    "description": "(val)",
    "numberOfDays": "(val)",
    "numberOfMonths": "(val)",
    "repeatFlag": "(val)",
    "advanceNumberOfDays": "(val)",
    "advanceNumberOfMonths": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "frequencyCode": "(val)",
    "description": "(val)",
    "numberOfDays": "(val)",
    "numberOfMonths": "(val)",
    "repeatFlag": "(val)",
    "advanceNumberOfDays": "(val)",
    "advanceNumberOfMonths": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Frequencies by Key
DELETE`/award/api/v1/frequencies/(key)`

Example URI

DELETE /award/api/v1/frequencies/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Frequencies
DELETE`/award/api/v1/frequencies/`

Example URI

DELETE /award/api/v1/frequencies/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Frequencies with Matching
DELETE`/award/api/v1/frequencies/`

Example URI

DELETE /award/api/v1/frequencies/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
frequencyCode: string (optional)
Frequency Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.
numberOfDays: string (optional)
Number Of Days. Maximum length is 22.
numberOfMonths: string (optional)
Number Of Months. Maximum length is 22.
repeatFlag: string (optional)
Repeat Flag. Maximum length is 1.
advanceNumberOfDays: string (optional)
Advance Number Of Days. Maximum length is 22.
advanceNumberOfMonths: string (optional)
Advance Number Of Months. Maximum length is 22.
active: string (optional)
Active. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Frequency Bases ¶

Get Frequency Bases by Key
GET`/award/api/v1/frequency-bases/(key)`

Example URI

GET /award/api/v1/frequency-bases/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "frequencyBaseCode": "(val)",
  "description": "(val)",
  "regenerationTypeName": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Frequency Bases
GET`/award/api/v1/frequency-bases/`

Example URI

GET /award/api/v1/frequency-bases/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "frequencyBaseCode": "(val)",
    "description": "(val)",
    "regenerationTypeName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "frequencyBaseCode": "(val)",
    "description": "(val)",
    "regenerationTypeName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Frequency Bases with Filtering
GET`/award/api/v1/frequency-bases/`

Example URI

GET /award/api/v1/frequency-bases/

URI Parameters

HideShow

frequencyBaseCode: string (optional)
Frequency Base Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.
regenerationTypeName: string (optional)
Regeneration Policy. Maximum length is 200.
active: string (optional)
Active. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "frequencyBaseCode": "(val)",
    "description": "(val)",
    "regenerationTypeName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "frequencyBaseCode": "(val)",
    "description": "(val)",
    "regenerationTypeName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Frequency Bases
GET`/award/api/v1/frequency-bases/`

Example URI

GET /award/api/v1/frequency-bases/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "frequencyBaseCode",
    "description",
    "regenerationTypeName",
    "active"
  ],
  "primaryKey": "frequencyBaseCode"
}

Get Blueprint API specification for Frequency Bases
GET`/award/api/v1/frequency-bases/`

Example URI

GET /award/api/v1/frequency-bases/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Frequency Bases.md"
transfer-encoding: chunked

Update Frequency Bases
PUT`/award/api/v1/frequency-bases/(key)`

Example URI

PUT /award/api/v1/frequency-bases/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "frequencyBaseCode": "(val)",
  "description": "(val)",
  "regenerationTypeName": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Frequency Bases
PUT`/award/api/v1/frequency-bases/`

Example URI

PUT /award/api/v1/frequency-bases/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "frequencyBaseCode": "(val)",
    "description": "(val)",
    "regenerationTypeName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "frequencyBaseCode": "(val)",
    "description": "(val)",
    "regenerationTypeName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Frequency Bases
PATCH`/award/api/v1/frequency-bases/(key)`

Example URI

PATCH /award/api/v1/frequency-bases/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "frequencyBaseCode": "(val)",
  "description": "(val)",
  "regenerationTypeName": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "frequencyBaseCode": "(val)",
  "description": "(val)",
  "regenerationTypeName": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Frequency Bases
POST`/award/api/v1/frequency-bases/`

Example URI

POST /award/api/v1/frequency-bases/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "frequencyBaseCode": "(val)",
  "description": "(val)",
  "regenerationTypeName": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "frequencyBaseCode": "(val)",
  "description": "(val)",
  "regenerationTypeName": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Frequency Bases
POST`/award/api/v1/frequency-bases/`

Example URI

POST /award/api/v1/frequency-bases/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "frequencyBaseCode": "(val)",
    "description": "(val)",
    "regenerationTypeName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "frequencyBaseCode": "(val)",
    "description": "(val)",
    "regenerationTypeName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "frequencyBaseCode": "(val)",
    "description": "(val)",
    "regenerationTypeName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "frequencyBaseCode": "(val)",
    "description": "(val)",
    "regenerationTypeName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Frequency Bases by Key
DELETE`/award/api/v1/frequency-bases/(key)`

Example URI

DELETE /award/api/v1/frequency-bases/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Frequency Bases
DELETE`/award/api/v1/frequency-bases/`

Example URI

DELETE /award/api/v1/frequency-bases/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Frequency Bases with Matching
DELETE`/award/api/v1/frequency-bases/`

Example URI

DELETE /award/api/v1/frequency-bases/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
frequencyBaseCode: string (optional)
Frequency Base Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.
regenerationTypeName: string (optional)
Regeneration Policy. Maximum length is 200.
active: string (optional)
Active. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Pending Transactions ¶

Get Pending Transactions by Key
GET`/award/api/v1/pending-transactions/(key)`

Example URI

GET /award/api/v1/pending-transactions/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "transactionId": "(val)",
  "documentNumber": "(val)",
  "sourceAwardNumber": "(val)",
  "destinationAwardNumber": "(val)",
  "obligatedAmount": "(val)",
  "obligatedDirectAmount": "(val)",
  "obligatedIndirectAmount": "(val)",
  "anticipatedAmount": "(val)",
  "anticipatedDirectAmount": "(val)",
  "anticipatedIndirectAmount": "(val)",
  "comments": "(val)",
  "processedFlag": "(val)",
  "singleNodeTransaction": "(val)",
  "_primaryKey": "(val)"
}

Get All Pending Transactions
GET`/award/api/v1/pending-transactions/`

Example URI

GET /award/api/v1/pending-transactions/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "transactionId": "(val)",
    "documentNumber": "(val)",
    "sourceAwardNumber": "(val)",
    "destinationAwardNumber": "(val)",
    "obligatedAmount": "(val)",
    "obligatedDirectAmount": "(val)",
    "obligatedIndirectAmount": "(val)",
    "anticipatedAmount": "(val)",
    "anticipatedDirectAmount": "(val)",
    "anticipatedIndirectAmount": "(val)",
    "comments": "(val)",
    "processedFlag": "(val)",
    "singleNodeTransaction": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "transactionId": "(val)",
    "documentNumber": "(val)",
    "sourceAwardNumber": "(val)",
    "destinationAwardNumber": "(val)",
    "obligatedAmount": "(val)",
    "obligatedDirectAmount": "(val)",
    "obligatedIndirectAmount": "(val)",
    "anticipatedAmount": "(val)",
    "anticipatedDirectAmount": "(val)",
    "anticipatedIndirectAmount": "(val)",
    "comments": "(val)",
    "processedFlag": "(val)",
    "singleNodeTransaction": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Pending Transactions with Filtering
GET`/award/api/v1/pending-transactions/`

Example URI

GET /award/api/v1/pending-transactions/

URI Parameters

HideShow

transactionId: string (optional)
Transaction. Maximum length is 22.
documentNumber: string (optional)
sourceAwardNumber: string (optional)
Source Award. Maximum length is 12.
destinationAwardNumber: string (optional)
Destination Award. Maximum length is 12.
obligatedAmount: string (optional)
Obligated Change. Maximum length is 22.
obligatedDirectAmount: string (optional)
Obligated Direct. Maximum length is 22.
obligatedIndirectAmount: string (optional)
Obligated F&A Change. Maximum length is 22.
anticipatedAmount: string (optional)
Anticipated Change. Maximum length is 22.
anticipatedDirectAmount: string (optional)
Anticipated Direct Change. Maximum length is 22.
anticipatedIndirectAmount: string (optional)
Anticipated F&A Change. Maximum length is 22.
comments: string (optional)
Comments. Maximum length is 200.
processedFlag: string (optional)
Processed Flag. Maximum length is 1.
singleNodeTransaction: string (optional)
Single Node Transaction. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "transactionId": "(val)",
    "documentNumber": "(val)",
    "sourceAwardNumber": "(val)",
    "destinationAwardNumber": "(val)",
    "obligatedAmount": "(val)",
    "obligatedDirectAmount": "(val)",
    "obligatedIndirectAmount": "(val)",
    "anticipatedAmount": "(val)",
    "anticipatedDirectAmount": "(val)",
    "anticipatedIndirectAmount": "(val)",
    "comments": "(val)",
    "processedFlag": "(val)",
    "singleNodeTransaction": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "transactionId": "(val)",
    "documentNumber": "(val)",
    "sourceAwardNumber": "(val)",
    "destinationAwardNumber": "(val)",
    "obligatedAmount": "(val)",
    "obligatedDirectAmount": "(val)",
    "obligatedIndirectAmount": "(val)",
    "anticipatedAmount": "(val)",
    "anticipatedDirectAmount": "(val)",
    "anticipatedIndirectAmount": "(val)",
    "comments": "(val)",
    "processedFlag": "(val)",
    "singleNodeTransaction": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Pending Transactions
GET`/award/api/v1/pending-transactions/`

Example URI

GET /award/api/v1/pending-transactions/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "transactionId",
    "documentNumber",
    "sourceAwardNumber",
    "destinationAwardNumber",
    "obligatedAmount",
    "obligatedDirectAmount",
    "obligatedIndirectAmount",
    "anticipatedAmount",
    "anticipatedDirectAmount",
    "anticipatedIndirectAmount",
    "comments",
    "processedFlag",
    "singleNodeTransaction"
  ],
  "primaryKey": "transactionId"
}

Get Blueprint API specification for Pending Transactions
GET`/award/api/v1/pending-transactions/`

Example URI

GET /award/api/v1/pending-transactions/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Pending Transactions.md"
transfer-encoding: chunked

Update Pending Transactions
PUT`/award/api/v1/pending-transactions/(key)`

Example URI

PUT /award/api/v1/pending-transactions/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "transactionId": "(val)",
  "documentNumber": "(val)",
  "sourceAwardNumber": "(val)",
  "destinationAwardNumber": "(val)",
  "obligatedAmount": "(val)",
  "obligatedDirectAmount": "(val)",
  "obligatedIndirectAmount": "(val)",
  "anticipatedAmount": "(val)",
  "anticipatedDirectAmount": "(val)",
  "anticipatedIndirectAmount": "(val)",
  "comments": "(val)",
  "processedFlag": "(val)",
  "singleNodeTransaction": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Pending Transactions
PUT`/award/api/v1/pending-transactions/`

Example URI

PUT /award/api/v1/pending-transactions/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "transactionId": "(val)",
    "documentNumber": "(val)",
    "sourceAwardNumber": "(val)",
    "destinationAwardNumber": "(val)",
    "obligatedAmount": "(val)",
    "obligatedDirectAmount": "(val)",
    "obligatedIndirectAmount": "(val)",
    "anticipatedAmount": "(val)",
    "anticipatedDirectAmount": "(val)",
    "anticipatedIndirectAmount": "(val)",
    "comments": "(val)",
    "processedFlag": "(val)",
    "singleNodeTransaction": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "transactionId": "(val)",
    "documentNumber": "(val)",
    "sourceAwardNumber": "(val)",
    "destinationAwardNumber": "(val)",
    "obligatedAmount": "(val)",
    "obligatedDirectAmount": "(val)",
    "obligatedIndirectAmount": "(val)",
    "anticipatedAmount": "(val)",
    "anticipatedDirectAmount": "(val)",
    "anticipatedIndirectAmount": "(val)",
    "comments": "(val)",
    "processedFlag": "(val)",
    "singleNodeTransaction": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Pending Transactions
PATCH`/award/api/v1/pending-transactions/(key)`

Example URI

PATCH /award/api/v1/pending-transactions/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "transactionId": "(val)",
  "documentNumber": "(val)",
  "sourceAwardNumber": "(val)",
  "destinationAwardNumber": "(val)",
  "obligatedAmount": "(val)",
  "obligatedDirectAmount": "(val)",
  "obligatedIndirectAmount": "(val)",
  "anticipatedAmount": "(val)",
  "anticipatedDirectAmount": "(val)",
  "anticipatedIndirectAmount": "(val)",
  "comments": "(val)",
  "processedFlag": "(val)",
  "singleNodeTransaction": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "transactionId": "(val)",
  "documentNumber": "(val)",
  "sourceAwardNumber": "(val)",
  "destinationAwardNumber": "(val)",
  "obligatedAmount": "(val)",
  "obligatedDirectAmount": "(val)",
  "obligatedIndirectAmount": "(val)",
  "anticipatedAmount": "(val)",
  "anticipatedDirectAmount": "(val)",
  "anticipatedIndirectAmount": "(val)",
  "comments": "(val)",
  "processedFlag": "(val)",
  "singleNodeTransaction": "(val)",
  "_primaryKey": "(val)"
}

Insert Pending Transactions
POST`/award/api/v1/pending-transactions/`

Example URI

POST /award/api/v1/pending-transactions/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "transactionId": "(val)",
  "documentNumber": "(val)",
  "sourceAwardNumber": "(val)",
  "destinationAwardNumber": "(val)",
  "obligatedAmount": "(val)",
  "obligatedDirectAmount": "(val)",
  "obligatedIndirectAmount": "(val)",
  "anticipatedAmount": "(val)",
  "anticipatedDirectAmount": "(val)",
  "anticipatedIndirectAmount": "(val)",
  "comments": "(val)",
  "processedFlag": "(val)",
  "singleNodeTransaction": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "transactionId": "(val)",
  "documentNumber": "(val)",
  "sourceAwardNumber": "(val)",
  "destinationAwardNumber": "(val)",
  "obligatedAmount": "(val)",
  "obligatedDirectAmount": "(val)",
  "obligatedIndirectAmount": "(val)",
  "anticipatedAmount": "(val)",
  "anticipatedDirectAmount": "(val)",
  "anticipatedIndirectAmount": "(val)",
  "comments": "(val)",
  "processedFlag": "(val)",
  "singleNodeTransaction": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Pending Transactions
POST`/award/api/v1/pending-transactions/`

Example URI

POST /award/api/v1/pending-transactions/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "transactionId": "(val)",
    "documentNumber": "(val)",
    "sourceAwardNumber": "(val)",
    "destinationAwardNumber": "(val)",
    "obligatedAmount": "(val)",
    "obligatedDirectAmount": "(val)",
    "obligatedIndirectAmount": "(val)",
    "anticipatedAmount": "(val)",
    "anticipatedDirectAmount": "(val)",
    "anticipatedIndirectAmount": "(val)",
    "comments": "(val)",
    "processedFlag": "(val)",
    "singleNodeTransaction": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "transactionId": "(val)",
    "documentNumber": "(val)",
    "sourceAwardNumber": "(val)",
    "destinationAwardNumber": "(val)",
    "obligatedAmount": "(val)",
    "obligatedDirectAmount": "(val)",
    "obligatedIndirectAmount": "(val)",
    "anticipatedAmount": "(val)",
    "anticipatedDirectAmount": "(val)",
    "anticipatedIndirectAmount": "(val)",
    "comments": "(val)",
    "processedFlag": "(val)",
    "singleNodeTransaction": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "transactionId": "(val)",
    "documentNumber": "(val)",
    "sourceAwardNumber": "(val)",
    "destinationAwardNumber": "(val)",
    "obligatedAmount": "(val)",
    "obligatedDirectAmount": "(val)",
    "obligatedIndirectAmount": "(val)",
    "anticipatedAmount": "(val)",
    "anticipatedDirectAmount": "(val)",
    "anticipatedIndirectAmount": "(val)",
    "comments": "(val)",
    "processedFlag": "(val)",
    "singleNodeTransaction": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "transactionId": "(val)",
    "documentNumber": "(val)",
    "sourceAwardNumber": "(val)",
    "destinationAwardNumber": "(val)",
    "obligatedAmount": "(val)",
    "obligatedDirectAmount": "(val)",
    "obligatedIndirectAmount": "(val)",
    "anticipatedAmount": "(val)",
    "anticipatedDirectAmount": "(val)",
    "anticipatedIndirectAmount": "(val)",
    "comments": "(val)",
    "processedFlag": "(val)",
    "singleNodeTransaction": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Pending Transactions by Key
DELETE`/award/api/v1/pending-transactions/(key)`

Example URI

DELETE /award/api/v1/pending-transactions/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Pending Transactions
DELETE`/award/api/v1/pending-transactions/`

Example URI

DELETE /award/api/v1/pending-transactions/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Pending Transactions with Matching
DELETE`/award/api/v1/pending-transactions/`

Example URI

DELETE /award/api/v1/pending-transactions/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
transactionId: string (optional)
Transaction. Maximum length is 22.
documentNumber: string (optional)
sourceAwardNumber: string (optional)
Source Award. Maximum length is 12.
destinationAwardNumber: string (optional)
Destination Award. Maximum length is 12.
obligatedAmount: string (optional)
Obligated Change. Maximum length is 22.
obligatedDirectAmount: string (optional)
Obligated Direct. Maximum length is 22.
obligatedIndirectAmount: string (optional)
Obligated F&A Change. Maximum length is 22.
anticipatedAmount: string (optional)
Anticipated Change. Maximum length is 22.
anticipatedDirectAmount: string (optional)
Anticipated Direct Change. Maximum length is 22.
anticipatedIndirectAmount: string (optional)
Anticipated F&A Change. Maximum length is 22.
comments: string (optional)
Comments. Maximum length is 200.
processedFlag: string (optional)
Processed Flag. Maximum length is 1.
singleNodeTransaction: string (optional)
Single Node Transaction. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Report Classes ¶

Get Report Classes by Key
GET`/award/api/v1/report-classes/(key)`

Example URI

GET /award/api/v1/report-classes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "reportClassCode": "(val)",
  "description": "(val)",
  "generateReportRequirements": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Report Classes
GET`/award/api/v1/report-classes/`

Example URI

GET /award/api/v1/report-classes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "reportClassCode": "(val)",
    "description": "(val)",
    "generateReportRequirements": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reportClassCode": "(val)",
    "description": "(val)",
    "generateReportRequirements": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Report Classes with Filtering
GET`/award/api/v1/report-classes/`

Example URI

GET /award/api/v1/report-classes/

URI Parameters

HideShow

reportClassCode: string (optional)
Report Class Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.
generateReportRequirements: string (optional)
Generate Report Tracking. Maximum length is 1.
active: string (optional)
Active. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "reportClassCode": "(val)",
    "description": "(val)",
    "generateReportRequirements": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reportClassCode": "(val)",
    "description": "(val)",
    "generateReportRequirements": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Report Classes
GET`/award/api/v1/report-classes/`

Example URI

GET /award/api/v1/report-classes/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "reportClassCode",
    "description",
    "generateReportRequirements",
    "active"
  ],
  "primaryKey": "reportClassCode"
}

Get Blueprint API specification for Report Classes
GET`/award/api/v1/report-classes/`

Example URI

GET /award/api/v1/report-classes/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Report Classes.md"
transfer-encoding: chunked

Update Report Classes
PUT`/award/api/v1/report-classes/(key)`

Example URI

PUT /award/api/v1/report-classes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "reportClassCode": "(val)",
  "description": "(val)",
  "generateReportRequirements": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Report Classes
PUT`/award/api/v1/report-classes/`

Example URI

PUT /award/api/v1/report-classes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "reportClassCode": "(val)",
    "description": "(val)",
    "generateReportRequirements": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reportClassCode": "(val)",
    "description": "(val)",
    "generateReportRequirements": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Report Classes
PATCH`/award/api/v1/report-classes/(key)`

Example URI

PATCH /award/api/v1/report-classes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "reportClassCode": "(val)",
  "description": "(val)",
  "generateReportRequirements": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "reportClassCode": "(val)",
  "description": "(val)",
  "generateReportRequirements": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Report Classes
POST`/award/api/v1/report-classes/`

Example URI

POST /award/api/v1/report-classes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "reportClassCode": "(val)",
  "description": "(val)",
  "generateReportRequirements": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "reportClassCode": "(val)",
  "description": "(val)",
  "generateReportRequirements": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Report Classes
POST`/award/api/v1/report-classes/`

Example URI

POST /award/api/v1/report-classes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "reportClassCode": "(val)",
    "description": "(val)",
    "generateReportRequirements": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reportClassCode": "(val)",
    "description": "(val)",
    "generateReportRequirements": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "reportClassCode": "(val)",
    "description": "(val)",
    "generateReportRequirements": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reportClassCode": "(val)",
    "description": "(val)",
    "generateReportRequirements": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Report Classes by Key
DELETE`/award/api/v1/report-classes/(key)`

Example URI

DELETE /award/api/v1/report-classes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Report Classes
DELETE`/award/api/v1/report-classes/`

Example URI

DELETE /award/api/v1/report-classes/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Report Classes with Matching
DELETE`/award/api/v1/report-classes/`

Example URI

DELETE /award/api/v1/report-classes/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
reportClassCode: string (optional)
Report Class Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.
generateReportRequirements: string (optional)
Generate Report Tracking. Maximum length is 1.
active: string (optional)
Active. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Report Statuses ¶

Get Report Statuses by Key
GET`/award/api/v1/report-statuses/(key)`

Example URI

GET /award/api/v1/report-statuses/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "reportStatusCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Report Statuses
GET`/award/api/v1/report-statuses/`

Example URI

GET /award/api/v1/report-statuses/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "reportStatusCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reportStatusCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Report Statuses with Filtering
GET`/award/api/v1/report-statuses/`

Example URI

GET /award/api/v1/report-statuses/

URI Parameters

HideShow

reportStatusCode: string (optional)
Report Status Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.
active: string (optional)
Active. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "reportStatusCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reportStatusCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Report Statuses
GET`/award/api/v1/report-statuses/`

Example URI

GET /award/api/v1/report-statuses/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "reportStatusCode",
    "description",
    "active"
  ],
  "primaryKey": "reportStatusCode"
}

Get Blueprint API specification for Report Statuses
GET`/award/api/v1/report-statuses/`

Example URI

GET /award/api/v1/report-statuses/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Report Statuses.md"
transfer-encoding: chunked

Update Report Statuses
PUT`/award/api/v1/report-statuses/(key)`

Example URI

PUT /award/api/v1/report-statuses/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "reportStatusCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Report Statuses
PUT`/award/api/v1/report-statuses/`

Example URI

PUT /award/api/v1/report-statuses/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "reportStatusCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reportStatusCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Report Statuses
PATCH`/award/api/v1/report-statuses/(key)`

Example URI

PATCH /award/api/v1/report-statuses/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "reportStatusCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "reportStatusCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Report Statuses
POST`/award/api/v1/report-statuses/`

Example URI

POST /award/api/v1/report-statuses/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "reportStatusCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "reportStatusCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Report Statuses
POST`/award/api/v1/report-statuses/`

Example URI

POST /award/api/v1/report-statuses/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "reportStatusCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reportStatusCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "reportStatusCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reportStatusCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Report Statuses by Key
DELETE`/award/api/v1/report-statuses/(key)`

Example URI

DELETE /award/api/v1/report-statuses/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Report Statuses
DELETE`/award/api/v1/report-statuses/`

Example URI

DELETE /award/api/v1/report-statuses/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Report Statuses with Matching
DELETE`/award/api/v1/report-statuses/`

Example URI

DELETE /award/api/v1/report-statuses/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
reportStatusCode: string (optional)
Report Status Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.
active: string (optional)
Active. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Report Tracking ¶

Get Report Tracking by Key
GET`/award/api/v1/report-tracking/(key)`

Example URI

GET /award/api/v1/report-tracking/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardReportTrackingId": "(val)",
  "awardReportTermId": "(val)",
  "awardNumber": "(val)",
  "awardId": "(val)",
  "piPersonId": "(val)",
  "piRolodexId": "(val)",
  "piName": "(val)",
  "leadUnitNumber": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "frequencyCode": "(val)",
  "frequencyBaseCode": "(val)",
  "ospDistributionCode": "(val)",
  "statusCode": "(val)",
  "baseDate": "(val)",
  "dueDate": "(val)",
  "activityDate": "(val)",
  "comments": "(val)",
  "preparerId": "(val)",
  "preparerName": "(val)",
  "sponsorCode": "(val)",
  "sponsorAwardNumber": "(val)",
  "title": "(val)",
  "lastUpdateUser": "(val)",
  "lastUpdateDate": "(val)",
  "_primaryKey": "(val)"
}

Get All Report Tracking
GET`/award/api/v1/report-tracking/`

Example URI

GET /award/api/v1/report-tracking/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardReportTrackingId": "(val)",
    "awardReportTermId": "(val)",
    "awardNumber": "(val)",
    "awardId": "(val)",
    "piPersonId": "(val)",
    "piRolodexId": "(val)",
    "piName": "(val)",
    "leadUnitNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "statusCode": "(val)",
    "baseDate": "(val)",
    "dueDate": "(val)",
    "activityDate": "(val)",
    "comments": "(val)",
    "preparerId": "(val)",
    "preparerName": "(val)",
    "sponsorCode": "(val)",
    "sponsorAwardNumber": "(val)",
    "title": "(val)",
    "lastUpdateUser": "(val)",
    "lastUpdateDate": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardReportTrackingId": "(val)",
    "awardReportTermId": "(val)",
    "awardNumber": "(val)",
    "awardId": "(val)",
    "piPersonId": "(val)",
    "piRolodexId": "(val)",
    "piName": "(val)",
    "leadUnitNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "statusCode": "(val)",
    "baseDate": "(val)",
    "dueDate": "(val)",
    "activityDate": "(val)",
    "comments": "(val)",
    "preparerId": "(val)",
    "preparerName": "(val)",
    "sponsorCode": "(val)",
    "sponsorAwardNumber": "(val)",
    "title": "(val)",
    "lastUpdateUser": "(val)",
    "lastUpdateDate": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Report Tracking with Filtering
GET`/award/api/v1/report-tracking/`

Example URI

GET /award/api/v1/report-tracking/

URI Parameters

HideShow

awardReportTrackingId: string (optional)
Award Report Tracking Id. Maximum length is 40.
awardReportTermId: string (optional)
Award Report Terms Id. Maximum length is 22.
awardNumber: string (optional)
Award ID. Maximum length is 12.
awardId: string (optional)
piPersonId: string (optional)
piRolodexId: string (optional)
piName: string (optional)
Full Name. Maximum length is 90.
leadUnitNumber: string (optional)
The lead unit number for the Award. Maximum length is 20.
reportClassCode: string (optional)
Report Class. Maximum length is 22.
reportCode: string (optional)
Report. Maximum length is 22.
frequencyCode: string (optional)
Frequency. Maximum length is 22.
frequencyBaseCode: string (optional)
Frequency Base. Maximum length is 22.
ospDistributionCode: string (optional)
OSP File Copy. Maximum length is 22.
statusCode: string (optional)
Status. Maximum length is 22.
baseDate: string (optional)
Base Date. Maximum length is 10.
dueDate: string (optional)
Due Date. Maximum length is 10.
activityDate: string (optional)
Activity Date. Maximum length is 10.
comments: string (optional)
Comments. Maximum length is 200.
preparerId: string (optional)
Preparer. Maximum length is 40.
preparerName: string (optional)
Preparer Name. Maximum length is 90.
sponsorCode: string (optional)
The identification number of the organization or agency that is providing support for the sponsored project. Maximum length is 20.
sponsorAwardNumber: string (optional)
Sponsor Award ID. Maximum length is 70.
title: string (optional)
The proposed title of the project. Maximum length is 200.
lastUpdateUser: string (optional)
Last Updated By. Maximum length is 90.
lastUpdateDate: string (optional)
Last Updated Date. Maximum length is 10.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardReportTrackingId": "(val)",
    "awardReportTermId": "(val)",
    "awardNumber": "(val)",
    "awardId": "(val)",
    "piPersonId": "(val)",
    "piRolodexId": "(val)",
    "piName": "(val)",
    "leadUnitNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "statusCode": "(val)",
    "baseDate": "(val)",
    "dueDate": "(val)",
    "activityDate": "(val)",
    "comments": "(val)",
    "preparerId": "(val)",
    "preparerName": "(val)",
    "sponsorCode": "(val)",
    "sponsorAwardNumber": "(val)",
    "title": "(val)",
    "lastUpdateUser": "(val)",
    "lastUpdateDate": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardReportTrackingId": "(val)",
    "awardReportTermId": "(val)",
    "awardNumber": "(val)",
    "awardId": "(val)",
    "piPersonId": "(val)",
    "piRolodexId": "(val)",
    "piName": "(val)",
    "leadUnitNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "statusCode": "(val)",
    "baseDate": "(val)",
    "dueDate": "(val)",
    "activityDate": "(val)",
    "comments": "(val)",
    "preparerId": "(val)",
    "preparerName": "(val)",
    "sponsorCode": "(val)",
    "sponsorAwardNumber": "(val)",
    "title": "(val)",
    "lastUpdateUser": "(val)",
    "lastUpdateDate": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Report Tracking
GET`/award/api/v1/report-tracking/`

Example URI

GET /award/api/v1/report-tracking/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardReportTrackingId",
    "awardReportTermId",
    "awardNumber",
    "awardId",
    "piPersonId",
    "piRolodexId",
    "piName",
    "leadUnitNumber",
    "reportClassCode",
    "reportCode",
    "frequencyCode",
    "frequencyBaseCode",
    "ospDistributionCode",
    "statusCode",
    "baseDate",
    "dueDate",
    "activityDate",
    "comments",
    "preparerId",
    "preparerName",
    "sponsorCode",
    "sponsorAwardNumber",
    "title",
    "lastUpdateUser",
    "lastUpdateDate"
  ],
  "primaryKey": "awardReportTrackingId"
}

Get Blueprint API specification for Report Tracking
GET`/award/api/v1/report-tracking/`

Example URI

GET /award/api/v1/report-tracking/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Report Tracking.md"
transfer-encoding: chunked

Update Report Tracking
PUT`/award/api/v1/report-tracking/(key)`

Example URI

PUT /award/api/v1/report-tracking/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardReportTrackingId": "(val)",
  "awardReportTermId": "(val)",
  "awardNumber": "(val)",
  "awardId": "(val)",
  "piPersonId": "(val)",
  "piRolodexId": "(val)",
  "piName": "(val)",
  "leadUnitNumber": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "frequencyCode": "(val)",
  "frequencyBaseCode": "(val)",
  "ospDistributionCode": "(val)",
  "statusCode": "(val)",
  "baseDate": "(val)",
  "dueDate": "(val)",
  "activityDate": "(val)",
  "comments": "(val)",
  "preparerId": "(val)",
  "preparerName": "(val)",
  "sponsorCode": "(val)",
  "sponsorAwardNumber": "(val)",
  "title": "(val)",
  "lastUpdateUser": "(val)",
  "lastUpdateDate": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Report Tracking
PUT`/award/api/v1/report-tracking/`

Example URI

PUT /award/api/v1/report-tracking/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardReportTrackingId": "(val)",
    "awardReportTermId": "(val)",
    "awardNumber": "(val)",
    "awardId": "(val)",
    "piPersonId": "(val)",
    "piRolodexId": "(val)",
    "piName": "(val)",
    "leadUnitNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "statusCode": "(val)",
    "baseDate": "(val)",
    "dueDate": "(val)",
    "activityDate": "(val)",
    "comments": "(val)",
    "preparerId": "(val)",
    "preparerName": "(val)",
    "sponsorCode": "(val)",
    "sponsorAwardNumber": "(val)",
    "title": "(val)",
    "lastUpdateUser": "(val)",
    "lastUpdateDate": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardReportTrackingId": "(val)",
    "awardReportTermId": "(val)",
    "awardNumber": "(val)",
    "awardId": "(val)",
    "piPersonId": "(val)",
    "piRolodexId": "(val)",
    "piName": "(val)",
    "leadUnitNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "statusCode": "(val)",
    "baseDate": "(val)",
    "dueDate": "(val)",
    "activityDate": "(val)",
    "comments": "(val)",
    "preparerId": "(val)",
    "preparerName": "(val)",
    "sponsorCode": "(val)",
    "sponsorAwardNumber": "(val)",
    "title": "(val)",
    "lastUpdateUser": "(val)",
    "lastUpdateDate": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Report Tracking
PATCH`/award/api/v1/report-tracking/(key)`

Example URI

PATCH /award/api/v1/report-tracking/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardReportTrackingId": "(val)",
  "awardReportTermId": "(val)",
  "awardNumber": "(val)",
  "awardId": "(val)",
  "piPersonId": "(val)",
  "piRolodexId": "(val)",
  "piName": "(val)",
  "leadUnitNumber": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "frequencyCode": "(val)",
  "frequencyBaseCode": "(val)",
  "ospDistributionCode": "(val)",
  "statusCode": "(val)",
  "baseDate": "(val)",
  "dueDate": "(val)",
  "activityDate": "(val)",
  "comments": "(val)",
  "preparerId": "(val)",
  "preparerName": "(val)",
  "sponsorCode": "(val)",
  "sponsorAwardNumber": "(val)",
  "title": "(val)",
  "lastUpdateUser": "(val)",
  "lastUpdateDate": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardReportTrackingId": "(val)",
  "awardReportTermId": "(val)",
  "awardNumber": "(val)",
  "awardId": "(val)",
  "piPersonId": "(val)",
  "piRolodexId": "(val)",
  "piName": "(val)",
  "leadUnitNumber": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "frequencyCode": "(val)",
  "frequencyBaseCode": "(val)",
  "ospDistributionCode": "(val)",
  "statusCode": "(val)",
  "baseDate": "(val)",
  "dueDate": "(val)",
  "activityDate": "(val)",
  "comments": "(val)",
  "preparerId": "(val)",
  "preparerName": "(val)",
  "sponsorCode": "(val)",
  "sponsorAwardNumber": "(val)",
  "title": "(val)",
  "lastUpdateUser": "(val)",
  "lastUpdateDate": "(val)",
  "_primaryKey": "(val)"
}

Insert Report Tracking
POST`/award/api/v1/report-tracking/`

Example URI

POST /award/api/v1/report-tracking/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardReportTrackingId": "(val)",
  "awardReportTermId": "(val)",
  "awardNumber": "(val)",
  "awardId": "(val)",
  "piPersonId": "(val)",
  "piRolodexId": "(val)",
  "piName": "(val)",
  "leadUnitNumber": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "frequencyCode": "(val)",
  "frequencyBaseCode": "(val)",
  "ospDistributionCode": "(val)",
  "statusCode": "(val)",
  "baseDate": "(val)",
  "dueDate": "(val)",
  "activityDate": "(val)",
  "comments": "(val)",
  "preparerId": "(val)",
  "preparerName": "(val)",
  "sponsorCode": "(val)",
  "sponsorAwardNumber": "(val)",
  "title": "(val)",
  "lastUpdateUser": "(val)",
  "lastUpdateDate": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardReportTrackingId": "(val)",
  "awardReportTermId": "(val)",
  "awardNumber": "(val)",
  "awardId": "(val)",
  "piPersonId": "(val)",
  "piRolodexId": "(val)",
  "piName": "(val)",
  "leadUnitNumber": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "frequencyCode": "(val)",
  "frequencyBaseCode": "(val)",
  "ospDistributionCode": "(val)",
  "statusCode": "(val)",
  "baseDate": "(val)",
  "dueDate": "(val)",
  "activityDate": "(val)",
  "comments": "(val)",
  "preparerId": "(val)",
  "preparerName": "(val)",
  "sponsorCode": "(val)",
  "sponsorAwardNumber": "(val)",
  "title": "(val)",
  "lastUpdateUser": "(val)",
  "lastUpdateDate": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Report Tracking
POST`/award/api/v1/report-tracking/`

Example URI

POST /award/api/v1/report-tracking/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardReportTrackingId": "(val)",
    "awardReportTermId": "(val)",
    "awardNumber": "(val)",
    "awardId": "(val)",
    "piPersonId": "(val)",
    "piRolodexId": "(val)",
    "piName": "(val)",
    "leadUnitNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "statusCode": "(val)",
    "baseDate": "(val)",
    "dueDate": "(val)",
    "activityDate": "(val)",
    "comments": "(val)",
    "preparerId": "(val)",
    "preparerName": "(val)",
    "sponsorCode": "(val)",
    "sponsorAwardNumber": "(val)",
    "title": "(val)",
    "lastUpdateUser": "(val)",
    "lastUpdateDate": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardReportTrackingId": "(val)",
    "awardReportTermId": "(val)",
    "awardNumber": "(val)",
    "awardId": "(val)",
    "piPersonId": "(val)",
    "piRolodexId": "(val)",
    "piName": "(val)",
    "leadUnitNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "statusCode": "(val)",
    "baseDate": "(val)",
    "dueDate": "(val)",
    "activityDate": "(val)",
    "comments": "(val)",
    "preparerId": "(val)",
    "preparerName": "(val)",
    "sponsorCode": "(val)",
    "sponsorAwardNumber": "(val)",
    "title": "(val)",
    "lastUpdateUser": "(val)",
    "lastUpdateDate": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardReportTrackingId": "(val)",
    "awardReportTermId": "(val)",
    "awardNumber": "(val)",
    "awardId": "(val)",
    "piPersonId": "(val)",
    "piRolodexId": "(val)",
    "piName": "(val)",
    "leadUnitNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "statusCode": "(val)",
    "baseDate": "(val)",
    "dueDate": "(val)",
    "activityDate": "(val)",
    "comments": "(val)",
    "preparerId": "(val)",
    "preparerName": "(val)",
    "sponsorCode": "(val)",
    "sponsorAwardNumber": "(val)",
    "title": "(val)",
    "lastUpdateUser": "(val)",
    "lastUpdateDate": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardReportTrackingId": "(val)",
    "awardReportTermId": "(val)",
    "awardNumber": "(val)",
    "awardId": "(val)",
    "piPersonId": "(val)",
    "piRolodexId": "(val)",
    "piName": "(val)",
    "leadUnitNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "ospDistributionCode": "(val)",
    "statusCode": "(val)",
    "baseDate": "(val)",
    "dueDate": "(val)",
    "activityDate": "(val)",
    "comments": "(val)",
    "preparerId": "(val)",
    "preparerName": "(val)",
    "sponsorCode": "(val)",
    "sponsorAwardNumber": "(val)",
    "title": "(val)",
    "lastUpdateUser": "(val)",
    "lastUpdateDate": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Report Tracking by Key
DELETE`/award/api/v1/report-tracking/(key)`

Example URI

DELETE /award/api/v1/report-tracking/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Report Tracking
DELETE`/award/api/v1/report-tracking/`

Example URI

DELETE /award/api/v1/report-tracking/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Report Tracking with Matching
DELETE`/award/api/v1/report-tracking/`

Example URI

DELETE /award/api/v1/report-tracking/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardReportTrackingId: string (optional)
Award Report Tracking Id. Maximum length is 40.
awardReportTermId: string (optional)
Award Report Terms Id. Maximum length is 22.
awardNumber: string (optional)
Award ID. Maximum length is 12.
awardId: string (optional)
piPersonId: string (optional)
piRolodexId: string (optional)
piName: string (optional)
Full Name. Maximum length is 90.
leadUnitNumber: string (optional)
The lead unit number for the Award. Maximum length is 20.
reportClassCode: string (optional)
Report Class. Maximum length is 22.
reportCode: string (optional)
Report. Maximum length is 22.
frequencyCode: string (optional)
Frequency. Maximum length is 22.
frequencyBaseCode: string (optional)
Frequency Base. Maximum length is 22.
ospDistributionCode: string (optional)
OSP File Copy. Maximum length is 22.
statusCode: string (optional)
Status. Maximum length is 22.
baseDate: string (optional)
Base Date. Maximum length is 10.
dueDate: string (optional)
Due Date. Maximum length is 10.
activityDate: string (optional)
Activity Date. Maximum length is 10.
comments: string (optional)
Comments. Maximum length is 200.
preparerId: string (optional)
Preparer. Maximum length is 40.
preparerName: string (optional)
Preparer Name. Maximum length is 90.
sponsorCode: string (optional)
The identification number of the organization or agency that is providing support for the sponsored project. Maximum length is 20.
sponsorAwardNumber: string (optional)
Sponsor Award ID. Maximum length is 70.
title: string (optional)
The proposed title of the project. Maximum length is 200.
lastUpdateUser: string (optional)
Last Updated By. Maximum length is 90.
lastUpdateDate: string (optional)
Last Updated Date. Maximum length is 10.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Reports ¶

Get Reports by Key
GET`/award/api/v1/reports/(key)`

Example URI

GET /award/api/v1/reports/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "reportCode": "(val)",
  "description": "(val)",
  "finalReportFlag": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Reports
GET`/award/api/v1/reports/`

Example URI

GET /award/api/v1/reports/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "reportCode": "(val)",
    "description": "(val)",
    "finalReportFlag": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reportCode": "(val)",
    "description": "(val)",
    "finalReportFlag": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Reports with Filtering
GET`/award/api/v1/reports/`

Example URI

GET /award/api/v1/reports/

URI Parameters

HideShow

reportCode: string (optional)
Report Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.
finalReportFlag: string (optional)
Final Report Flag. Maximum length is 1.
active: string (optional)
Active. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "reportCode": "(val)",
    "description": "(val)",
    "finalReportFlag": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reportCode": "(val)",
    "description": "(val)",
    "finalReportFlag": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Reports
GET`/award/api/v1/reports/`

Example URI

GET /award/api/v1/reports/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "reportCode",
    "description",
    "finalReportFlag",
    "active"
  ],
  "primaryKey": "reportCode"
}

Get Blueprint API specification for Reports
GET`/award/api/v1/reports/`

Example URI

GET /award/api/v1/reports/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Reports.md"
transfer-encoding: chunked

Update Reports
PUT`/award/api/v1/reports/(key)`

Example URI

PUT /award/api/v1/reports/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "reportCode": "(val)",
  "description": "(val)",
  "finalReportFlag": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Reports
PUT`/award/api/v1/reports/`

Example URI

PUT /award/api/v1/reports/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "reportCode": "(val)",
    "description": "(val)",
    "finalReportFlag": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reportCode": "(val)",
    "description": "(val)",
    "finalReportFlag": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Reports
PATCH`/award/api/v1/reports/(key)`

Example URI

PATCH /award/api/v1/reports/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "reportCode": "(val)",
  "description": "(val)",
  "finalReportFlag": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "reportCode": "(val)",
  "description": "(val)",
  "finalReportFlag": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Reports
POST`/award/api/v1/reports/`

Example URI

POST /award/api/v1/reports/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "reportCode": "(val)",
  "description": "(val)",
  "finalReportFlag": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "reportCode": "(val)",
  "description": "(val)",
  "finalReportFlag": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Reports
POST`/award/api/v1/reports/`

Example URI

POST /award/api/v1/reports/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "reportCode": "(val)",
    "description": "(val)",
    "finalReportFlag": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reportCode": "(val)",
    "description": "(val)",
    "finalReportFlag": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "reportCode": "(val)",
    "description": "(val)",
    "finalReportFlag": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reportCode": "(val)",
    "description": "(val)",
    "finalReportFlag": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Reports by Key
DELETE`/award/api/v1/reports/(key)`

Example URI

DELETE /award/api/v1/reports/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Reports
DELETE`/award/api/v1/reports/`

Example URI

DELETE /award/api/v1/reports/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Reports with Matching
DELETE`/award/api/v1/reports/`

Example URI

DELETE /award/api/v1/reports/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
reportCode: string (optional)
Report Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.
finalReportFlag: string (optional)
Final Report Flag. Maximum length is 1.
active: string (optional)
Active. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Sent Report Notifications ¶

Get Sent Report Notifications by Key
GET`/award/api/v1/sent-report-notifications/(key)`

Example URI

GET /award/api/v1/sent-report-notifications/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardReportNotifSentId": "(val)",
  "awardNumber": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "dueDate": "(val)",
  "actionCode": "(val)",
  "dateSent": "(val)",
  "_primaryKey": "(val)"
}

Get All Sent Report Notifications
GET`/award/api/v1/sent-report-notifications/`

Example URI

GET /award/api/v1/sent-report-notifications/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardReportNotifSentId": "(val)",
    "awardNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "dueDate": "(val)",
    "actionCode": "(val)",
    "dateSent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardReportNotifSentId": "(val)",
    "awardNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "dueDate": "(val)",
    "actionCode": "(val)",
    "dateSent": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Sent Report Notifications with Filtering
GET`/award/api/v1/sent-report-notifications/`

Example URI

GET /award/api/v1/sent-report-notifications/

URI Parameters

HideShow

awardReportNotifSentId: string (optional)
Report Tracking Sent Notification Id. Maximum length is 40.
awardNumber: string (optional)
Award ID. Maximum length is 12.
reportClassCode: string (optional)
Report Class. Maximum length is 22.
reportCode: string (optional)
Report. Maximum length is 22.
dueDate: string (optional)
Due Date. Maximum length is 10.
actionCode: string (optional)
Action Code. Maximum length is 3.
dateSent: string (optional)
Date Sent. Maximum length is 10.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardReportNotifSentId": "(val)",
    "awardNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "dueDate": "(val)",
    "actionCode": "(val)",
    "dateSent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardReportNotifSentId": "(val)",
    "awardNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "dueDate": "(val)",
    "actionCode": "(val)",
    "dateSent": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Sent Report Notifications
GET`/award/api/v1/sent-report-notifications/`

Example URI

GET /award/api/v1/sent-report-notifications/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardReportNotifSentId",
    "awardNumber",
    "reportClassCode",
    "reportCode",
    "dueDate",
    "actionCode",
    "dateSent"
  ],
  "primaryKey": "awardReportNotifSentId"
}

Get Blueprint API specification for Sent Report Notifications
GET`/award/api/v1/sent-report-notifications/`

Example URI

GET /award/api/v1/sent-report-notifications/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sent Report Notifications.md"
transfer-encoding: chunked

Update Sent Report Notifications
PUT`/award/api/v1/sent-report-notifications/(key)`

Example URI

PUT /award/api/v1/sent-report-notifications/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardReportNotifSentId": "(val)",
  "awardNumber": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "dueDate": "(val)",
  "actionCode": "(val)",
  "dateSent": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Sent Report Notifications
PUT`/award/api/v1/sent-report-notifications/`

Example URI

PUT /award/api/v1/sent-report-notifications/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardReportNotifSentId": "(val)",
    "awardNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "dueDate": "(val)",
    "actionCode": "(val)",
    "dateSent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardReportNotifSentId": "(val)",
    "awardNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "dueDate": "(val)",
    "actionCode": "(val)",
    "dateSent": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Sent Report Notifications
PATCH`/award/api/v1/sent-report-notifications/(key)`

Example URI

PATCH /award/api/v1/sent-report-notifications/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardReportNotifSentId": "(val)",
  "awardNumber": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "dueDate": "(val)",
  "actionCode": "(val)",
  "dateSent": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardReportNotifSentId": "(val)",
  "awardNumber": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "dueDate": "(val)",
  "actionCode": "(val)",
  "dateSent": "(val)",
  "_primaryKey": "(val)"
}

Insert Sent Report Notifications
POST`/award/api/v1/sent-report-notifications/`

Example URI

POST /award/api/v1/sent-report-notifications/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardReportNotifSentId": "(val)",
  "awardNumber": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "dueDate": "(val)",
  "actionCode": "(val)",
  "dateSent": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardReportNotifSentId": "(val)",
  "awardNumber": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "dueDate": "(val)",
  "actionCode": "(val)",
  "dateSent": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Sent Report Notifications
POST`/award/api/v1/sent-report-notifications/`

Example URI

POST /award/api/v1/sent-report-notifications/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardReportNotifSentId": "(val)",
    "awardNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "dueDate": "(val)",
    "actionCode": "(val)",
    "dateSent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardReportNotifSentId": "(val)",
    "awardNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "dueDate": "(val)",
    "actionCode": "(val)",
    "dateSent": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardReportNotifSentId": "(val)",
    "awardNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "dueDate": "(val)",
    "actionCode": "(val)",
    "dateSent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardReportNotifSentId": "(val)",
    "awardNumber": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "dueDate": "(val)",
    "actionCode": "(val)",
    "dateSent": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Sent Report Notifications by Key
DELETE`/award/api/v1/sent-report-notifications/(key)`

Example URI

DELETE /award/api/v1/sent-report-notifications/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sent Report Notifications
DELETE`/award/api/v1/sent-report-notifications/`

Example URI

DELETE /award/api/v1/sent-report-notifications/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sent Report Notifications with Matching
DELETE`/award/api/v1/sent-report-notifications/`

Example URI

DELETE /award/api/v1/sent-report-notifications/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardReportNotifSentId: string (optional)
Report Tracking Sent Notification Id. Maximum length is 40.
awardNumber: string (optional)
Award ID. Maximum length is 12.
reportClassCode: string (optional)
Report Class. Maximum length is 22.
reportCode: string (optional)
Report. Maximum length is 22.
dueDate: string (optional)
Due Date. Maximum length is 10.
actionCode: string (optional)
Action Code. Maximum length is 3.
dateSent: string (optional)
Date Sent. Maximum length is 10.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Subcontracting Expenditure Category Amounts ¶

Get Subcontracting Expenditure Category Amounts by Key
GET`/award/api/v1/subcontracting-expenditure-category-amounts/(key)`

Example URI

GET /award/api/v1/subcontracting-expenditure-category-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardNumber": "(val)",
  "largeBusinessExpenditureAmount": "(val)",
  "smallBusinessExpenditureAmount": "(val)",
  "womanOwnedExpenditureAmount": "(val)",
  "eightADisadvantageExpenditureAmount": "(val)",
  "hubZoneExpenditureAmount": "(val)",
  "veteranOwnedExpenditureAmount": "(val)",
  "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
  "historicalBlackCollegeExpenditureAmount": "(val)",
  "_primaryKey": "(val)"
}

Get All Subcontracting Expenditure Category Amounts
GET`/award/api/v1/subcontracting-expenditure-category-amounts/`

Example URI

GET /award/api/v1/subcontracting-expenditure-category-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardNumber": "(val)",
    "largeBusinessExpenditureAmount": "(val)",
    "smallBusinessExpenditureAmount": "(val)",
    "womanOwnedExpenditureAmount": "(val)",
    "eightADisadvantageExpenditureAmount": "(val)",
    "hubZoneExpenditureAmount": "(val)",
    "veteranOwnedExpenditureAmount": "(val)",
    "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
    "historicalBlackCollegeExpenditureAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNumber": "(val)",
    "largeBusinessExpenditureAmount": "(val)",
    "smallBusinessExpenditureAmount": "(val)",
    "womanOwnedExpenditureAmount": "(val)",
    "eightADisadvantageExpenditureAmount": "(val)",
    "hubZoneExpenditureAmount": "(val)",
    "veteranOwnedExpenditureAmount": "(val)",
    "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
    "historicalBlackCollegeExpenditureAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Subcontracting Expenditure Category Amounts with Filtering
GET`/award/api/v1/subcontracting-expenditure-category-amounts/`

Example URI

GET /award/api/v1/subcontracting-expenditure-category-amounts/

URI Parameters

HideShow

awardNumber: string (optional)
largeBusinessExpenditureAmount: string (optional)
smallBusinessExpenditureAmount: string (optional)
womanOwnedExpenditureAmount: string (optional)
eightADisadvantageExpenditureAmount: string (optional)
hubZoneExpenditureAmount: string (optional)
veteranOwnedExpenditureAmount: string (optional)
serviceDisabledVeteranOwnedExpenditureAmount: string (optional)
historicalBlackCollegeExpenditureAmount: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardNumber": "(val)",
    "largeBusinessExpenditureAmount": "(val)",
    "smallBusinessExpenditureAmount": "(val)",
    "womanOwnedExpenditureAmount": "(val)",
    "eightADisadvantageExpenditureAmount": "(val)",
    "hubZoneExpenditureAmount": "(val)",
    "veteranOwnedExpenditureAmount": "(val)",
    "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
    "historicalBlackCollegeExpenditureAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNumber": "(val)",
    "largeBusinessExpenditureAmount": "(val)",
    "smallBusinessExpenditureAmount": "(val)",
    "womanOwnedExpenditureAmount": "(val)",
    "eightADisadvantageExpenditureAmount": "(val)",
    "hubZoneExpenditureAmount": "(val)",
    "veteranOwnedExpenditureAmount": "(val)",
    "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
    "historicalBlackCollegeExpenditureAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Subcontracting Expenditure Category Amounts
GET`/award/api/v1/subcontracting-expenditure-category-amounts/`

Example URI

GET /award/api/v1/subcontracting-expenditure-category-amounts/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardNumber",
    "largeBusinessExpenditureAmount",
    "smallBusinessExpenditureAmount",
    "womanOwnedExpenditureAmount",
    "eightADisadvantageExpenditureAmount",
    "hubZoneExpenditureAmount",
    "veteranOwnedExpenditureAmount",
    "serviceDisabledVeteranOwnedExpenditureAmount",
    "historicalBlackCollegeExpenditureAmount"
  ],
  "primaryKey": "awardNumber"
}

Get Blueprint API specification for Subcontracting Expenditure Category Amounts
GET`/award/api/v1/subcontracting-expenditure-category-amounts/`

Example URI

GET /award/api/v1/subcontracting-expenditure-category-amounts/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Subcontracting Expenditure Category Amounts.md"
transfer-encoding: chunked

Update Subcontracting Expenditure Category Amounts
PUT`/award/api/v1/subcontracting-expenditure-category-amounts/(key)`

Example URI

PUT /award/api/v1/subcontracting-expenditure-category-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardNumber": "(val)",
  "largeBusinessExpenditureAmount": "(val)",
  "smallBusinessExpenditureAmount": "(val)",
  "womanOwnedExpenditureAmount": "(val)",
  "eightADisadvantageExpenditureAmount": "(val)",
  "hubZoneExpenditureAmount": "(val)",
  "veteranOwnedExpenditureAmount": "(val)",
  "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
  "historicalBlackCollegeExpenditureAmount": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Subcontracting Expenditure Category Amounts
PUT`/award/api/v1/subcontracting-expenditure-category-amounts/`

Example URI

PUT /award/api/v1/subcontracting-expenditure-category-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardNumber": "(val)",
    "largeBusinessExpenditureAmount": "(val)",
    "smallBusinessExpenditureAmount": "(val)",
    "womanOwnedExpenditureAmount": "(val)",
    "eightADisadvantageExpenditureAmount": "(val)",
    "hubZoneExpenditureAmount": "(val)",
    "veteranOwnedExpenditureAmount": "(val)",
    "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
    "historicalBlackCollegeExpenditureAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNumber": "(val)",
    "largeBusinessExpenditureAmount": "(val)",
    "smallBusinessExpenditureAmount": "(val)",
    "womanOwnedExpenditureAmount": "(val)",
    "eightADisadvantageExpenditureAmount": "(val)",
    "hubZoneExpenditureAmount": "(val)",
    "veteranOwnedExpenditureAmount": "(val)",
    "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
    "historicalBlackCollegeExpenditureAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Subcontracting Expenditure Category Amounts
PATCH`/award/api/v1/subcontracting-expenditure-category-amounts/(key)`

Example URI

PATCH /award/api/v1/subcontracting-expenditure-category-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardNumber": "(val)",
  "largeBusinessExpenditureAmount": "(val)",
  "smallBusinessExpenditureAmount": "(val)",
  "womanOwnedExpenditureAmount": "(val)",
  "eightADisadvantageExpenditureAmount": "(val)",
  "hubZoneExpenditureAmount": "(val)",
  "veteranOwnedExpenditureAmount": "(val)",
  "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
  "historicalBlackCollegeExpenditureAmount": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardNumber": "(val)",
  "largeBusinessExpenditureAmount": "(val)",
  "smallBusinessExpenditureAmount": "(val)",
  "womanOwnedExpenditureAmount": "(val)",
  "eightADisadvantageExpenditureAmount": "(val)",
  "hubZoneExpenditureAmount": "(val)",
  "veteranOwnedExpenditureAmount": "(val)",
  "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
  "historicalBlackCollegeExpenditureAmount": "(val)",
  "_primaryKey": "(val)"
}

Insert Subcontracting Expenditure Category Amounts
POST`/award/api/v1/subcontracting-expenditure-category-amounts/`

Example URI

POST /award/api/v1/subcontracting-expenditure-category-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardNumber": "(val)",
  "largeBusinessExpenditureAmount": "(val)",
  "smallBusinessExpenditureAmount": "(val)",
  "womanOwnedExpenditureAmount": "(val)",
  "eightADisadvantageExpenditureAmount": "(val)",
  "hubZoneExpenditureAmount": "(val)",
  "veteranOwnedExpenditureAmount": "(val)",
  "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
  "historicalBlackCollegeExpenditureAmount": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardNumber": "(val)",
  "largeBusinessExpenditureAmount": "(val)",
  "smallBusinessExpenditureAmount": "(val)",
  "womanOwnedExpenditureAmount": "(val)",
  "eightADisadvantageExpenditureAmount": "(val)",
  "hubZoneExpenditureAmount": "(val)",
  "veteranOwnedExpenditureAmount": "(val)",
  "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
  "historicalBlackCollegeExpenditureAmount": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Subcontracting Expenditure Category Amounts
POST`/award/api/v1/subcontracting-expenditure-category-amounts/`

Example URI

POST /award/api/v1/subcontracting-expenditure-category-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardNumber": "(val)",
    "largeBusinessExpenditureAmount": "(val)",
    "smallBusinessExpenditureAmount": "(val)",
    "womanOwnedExpenditureAmount": "(val)",
    "eightADisadvantageExpenditureAmount": "(val)",
    "hubZoneExpenditureAmount": "(val)",
    "veteranOwnedExpenditureAmount": "(val)",
    "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
    "historicalBlackCollegeExpenditureAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNumber": "(val)",
    "largeBusinessExpenditureAmount": "(val)",
    "smallBusinessExpenditureAmount": "(val)",
    "womanOwnedExpenditureAmount": "(val)",
    "eightADisadvantageExpenditureAmount": "(val)",
    "hubZoneExpenditureAmount": "(val)",
    "veteranOwnedExpenditureAmount": "(val)",
    "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
    "historicalBlackCollegeExpenditureAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardNumber": "(val)",
    "largeBusinessExpenditureAmount": "(val)",
    "smallBusinessExpenditureAmount": "(val)",
    "womanOwnedExpenditureAmount": "(val)",
    "eightADisadvantageExpenditureAmount": "(val)",
    "hubZoneExpenditureAmount": "(val)",
    "veteranOwnedExpenditureAmount": "(val)",
    "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
    "historicalBlackCollegeExpenditureAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNumber": "(val)",
    "largeBusinessExpenditureAmount": "(val)",
    "smallBusinessExpenditureAmount": "(val)",
    "womanOwnedExpenditureAmount": "(val)",
    "eightADisadvantageExpenditureAmount": "(val)",
    "hubZoneExpenditureAmount": "(val)",
    "veteranOwnedExpenditureAmount": "(val)",
    "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
    "historicalBlackCollegeExpenditureAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Subcontracting Expenditure Category Amounts by Key
DELETE`/award/api/v1/subcontracting-expenditure-category-amounts/(key)`

Example URI

DELETE /award/api/v1/subcontracting-expenditure-category-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Subcontracting Expenditure Category Amounts
DELETE`/award/api/v1/subcontracting-expenditure-category-amounts/`

Example URI

DELETE /award/api/v1/subcontracting-expenditure-category-amounts/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Subcontracting Expenditure Category Amounts with Matching
DELETE`/award/api/v1/subcontracting-expenditure-category-amounts/`

Example URI

DELETE /award/api/v1/subcontracting-expenditure-category-amounts/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardNumber: string (optional)
largeBusinessExpenditureAmount: string (optional)
smallBusinessExpenditureAmount: string (optional)
womanOwnedExpenditureAmount: string (optional)
eightADisadvantageExpenditureAmount: string (optional)
hubZoneExpenditureAmount: string (optional)
veteranOwnedExpenditureAmount: string (optional)
serviceDisabledVeteranOwnedExpenditureAmount: string (optional)
historicalBlackCollegeExpenditureAmount: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Subcontracting Expenditure Category Details ¶

Get Subcontracting Expenditure Category Details by Key
GET`/award/api/v1/subcontracting-expenditure-category-details/(key)`

Example URI

GET /award/api/v1/subcontracting-expenditure-category-details/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "id": "(val)",
  "awardNumber": "(val)",
  "amount": "(val)",
  "fiscalPeriod": "(val)",
  "largeBusiness": "(val)",
  "smallBusiness": "(val)",
  "womanOwned": "(val)",
  "eightADisadvantage": "(val)",
  "hubZone": "(val)",
  "veteranOwned": "(val)",
  "serviceDisabledVeteranOwned": "(val)",
  "historicalBlackCollege": "(val)",
  "_primaryKey": "(val)"
}

Get All Subcontracting Expenditure Category Details
GET`/award/api/v1/subcontracting-expenditure-category-details/`

Example URI

GET /award/api/v1/subcontracting-expenditure-category-details/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "id": "(val)",
    "awardNumber": "(val)",
    "amount": "(val)",
    "fiscalPeriod": "(val)",
    "largeBusiness": "(val)",
    "smallBusiness": "(val)",
    "womanOwned": "(val)",
    "eightADisadvantage": "(val)",
    "hubZone": "(val)",
    "veteranOwned": "(val)",
    "serviceDisabledVeteranOwned": "(val)",
    "historicalBlackCollege": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "awardNumber": "(val)",
    "amount": "(val)",
    "fiscalPeriod": "(val)",
    "largeBusiness": "(val)",
    "smallBusiness": "(val)",
    "womanOwned": "(val)",
    "eightADisadvantage": "(val)",
    "hubZone": "(val)",
    "veteranOwned": "(val)",
    "serviceDisabledVeteranOwned": "(val)",
    "historicalBlackCollege": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Subcontracting Expenditure Category Details with Filtering
GET`/award/api/v1/subcontracting-expenditure-category-details/`

Example URI

GET /award/api/v1/subcontracting-expenditure-category-details/

URI Parameters

HideShow

id: string (optional)
awardNumber: string (optional)
amount: string (optional)
fiscalPeriod: string (optional)
largeBusiness: string (optional)
smallBusiness: string (optional)
womanOwned: string (optional)
eightADisadvantage: string (optional)
hubZone: string (optional)
veteranOwned: string (optional)
serviceDisabledVeteranOwned: string (optional)
historicalBlackCollege: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "id": "(val)",
    "awardNumber": "(val)",
    "amount": "(val)",
    "fiscalPeriod": "(val)",
    "largeBusiness": "(val)",
    "smallBusiness": "(val)",
    "womanOwned": "(val)",
    "eightADisadvantage": "(val)",
    "hubZone": "(val)",
    "veteranOwned": "(val)",
    "serviceDisabledVeteranOwned": "(val)",
    "historicalBlackCollege": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "awardNumber": "(val)",
    "amount": "(val)",
    "fiscalPeriod": "(val)",
    "largeBusiness": "(val)",
    "smallBusiness": "(val)",
    "womanOwned": "(val)",
    "eightADisadvantage": "(val)",
    "hubZone": "(val)",
    "veteranOwned": "(val)",
    "serviceDisabledVeteranOwned": "(val)",
    "historicalBlackCollege": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Subcontracting Expenditure Category Details
GET`/award/api/v1/subcontracting-expenditure-category-details/`

Example URI

GET /award/api/v1/subcontracting-expenditure-category-details/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "id",
    "awardNumber",
    "amount",
    "fiscalPeriod",
    "largeBusiness",
    "smallBusiness",
    "womanOwned",
    "eightADisadvantage",
    "hubZone",
    "veteranOwned",
    "serviceDisabledVeteranOwned",
    "historicalBlackCollege"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Subcontracting Expenditure Category Details
GET`/award/api/v1/subcontracting-expenditure-category-details/`

Example URI

GET /award/api/v1/subcontracting-expenditure-category-details/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Subcontracting Expenditure Category Details.md"
transfer-encoding: chunked

Update Subcontracting Expenditure Category Details
PUT`/award/api/v1/subcontracting-expenditure-category-details/(key)`

Example URI

PUT /award/api/v1/subcontracting-expenditure-category-details/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "id": "(val)",
  "awardNumber": "(val)",
  "amount": "(val)",
  "fiscalPeriod": "(val)",
  "largeBusiness": "(val)",
  "smallBusiness": "(val)",
  "womanOwned": "(val)",
  "eightADisadvantage": "(val)",
  "hubZone": "(val)",
  "veteranOwned": "(val)",
  "serviceDisabledVeteranOwned": "(val)",
  "historicalBlackCollege": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Subcontracting Expenditure Category Details
PUT`/award/api/v1/subcontracting-expenditure-category-details/`

Example URI

PUT /award/api/v1/subcontracting-expenditure-category-details/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "id": "(val)",
    "awardNumber": "(val)",
    "amount": "(val)",
    "fiscalPeriod": "(val)",
    "largeBusiness": "(val)",
    "smallBusiness": "(val)",
    "womanOwned": "(val)",
    "eightADisadvantage": "(val)",
    "hubZone": "(val)",
    "veteranOwned": "(val)",
    "serviceDisabledVeteranOwned": "(val)",
    "historicalBlackCollege": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "awardNumber": "(val)",
    "amount": "(val)",
    "fiscalPeriod": "(val)",
    "largeBusiness": "(val)",
    "smallBusiness": "(val)",
    "womanOwned": "(val)",
    "eightADisadvantage": "(val)",
    "hubZone": "(val)",
    "veteranOwned": "(val)",
    "serviceDisabledVeteranOwned": "(val)",
    "historicalBlackCollege": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Subcontracting Expenditure Category Details
PATCH`/award/api/v1/subcontracting-expenditure-category-details/(key)`

Example URI

PATCH /award/api/v1/subcontracting-expenditure-category-details/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "id": "(val)",
  "awardNumber": "(val)",
  "amount": "(val)",
  "fiscalPeriod": "(val)",
  "largeBusiness": "(val)",
  "smallBusiness": "(val)",
  "womanOwned": "(val)",
  "eightADisadvantage": "(val)",
  "hubZone": "(val)",
  "veteranOwned": "(val)",
  "serviceDisabledVeteranOwned": "(val)",
  "historicalBlackCollege": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "id": "(val)",
  "awardNumber": "(val)",
  "amount": "(val)",
  "fiscalPeriod": "(val)",
  "largeBusiness": "(val)",
  "smallBusiness": "(val)",
  "womanOwned": "(val)",
  "eightADisadvantage": "(val)",
  "hubZone": "(val)",
  "veteranOwned": "(val)",
  "serviceDisabledVeteranOwned": "(val)",
  "historicalBlackCollege": "(val)",
  "_primaryKey": "(val)"
}

Insert Subcontracting Expenditure Category Details
POST`/award/api/v1/subcontracting-expenditure-category-details/`

Example URI

POST /award/api/v1/subcontracting-expenditure-category-details/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "id": "(val)",
  "awardNumber": "(val)",
  "amount": "(val)",
  "fiscalPeriod": "(val)",
  "largeBusiness": "(val)",
  "smallBusiness": "(val)",
  "womanOwned": "(val)",
  "eightADisadvantage": "(val)",
  "hubZone": "(val)",
  "veteranOwned": "(val)",
  "serviceDisabledVeteranOwned": "(val)",
  "historicalBlackCollege": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "id": "(val)",
  "awardNumber": "(val)",
  "amount": "(val)",
  "fiscalPeriod": "(val)",
  "largeBusiness": "(val)",
  "smallBusiness": "(val)",
  "womanOwned": "(val)",
  "eightADisadvantage": "(val)",
  "hubZone": "(val)",
  "veteranOwned": "(val)",
  "serviceDisabledVeteranOwned": "(val)",
  "historicalBlackCollege": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Subcontracting Expenditure Category Details
POST`/award/api/v1/subcontracting-expenditure-category-details/`

Example URI

POST /award/api/v1/subcontracting-expenditure-category-details/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "id": "(val)",
    "awardNumber": "(val)",
    "amount": "(val)",
    "fiscalPeriod": "(val)",
    "largeBusiness": "(val)",
    "smallBusiness": "(val)",
    "womanOwned": "(val)",
    "eightADisadvantage": "(val)",
    "hubZone": "(val)",
    "veteranOwned": "(val)",
    "serviceDisabledVeteranOwned": "(val)",
    "historicalBlackCollege": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "awardNumber": "(val)",
    "amount": "(val)",
    "fiscalPeriod": "(val)",
    "largeBusiness": "(val)",
    "smallBusiness": "(val)",
    "womanOwned": "(val)",
    "eightADisadvantage": "(val)",
    "hubZone": "(val)",
    "veteranOwned": "(val)",
    "serviceDisabledVeteranOwned": "(val)",
    "historicalBlackCollege": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "id": "(val)",
    "awardNumber": "(val)",
    "amount": "(val)",
    "fiscalPeriod": "(val)",
    "largeBusiness": "(val)",
    "smallBusiness": "(val)",
    "womanOwned": "(val)",
    "eightADisadvantage": "(val)",
    "hubZone": "(val)",
    "veteranOwned": "(val)",
    "serviceDisabledVeteranOwned": "(val)",
    "historicalBlackCollege": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "awardNumber": "(val)",
    "amount": "(val)",
    "fiscalPeriod": "(val)",
    "largeBusiness": "(val)",
    "smallBusiness": "(val)",
    "womanOwned": "(val)",
    "eightADisadvantage": "(val)",
    "hubZone": "(val)",
    "veteranOwned": "(val)",
    "serviceDisabledVeteranOwned": "(val)",
    "historicalBlackCollege": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Subcontracting Expenditure Category Details by Key
DELETE`/award/api/v1/subcontracting-expenditure-category-details/(key)`

Example URI

DELETE /award/api/v1/subcontracting-expenditure-category-details/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Subcontracting Expenditure Category Details
DELETE`/award/api/v1/subcontracting-expenditure-category-details/`

Example URI

DELETE /award/api/v1/subcontracting-expenditure-category-details/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Subcontracting Expenditure Category Details with Matching
DELETE`/award/api/v1/subcontracting-expenditure-category-details/`

Example URI

DELETE /award/api/v1/subcontracting-expenditure-category-details/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
id: string (optional)
awardNumber: string (optional)
amount: string (optional)
fiscalPeriod: string (optional)
largeBusiness: string (optional)
smallBusiness: string (optional)
womanOwned: string (optional)
eightADisadvantage: string (optional)
hubZone: string (optional)
veteranOwned: string (optional)
serviceDisabledVeteranOwned: string (optional)
historicalBlackCollege: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Subcontracting Expenditure Category In Date Range Amounts ¶

Get Subcontracting Expenditure Category In Date Range Amounts by Key
GET`/award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/(key)`

Example URI

GET /award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "awardNumber": "(val)",
  "rangeStartDate": "(val)",
  "rangeEndDate": "(val)",
  "largeBusinessExpenditureAmount": "(val)",
  "smallBusinessExpenditureAmount": "(val)",
  "womanOwnedExpenditureAmount": "(val)",
  "eightADisadvantageExpenditureAmount": "(val)",
  "hubZoneExpenditureAmount": "(val)",
  "veteranOwnedExpenditureAmount": "(val)",
  "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
  "historicalBlackCollegeExpenditureAmount": "(val)",
  "_primaryKey": "(val)"
}

Get All Subcontracting Expenditure Category In Date Range Amounts
GET`/award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/`

Example URI

GET /award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardNumber": "(val)",
    "rangeStartDate": "(val)",
    "rangeEndDate": "(val)",
    "largeBusinessExpenditureAmount": "(val)",
    "smallBusinessExpenditureAmount": "(val)",
    "womanOwnedExpenditureAmount": "(val)",
    "eightADisadvantageExpenditureAmount": "(val)",
    "hubZoneExpenditureAmount": "(val)",
    "veteranOwnedExpenditureAmount": "(val)",
    "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
    "historicalBlackCollegeExpenditureAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNumber": "(val)",
    "rangeStartDate": "(val)",
    "rangeEndDate": "(val)",
    "largeBusinessExpenditureAmount": "(val)",
    "smallBusinessExpenditureAmount": "(val)",
    "womanOwnedExpenditureAmount": "(val)",
    "eightADisadvantageExpenditureAmount": "(val)",
    "hubZoneExpenditureAmount": "(val)",
    "veteranOwnedExpenditureAmount": "(val)",
    "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
    "historicalBlackCollegeExpenditureAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Subcontracting Expenditure Category In Date Range Amounts with Filtering
GET`/award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/`

Example URI

GET /award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/

URI Parameters

HideShow

awardNumber: string (optional)
rangeStartDate: string (optional)
Range Start Date. Maximum length is 21.
rangeEndDate: string (optional)
Range End Date. Maximum length is 21.
largeBusinessExpenditureAmount: string (optional)
smallBusinessExpenditureAmount: string (optional)
womanOwnedExpenditureAmount: string (optional)
eightADisadvantageExpenditureAmount: string (optional)
hubZoneExpenditureAmount: string (optional)
veteranOwnedExpenditureAmount: string (optional)
serviceDisabledVeteranOwnedExpenditureAmount: string (optional)
historicalBlackCollegeExpenditureAmount: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "awardNumber": "(val)",
    "rangeStartDate": "(val)",
    "rangeEndDate": "(val)",
    "largeBusinessExpenditureAmount": "(val)",
    "smallBusinessExpenditureAmount": "(val)",
    "womanOwnedExpenditureAmount": "(val)",
    "eightADisadvantageExpenditureAmount": "(val)",
    "hubZoneExpenditureAmount": "(val)",
    "veteranOwnedExpenditureAmount": "(val)",
    "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
    "historicalBlackCollegeExpenditureAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNumber": "(val)",
    "rangeStartDate": "(val)",
    "rangeEndDate": "(val)",
    "largeBusinessExpenditureAmount": "(val)",
    "smallBusinessExpenditureAmount": "(val)",
    "womanOwnedExpenditureAmount": "(val)",
    "eightADisadvantageExpenditureAmount": "(val)",
    "hubZoneExpenditureAmount": "(val)",
    "veteranOwnedExpenditureAmount": "(val)",
    "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
    "historicalBlackCollegeExpenditureAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Subcontracting Expenditure Category In Date Range Amounts
GET`/award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/`

Example URI

GET /award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "awardNumber",
    "rangeStartDate",
    "rangeEndDate",
    "largeBusinessExpenditureAmount",
    "smallBusinessExpenditureAmount",
    "womanOwnedExpenditureAmount",
    "eightADisadvantageExpenditureAmount",
    "hubZoneExpenditureAmount",
    "veteranOwnedExpenditureAmount",
    "serviceDisabledVeteranOwnedExpenditureAmount",
    "historicalBlackCollegeExpenditureAmount"
  ],
  "primaryKey": "awardNumber"
}

Get Blueprint API specification for Subcontracting Expenditure Category In Date Range Amounts
GET`/award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/`

Example URI

GET /award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Subcontracting Expenditure Category In Date Range Amounts.md"
transfer-encoding: chunked

Update Subcontracting Expenditure Category In Date Range Amounts
PUT`/award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/(key)`

Example URI

PUT /award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardNumber": "(val)",
  "rangeStartDate": "(val)",
  "rangeEndDate": "(val)",
  "largeBusinessExpenditureAmount": "(val)",
  "smallBusinessExpenditureAmount": "(val)",
  "womanOwnedExpenditureAmount": "(val)",
  "eightADisadvantageExpenditureAmount": "(val)",
  "hubZoneExpenditureAmount": "(val)",
  "veteranOwnedExpenditureAmount": "(val)",
  "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
  "historicalBlackCollegeExpenditureAmount": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Subcontracting Expenditure Category In Date Range Amounts
PUT`/award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/`

Example URI

PUT /award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardNumber": "(val)",
    "rangeStartDate": "(val)",
    "rangeEndDate": "(val)",
    "largeBusinessExpenditureAmount": "(val)",
    "smallBusinessExpenditureAmount": "(val)",
    "womanOwnedExpenditureAmount": "(val)",
    "eightADisadvantageExpenditureAmount": "(val)",
    "hubZoneExpenditureAmount": "(val)",
    "veteranOwnedExpenditureAmount": "(val)",
    "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
    "historicalBlackCollegeExpenditureAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNumber": "(val)",
    "rangeStartDate": "(val)",
    "rangeEndDate": "(val)",
    "largeBusinessExpenditureAmount": "(val)",
    "smallBusinessExpenditureAmount": "(val)",
    "womanOwnedExpenditureAmount": "(val)",
    "eightADisadvantageExpenditureAmount": "(val)",
    "hubZoneExpenditureAmount": "(val)",
    "veteranOwnedExpenditureAmount": "(val)",
    "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
    "historicalBlackCollegeExpenditureAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Subcontracting Expenditure Category In Date Range Amounts
PATCH`/award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/(key)`

Example URI

PATCH /award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardNumber": "(val)",
  "rangeStartDate": "(val)",
  "rangeEndDate": "(val)",
  "largeBusinessExpenditureAmount": "(val)",
  "smallBusinessExpenditureAmount": "(val)",
  "womanOwnedExpenditureAmount": "(val)",
  "eightADisadvantageExpenditureAmount": "(val)",
  "hubZoneExpenditureAmount": "(val)",
  "veteranOwnedExpenditureAmount": "(val)",
  "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
  "historicalBlackCollegeExpenditureAmount": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "awardNumber": "(val)",
  "rangeStartDate": "(val)",
  "rangeEndDate": "(val)",
  "largeBusinessExpenditureAmount": "(val)",
  "smallBusinessExpenditureAmount": "(val)",
  "womanOwnedExpenditureAmount": "(val)",
  "eightADisadvantageExpenditureAmount": "(val)",
  "hubZoneExpenditureAmount": "(val)",
  "veteranOwnedExpenditureAmount": "(val)",
  "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
  "historicalBlackCollegeExpenditureAmount": "(val)",
  "_primaryKey": "(val)"
}

Insert Subcontracting Expenditure Category In Date Range Amounts
POST`/award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/`

Example URI

POST /award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "awardNumber": "(val)",
  "rangeStartDate": "(val)",
  "rangeEndDate": "(val)",
  "largeBusinessExpenditureAmount": "(val)",
  "smallBusinessExpenditureAmount": "(val)",
  "womanOwnedExpenditureAmount": "(val)",
  "eightADisadvantageExpenditureAmount": "(val)",
  "hubZoneExpenditureAmount": "(val)",
  "veteranOwnedExpenditureAmount": "(val)",
  "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
  "historicalBlackCollegeExpenditureAmount": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "awardNumber": "(val)",
  "rangeStartDate": "(val)",
  "rangeEndDate": "(val)",
  "largeBusinessExpenditureAmount": "(val)",
  "smallBusinessExpenditureAmount": "(val)",
  "womanOwnedExpenditureAmount": "(val)",
  "eightADisadvantageExpenditureAmount": "(val)",
  "hubZoneExpenditureAmount": "(val)",
  "veteranOwnedExpenditureAmount": "(val)",
  "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
  "historicalBlackCollegeExpenditureAmount": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Subcontracting Expenditure Category In Date Range Amounts
POST`/award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/`

Example URI

POST /award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "awardNumber": "(val)",
    "rangeStartDate": "(val)",
    "rangeEndDate": "(val)",
    "largeBusinessExpenditureAmount": "(val)",
    "smallBusinessExpenditureAmount": "(val)",
    "womanOwnedExpenditureAmount": "(val)",
    "eightADisadvantageExpenditureAmount": "(val)",
    "hubZoneExpenditureAmount": "(val)",
    "veteranOwnedExpenditureAmount": "(val)",
    "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
    "historicalBlackCollegeExpenditureAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNumber": "(val)",
    "rangeStartDate": "(val)",
    "rangeEndDate": "(val)",
    "largeBusinessExpenditureAmount": "(val)",
    "smallBusinessExpenditureAmount": "(val)",
    "womanOwnedExpenditureAmount": "(val)",
    "eightADisadvantageExpenditureAmount": "(val)",
    "hubZoneExpenditureAmount": "(val)",
    "veteranOwnedExpenditureAmount": "(val)",
    "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
    "historicalBlackCollegeExpenditureAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "awardNumber": "(val)",
    "rangeStartDate": "(val)",
    "rangeEndDate": "(val)",
    "largeBusinessExpenditureAmount": "(val)",
    "smallBusinessExpenditureAmount": "(val)",
    "womanOwnedExpenditureAmount": "(val)",
    "eightADisadvantageExpenditureAmount": "(val)",
    "hubZoneExpenditureAmount": "(val)",
    "veteranOwnedExpenditureAmount": "(val)",
    "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
    "historicalBlackCollegeExpenditureAmount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "awardNumber": "(val)",
    "rangeStartDate": "(val)",
    "rangeEndDate": "(val)",
    "largeBusinessExpenditureAmount": "(val)",
    "smallBusinessExpenditureAmount": "(val)",
    "womanOwnedExpenditureAmount": "(val)",
    "eightADisadvantageExpenditureAmount": "(val)",
    "hubZoneExpenditureAmount": "(val)",
    "veteranOwnedExpenditureAmount": "(val)",
    "serviceDisabledVeteranOwnedExpenditureAmount": "(val)",
    "historicalBlackCollegeExpenditureAmount": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Subcontracting Expenditure Category In Date Range Amounts by Key
DELETE`/award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/(key)`

Example URI

DELETE /award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Subcontracting Expenditure Category In Date Range Amounts
DELETE`/award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/`

Example URI

DELETE /award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Subcontracting Expenditure Category In Date Range Amounts with Matching
DELETE`/award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/`

Example URI

DELETE /award/api/v1/subcontracting-expenditure-category-in-date-range-amounts/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
awardNumber: string (optional)
rangeStartDate: string (optional)
Range Start Date. Maximum length is 21.
rangeEndDate: string (optional)
Range End Date. Maximum length is 21.
largeBusinessExpenditureAmount: string (optional)
smallBusinessExpenditureAmount: string (optional)
womanOwnedExpenditureAmount: string (optional)
eightADisadvantageExpenditureAmount: string (optional)
hubZoneExpenditureAmount: string (optional)
veteranOwnedExpenditureAmount: string (optional)
serviceDisabledVeteranOwnedExpenditureAmount: string (optional)
historicalBlackCollegeExpenditureAmount: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Transaction Details ¶

Get Transaction Details by Key
GET`/award/api/v1/transaction-details/(key)`

Example URI

GET /award/api/v1/transaction-details/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "transactionDetailId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "transactionId": "(val)",
  "timeAndMoneyDocumentNumber": "(val)",
  "sourceAwardNumber": "(val)",
  "destinationAwardNumber": "(val)",
  "obligatedAmount": "(val)",
  "obligatedDirectAmount": "(val)",
  "obligatedIndirectAmount": "(val)",
  "anticipatedAmount": "(val)",
  "anticipatedDirectAmount": "(val)",
  "anticipatedIndirectAmount": "(val)",
  "comments": "(val)",
  "transactionDetailType": "(val)",
  "_primaryKey": "(val)"
}

Get All Transaction Details
GET`/award/api/v1/transaction-details/`

Example URI

GET /award/api/v1/transaction-details/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "transactionDetailId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "transactionId": "(val)",
    "timeAndMoneyDocumentNumber": "(val)",
    "sourceAwardNumber": "(val)",
    "destinationAwardNumber": "(val)",
    "obligatedAmount": "(val)",
    "obligatedDirectAmount": "(val)",
    "obligatedIndirectAmount": "(val)",
    "anticipatedAmount": "(val)",
    "anticipatedDirectAmount": "(val)",
    "anticipatedIndirectAmount": "(val)",
    "comments": "(val)",
    "transactionDetailType": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "transactionDetailId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "transactionId": "(val)",
    "timeAndMoneyDocumentNumber": "(val)",
    "sourceAwardNumber": "(val)",
    "destinationAwardNumber": "(val)",
    "obligatedAmount": "(val)",
    "obligatedDirectAmount": "(val)",
    "obligatedIndirectAmount": "(val)",
    "anticipatedAmount": "(val)",
    "anticipatedDirectAmount": "(val)",
    "anticipatedIndirectAmount": "(val)",
    "comments": "(val)",
    "transactionDetailType": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Transaction Details with Filtering
GET`/award/api/v1/transaction-details/`

Example URI

GET /award/api/v1/transaction-details/

URI Parameters

HideShow

transactionDetailId: string (optional)
Transaction Detail Id. Maximum length is 22.
awardNumber: string (optional)
Award Number. Maximum length is 12.
sequenceNumber: string (optional)
Sequence Number. Maximum length is 4.
transactionId: string (optional)
Transaction Id. Maximum length is 22.
timeAndMoneyDocumentNumber: string (optional)
Document Number. Maximum length is 10.
sourceAwardNumber: string (optional)
Source. Maximum length is 12.
destinationAwardNumber: string (optional)
Destination. Maximum length is 12.
obligatedAmount: string (optional)
Obligated. Maximum length is 22.
obligatedDirectAmount: string (optional)
Obligated. Maximum length is 22.
obligatedIndirectAmount: string (optional)
Obligated. Maximum length is 22.
anticipatedAmount: string (optional)
Anticipated. Maximum length is 22.
anticipatedDirectAmount: string (optional)
Anticipated. Maximum length is 22.
anticipatedIndirectAmount: string (optional)
Anticipated. Maximum length is 22.
comments: string (optional)
Comments. Maximum length is 2000.
transactionDetailType: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "transactionDetailId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "transactionId": "(val)",
    "timeAndMoneyDocumentNumber": "(val)",
    "sourceAwardNumber": "(val)",
    "destinationAwardNumber": "(val)",
    "obligatedAmount": "(val)",
    "obligatedDirectAmount": "(val)",
    "obligatedIndirectAmount": "(val)",
    "anticipatedAmount": "(val)",
    "anticipatedDirectAmount": "(val)",
    "anticipatedIndirectAmount": "(val)",
    "comments": "(val)",
    "transactionDetailType": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "transactionDetailId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "transactionId": "(val)",
    "timeAndMoneyDocumentNumber": "(val)",
    "sourceAwardNumber": "(val)",
    "destinationAwardNumber": "(val)",
    "obligatedAmount": "(val)",
    "obligatedDirectAmount": "(val)",
    "obligatedIndirectAmount": "(val)",
    "anticipatedAmount": "(val)",
    "anticipatedDirectAmount": "(val)",
    "anticipatedIndirectAmount": "(val)",
    "comments": "(val)",
    "transactionDetailType": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Transaction Details
GET`/award/api/v1/transaction-details/`

Example URI

GET /award/api/v1/transaction-details/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "transactionDetailId",
    "awardNumber",
    "sequenceNumber",
    "transactionId",
    "timeAndMoneyDocumentNumber",
    "sourceAwardNumber",
    "destinationAwardNumber",
    "obligatedAmount",
    "obligatedDirectAmount",
    "obligatedIndirectAmount",
    "anticipatedAmount",
    "anticipatedDirectAmount",
    "anticipatedIndirectAmount",
    "comments",
    "transactionDetailType"
  ],
  "primaryKey": "transactionDetailId"
}

Get Blueprint API specification for Transaction Details
GET`/award/api/v1/transaction-details/`

Example URI

GET /award/api/v1/transaction-details/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Transaction Details.md"
transfer-encoding: chunked

Update Transaction Details
PUT`/award/api/v1/transaction-details/(key)`

Example URI

PUT /award/api/v1/transaction-details/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "transactionDetailId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "transactionId": "(val)",
  "timeAndMoneyDocumentNumber": "(val)",
  "sourceAwardNumber": "(val)",
  "destinationAwardNumber": "(val)",
  "obligatedAmount": "(val)",
  "obligatedDirectAmount": "(val)",
  "obligatedIndirectAmount": "(val)",
  "anticipatedAmount": "(val)",
  "anticipatedDirectAmount": "(val)",
  "anticipatedIndirectAmount": "(val)",
  "comments": "(val)",
  "transactionDetailType": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Transaction Details
PUT`/award/api/v1/transaction-details/`

Example URI

PUT /award/api/v1/transaction-details/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "transactionDetailId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "transactionId": "(val)",
    "timeAndMoneyDocumentNumber": "(val)",
    "sourceAwardNumber": "(val)",
    "destinationAwardNumber": "(val)",
    "obligatedAmount": "(val)",
    "obligatedDirectAmount": "(val)",
    "obligatedIndirectAmount": "(val)",
    "anticipatedAmount": "(val)",
    "anticipatedDirectAmount": "(val)",
    "anticipatedIndirectAmount": "(val)",
    "comments": "(val)",
    "transactionDetailType": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "transactionDetailId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "transactionId": "(val)",
    "timeAndMoneyDocumentNumber": "(val)",
    "sourceAwardNumber": "(val)",
    "destinationAwardNumber": "(val)",
    "obligatedAmount": "(val)",
    "obligatedDirectAmount": "(val)",
    "obligatedIndirectAmount": "(val)",
    "anticipatedAmount": "(val)",
    "anticipatedDirectAmount": "(val)",
    "anticipatedIndirectAmount": "(val)",
    "comments": "(val)",
    "transactionDetailType": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Transaction Details
PATCH`/award/api/v1/transaction-details/(key)`

Example URI

PATCH /award/api/v1/transaction-details/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "transactionDetailId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "transactionId": "(val)",
  "timeAndMoneyDocumentNumber": "(val)",
  "sourceAwardNumber": "(val)",
  "destinationAwardNumber": "(val)",
  "obligatedAmount": "(val)",
  "obligatedDirectAmount": "(val)",
  "obligatedIndirectAmount": "(val)",
  "anticipatedAmount": "(val)",
  "anticipatedDirectAmount": "(val)",
  "anticipatedIndirectAmount": "(val)",
  "comments": "(val)",
  "transactionDetailType": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "transactionDetailId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "transactionId": "(val)",
  "timeAndMoneyDocumentNumber": "(val)",
  "sourceAwardNumber": "(val)",
  "destinationAwardNumber": "(val)",
  "obligatedAmount": "(val)",
  "obligatedDirectAmount": "(val)",
  "obligatedIndirectAmount": "(val)",
  "anticipatedAmount": "(val)",
  "anticipatedDirectAmount": "(val)",
  "anticipatedIndirectAmount": "(val)",
  "comments": "(val)",
  "transactionDetailType": "(val)",
  "_primaryKey": "(val)"
}

Insert Transaction Details
POST`/award/api/v1/transaction-details/`

Example URI

POST /award/api/v1/transaction-details/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "transactionDetailId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "transactionId": "(val)",
  "timeAndMoneyDocumentNumber": "(val)",
  "sourceAwardNumber": "(val)",
  "destinationAwardNumber": "(val)",
  "obligatedAmount": "(val)",
  "obligatedDirectAmount": "(val)",
  "obligatedIndirectAmount": "(val)",
  "anticipatedAmount": "(val)",
  "anticipatedDirectAmount": "(val)",
  "anticipatedIndirectAmount": "(val)",
  "comments": "(val)",
  "transactionDetailType": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "transactionDetailId": "(val)",
  "awardNumber": "(val)",
  "sequenceNumber": "(val)",
  "transactionId": "(val)",
  "timeAndMoneyDocumentNumber": "(val)",
  "sourceAwardNumber": "(val)",
  "destinationAwardNumber": "(val)",
  "obligatedAmount": "(val)",
  "obligatedDirectAmount": "(val)",
  "obligatedIndirectAmount": "(val)",
  "anticipatedAmount": "(val)",
  "anticipatedDirectAmount": "(val)",
  "anticipatedIndirectAmount": "(val)",
  "comments": "(val)",
  "transactionDetailType": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Transaction Details
POST`/award/api/v1/transaction-details/`

Example URI

POST /award/api/v1/transaction-details/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "transactionDetailId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "transactionId": "(val)",
    "timeAndMoneyDocumentNumber": "(val)",
    "sourceAwardNumber": "(val)",
    "destinationAwardNumber": "(val)",
    "obligatedAmount": "(val)",
    "obligatedDirectAmount": "(val)",
    "obligatedIndirectAmount": "(val)",
    "anticipatedAmount": "(val)",
    "anticipatedDirectAmount": "(val)",
    "anticipatedIndirectAmount": "(val)",
    "comments": "(val)",
    "transactionDetailType": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "transactionDetailId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "transactionId": "(val)",
    "timeAndMoneyDocumentNumber": "(val)",
    "sourceAwardNumber": "(val)",
    "destinationAwardNumber": "(val)",
    "obligatedAmount": "(val)",
    "obligatedDirectAmount": "(val)",
    "obligatedIndirectAmount": "(val)",
    "anticipatedAmount": "(val)",
    "anticipatedDirectAmount": "(val)",
    "anticipatedIndirectAmount": "(val)",
    "comments": "(val)",
    "transactionDetailType": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "transactionDetailId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "transactionId": "(val)",
    "timeAndMoneyDocumentNumber": "(val)",
    "sourceAwardNumber": "(val)",
    "destinationAwardNumber": "(val)",
    "obligatedAmount": "(val)",
    "obligatedDirectAmount": "(val)",
    "obligatedIndirectAmount": "(val)",
    "anticipatedAmount": "(val)",
    "anticipatedDirectAmount": "(val)",
    "anticipatedIndirectAmount": "(val)",
    "comments": "(val)",
    "transactionDetailType": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "transactionDetailId": "(val)",
    "awardNumber": "(val)",
    "sequenceNumber": "(val)",
    "transactionId": "(val)",
    "timeAndMoneyDocumentNumber": "(val)",
    "sourceAwardNumber": "(val)",
    "destinationAwardNumber": "(val)",
    "obligatedAmount": "(val)",
    "obligatedDirectAmount": "(val)",
    "obligatedIndirectAmount": "(val)",
    "anticipatedAmount": "(val)",
    "anticipatedDirectAmount": "(val)",
    "anticipatedIndirectAmount": "(val)",
    "comments": "(val)",
    "transactionDetailType": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Transaction Details by Key
DELETE`/award/api/v1/transaction-details/(key)`

Example URI

DELETE /award/api/v1/transaction-details/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Transaction Details
DELETE`/award/api/v1/transaction-details/`

Example URI

DELETE /award/api/v1/transaction-details/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Transaction Details with Matching
DELETE`/award/api/v1/transaction-details/`

Example URI

DELETE /award/api/v1/transaction-details/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
transactionDetailId: string (optional)
Transaction Detail Id. Maximum length is 22.
awardNumber: string (optional)
Award Number. Maximum length is 12.
sequenceNumber: string (optional)
Sequence Number. Maximum length is 4.
transactionId: string (optional)
Transaction Id. Maximum length is 22.
timeAndMoneyDocumentNumber: string (optional)
Document Number. Maximum length is 10.
sourceAwardNumber: string (optional)
Source. Maximum length is 12.
destinationAwardNumber: string (optional)
Destination. Maximum length is 12.
obligatedAmount: string (optional)
Obligated. Maximum length is 22.
obligatedDirectAmount: string (optional)
Obligated. Maximum length is 22.
obligatedIndirectAmount: string (optional)
Obligated. Maximum length is 22.
anticipatedAmount: string (optional)
Anticipated. Maximum length is 22.
anticipatedDirectAmount: string (optional)
Anticipated. Maximum length is 22.
anticipatedIndirectAmount: string (optional)
Anticipated. Maximum length is 22.
comments: string (optional)
Comments. Maximum length is 2000.
transactionDetailType: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Valid Award Basis Payments ¶

Get Valid Award Basis Payments by Key
GET`/award/api/v1/valid-award-basis-payments/(key)`

Example URI

GET /award/api/v1/valid-award-basis-payments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "validAwardBasisPaymentId": "(val)",
  "basisOfPaymentCode": "(val)",
  "awardTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Valid Award Basis Payments
GET`/award/api/v1/valid-award-basis-payments/`

Example URI

GET /award/api/v1/valid-award-basis-payments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "validAwardBasisPaymentId": "(val)",
    "basisOfPaymentCode": "(val)",
    "awardTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validAwardBasisPaymentId": "(val)",
    "basisOfPaymentCode": "(val)",
    "awardTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Valid Award Basis Payments with Filtering
GET`/award/api/v1/valid-award-basis-payments/`

Example URI

GET /award/api/v1/valid-award-basis-payments/

URI Parameters

HideShow

validAwardBasisPaymentId: string (optional)
Valid Award Basis Payment Id. Maximum length is 22.
basisOfPaymentCode: string (optional)
Basis Of Payment Code. Maximum length is 3.
awardTypeCode: string (optional)
Award Type Code. Maximum length is 3.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "validAwardBasisPaymentId": "(val)",
    "basisOfPaymentCode": "(val)",
    "awardTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validAwardBasisPaymentId": "(val)",
    "basisOfPaymentCode": "(val)",
    "awardTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Valid Award Basis Payments
GET`/award/api/v1/valid-award-basis-payments/`

Example URI

GET /award/api/v1/valid-award-basis-payments/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "validAwardBasisPaymentId",
    "basisOfPaymentCode",
    "awardTypeCode"
  ],
  "primaryKey": "validAwardBasisPaymentId"
}

Get Blueprint API specification for Valid Award Basis Payments
GET`/award/api/v1/valid-award-basis-payments/`

Example URI

GET /award/api/v1/valid-award-basis-payments/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Valid Award Basis Payments.md"
transfer-encoding: chunked

Update Valid Award Basis Payments
PUT`/award/api/v1/valid-award-basis-payments/(key)`

Example URI

PUT /award/api/v1/valid-award-basis-payments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "validAwardBasisPaymentId": "(val)",
  "basisOfPaymentCode": "(val)",
  "awardTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Valid Award Basis Payments
PUT`/award/api/v1/valid-award-basis-payments/`

Example URI

PUT /award/api/v1/valid-award-basis-payments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "validAwardBasisPaymentId": "(val)",
    "basisOfPaymentCode": "(val)",
    "awardTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validAwardBasisPaymentId": "(val)",
    "basisOfPaymentCode": "(val)",
    "awardTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Valid Award Basis Payments
PATCH`/award/api/v1/valid-award-basis-payments/(key)`

Example URI

PATCH /award/api/v1/valid-award-basis-payments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "validAwardBasisPaymentId": "(val)",
  "basisOfPaymentCode": "(val)",
  "awardTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "validAwardBasisPaymentId": "(val)",
  "basisOfPaymentCode": "(val)",
  "awardTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Valid Award Basis Payments
POST`/award/api/v1/valid-award-basis-payments/`

Example URI

POST /award/api/v1/valid-award-basis-payments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "validAwardBasisPaymentId": "(val)",
  "basisOfPaymentCode": "(val)",
  "awardTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "validAwardBasisPaymentId": "(val)",
  "basisOfPaymentCode": "(val)",
  "awardTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Valid Award Basis Payments
POST`/award/api/v1/valid-award-basis-payments/`

Example URI

POST /award/api/v1/valid-award-basis-payments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "validAwardBasisPaymentId": "(val)",
    "basisOfPaymentCode": "(val)",
    "awardTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validAwardBasisPaymentId": "(val)",
    "basisOfPaymentCode": "(val)",
    "awardTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "validAwardBasisPaymentId": "(val)",
    "basisOfPaymentCode": "(val)",
    "awardTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validAwardBasisPaymentId": "(val)",
    "basisOfPaymentCode": "(val)",
    "awardTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Valid Award Basis Payments by Key
DELETE`/award/api/v1/valid-award-basis-payments/(key)`

Example URI

DELETE /award/api/v1/valid-award-basis-payments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Valid Award Basis Payments
DELETE`/award/api/v1/valid-award-basis-payments/`

Example URI

DELETE /award/api/v1/valid-award-basis-payments/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Valid Award Basis Payments with Matching
DELETE`/award/api/v1/valid-award-basis-payments/`

Example URI

DELETE /award/api/v1/valid-award-basis-payments/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
validAwardBasisPaymentId: string (optional)
Valid Award Basis Payment Id. Maximum length is 22.
basisOfPaymentCode: string (optional)
Basis Of Payment Code. Maximum length is 3.
awardTypeCode: string (optional)
Award Type Code. Maximum length is 3.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Valid Basis Method Payments ¶

Get Valid Basis Method Payments by Key
GET`/award/api/v1/valid-basis-method-payments/(key)`

Example URI

GET /award/api/v1/valid-basis-method-payments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "validBasisMethodPaymentId": "(val)",
  "basisOfPaymentCode": "(val)",
  "methodOfPaymentCode": "(val)",
  "invInstructionsIndicator": "(val)",
  "_primaryKey": "(val)"
}

Get All Valid Basis Method Payments
GET`/award/api/v1/valid-basis-method-payments/`

Example URI

GET /award/api/v1/valid-basis-method-payments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "validBasisMethodPaymentId": "(val)",
    "basisOfPaymentCode": "(val)",
    "methodOfPaymentCode": "(val)",
    "invInstructionsIndicator": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validBasisMethodPaymentId": "(val)",
    "basisOfPaymentCode": "(val)",
    "methodOfPaymentCode": "(val)",
    "invInstructionsIndicator": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Valid Basis Method Payments with Filtering
GET`/award/api/v1/valid-basis-method-payments/`

Example URI

GET /award/api/v1/valid-basis-method-payments/

URI Parameters

HideShow

validBasisMethodPaymentId: string (optional)
Valid Basis Method Pmt Id. Maximum length is 22.
basisOfPaymentCode: string (optional)
Basis Of Payment Code. Maximum length is 22.
methodOfPaymentCode: string (optional)
Method Of Payment Code. Maximum length is 22.
invInstructionsIndicator: string (optional)
Inv Instructions Indicator. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "validBasisMethodPaymentId": "(val)",
    "basisOfPaymentCode": "(val)",
    "methodOfPaymentCode": "(val)",
    "invInstructionsIndicator": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validBasisMethodPaymentId": "(val)",
    "basisOfPaymentCode": "(val)",
    "methodOfPaymentCode": "(val)",
    "invInstructionsIndicator": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Valid Basis Method Payments
GET`/award/api/v1/valid-basis-method-payments/`

Example URI

GET /award/api/v1/valid-basis-method-payments/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "validBasisMethodPaymentId",
    "basisOfPaymentCode",
    "methodOfPaymentCode",
    "invInstructionsIndicator"
  ],
  "primaryKey": "validBasisMethodPaymentId"
}

Get Blueprint API specification for Valid Basis Method Payments
GET`/award/api/v1/valid-basis-method-payments/`

Example URI

GET /award/api/v1/valid-basis-method-payments/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Valid Basis Method Payments.md"
transfer-encoding: chunked

Update Valid Basis Method Payments
PUT`/award/api/v1/valid-basis-method-payments/(key)`

Example URI

PUT /award/api/v1/valid-basis-method-payments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "validBasisMethodPaymentId": "(val)",
  "basisOfPaymentCode": "(val)",
  "methodOfPaymentCode": "(val)",
  "invInstructionsIndicator": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Valid Basis Method Payments
PUT`/award/api/v1/valid-basis-method-payments/`

Example URI

PUT /award/api/v1/valid-basis-method-payments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "validBasisMethodPaymentId": "(val)",
    "basisOfPaymentCode": "(val)",
    "methodOfPaymentCode": "(val)",
    "invInstructionsIndicator": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validBasisMethodPaymentId": "(val)",
    "basisOfPaymentCode": "(val)",
    "methodOfPaymentCode": "(val)",
    "invInstructionsIndicator": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Valid Basis Method Payments
PATCH`/award/api/v1/valid-basis-method-payments/(key)`

Example URI

PATCH /award/api/v1/valid-basis-method-payments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "validBasisMethodPaymentId": "(val)",
  "basisOfPaymentCode": "(val)",
  "methodOfPaymentCode": "(val)",
  "invInstructionsIndicator": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "validBasisMethodPaymentId": "(val)",
  "basisOfPaymentCode": "(val)",
  "methodOfPaymentCode": "(val)",
  "invInstructionsIndicator": "(val)",
  "_primaryKey": "(val)"
}

Insert Valid Basis Method Payments
POST`/award/api/v1/valid-basis-method-payments/`

Example URI

POST /award/api/v1/valid-basis-method-payments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "validBasisMethodPaymentId": "(val)",
  "basisOfPaymentCode": "(val)",
  "methodOfPaymentCode": "(val)",
  "invInstructionsIndicator": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "validBasisMethodPaymentId": "(val)",
  "basisOfPaymentCode": "(val)",
  "methodOfPaymentCode": "(val)",
  "invInstructionsIndicator": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Valid Basis Method Payments
POST`/award/api/v1/valid-basis-method-payments/`

Example URI

POST /award/api/v1/valid-basis-method-payments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "validBasisMethodPaymentId": "(val)",
    "basisOfPaymentCode": "(val)",
    "methodOfPaymentCode": "(val)",
    "invInstructionsIndicator": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validBasisMethodPaymentId": "(val)",
    "basisOfPaymentCode": "(val)",
    "methodOfPaymentCode": "(val)",
    "invInstructionsIndicator": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "validBasisMethodPaymentId": "(val)",
    "basisOfPaymentCode": "(val)",
    "methodOfPaymentCode": "(val)",
    "invInstructionsIndicator": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validBasisMethodPaymentId": "(val)",
    "basisOfPaymentCode": "(val)",
    "methodOfPaymentCode": "(val)",
    "invInstructionsIndicator": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Valid Basis Method Payments by Key
DELETE`/award/api/v1/valid-basis-method-payments/(key)`

Example URI

DELETE /award/api/v1/valid-basis-method-payments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Valid Basis Method Payments
DELETE`/award/api/v1/valid-basis-method-payments/`

Example URI

DELETE /award/api/v1/valid-basis-method-payments/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Valid Basis Method Payments with Matching
DELETE`/award/api/v1/valid-basis-method-payments/`

Example URI

DELETE /award/api/v1/valid-basis-method-payments/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
validBasisMethodPaymentId: string (optional)
Valid Basis Method Pmt Id. Maximum length is 22.
basisOfPaymentCode: string (optional)
Basis Of Payment Code. Maximum length is 22.
methodOfPaymentCode: string (optional)
Method Of Payment Code. Maximum length is 22.
invInstructionsIndicator: string (optional)
Inv Instructions Indicator. Maximum length is 1.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Valid Class Report Frequencies ¶

Get Valid Class Report Frequencies by Key
GET`/award/api/v1/valid-class-report-frequencies/(key)`

Example URI

GET /award/api/v1/valid-class-report-frequencies/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "validClassReportFreqId": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "frequencyCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Valid Class Report Frequencies
GET`/award/api/v1/valid-class-report-frequencies/`

Example URI

GET /award/api/v1/valid-class-report-frequencies/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "validClassReportFreqId": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validClassReportFreqId": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Valid Class Report Frequencies with Filtering
GET`/award/api/v1/valid-class-report-frequencies/`

Example URI

GET /award/api/v1/valid-class-report-frequencies/

URI Parameters

HideShow

validClassReportFreqId: string (optional)
Valid Class Report Freq Id. Maximum length is 22.
reportClassCode: string (optional)
Report Class Code. Maximum length is 3.
reportCode: string (optional)
Report Code. Maximum length is 3.
frequencyCode: string (optional)
Frequency Code. Maximum length is 3.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "validClassReportFreqId": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validClassReportFreqId": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Valid Class Report Frequencies
GET`/award/api/v1/valid-class-report-frequencies/`

Example URI

GET /award/api/v1/valid-class-report-frequencies/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "validClassReportFreqId",
    "reportClassCode",
    "reportCode",
    "frequencyCode"
  ],
  "primaryKey": "validClassReportFreqId"
}

Get Blueprint API specification for Valid Class Report Frequencies
GET`/award/api/v1/valid-class-report-frequencies/`

Example URI

GET /award/api/v1/valid-class-report-frequencies/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Valid Class Report Frequencies.md"
transfer-encoding: chunked

Update Valid Class Report Frequencies
PUT`/award/api/v1/valid-class-report-frequencies/(key)`

Example URI

PUT /award/api/v1/valid-class-report-frequencies/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "validClassReportFreqId": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "frequencyCode": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Valid Class Report Frequencies
PUT`/award/api/v1/valid-class-report-frequencies/`

Example URI

PUT /award/api/v1/valid-class-report-frequencies/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "validClassReportFreqId": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validClassReportFreqId": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Valid Class Report Frequencies
PATCH`/award/api/v1/valid-class-report-frequencies/(key)`

Example URI

PATCH /award/api/v1/valid-class-report-frequencies/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "validClassReportFreqId": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "frequencyCode": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "validClassReportFreqId": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "frequencyCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Valid Class Report Frequencies
POST`/award/api/v1/valid-class-report-frequencies/`

Example URI

POST /award/api/v1/valid-class-report-frequencies/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "validClassReportFreqId": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "frequencyCode": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "validClassReportFreqId": "(val)",
  "reportClassCode": "(val)",
  "reportCode": "(val)",
  "frequencyCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Valid Class Report Frequencies
POST`/award/api/v1/valid-class-report-frequencies/`

Example URI

POST /award/api/v1/valid-class-report-frequencies/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "validClassReportFreqId": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validClassReportFreqId": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "validClassReportFreqId": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validClassReportFreqId": "(val)",
    "reportClassCode": "(val)",
    "reportCode": "(val)",
    "frequencyCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Valid Class Report Frequencies by Key
DELETE`/award/api/v1/valid-class-report-frequencies/(key)`

Example URI

DELETE /award/api/v1/valid-class-report-frequencies/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Valid Class Report Frequencies
DELETE`/award/api/v1/valid-class-report-frequencies/`

Example URI

DELETE /award/api/v1/valid-class-report-frequencies/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Valid Class Report Frequencies with Matching
DELETE`/award/api/v1/valid-class-report-frequencies/`

Example URI

DELETE /award/api/v1/valid-class-report-frequencies/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
validClassReportFreqId: string (optional)
Valid Class Report Freq Id. Maximum length is 22.
reportClassCode: string (optional)
Report Class Code. Maximum length is 3.
reportCode: string (optional)
Report Code. Maximum length is 3.
frequencyCode: string (optional)
Frequency Code. Maximum length is 3.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Valid Frequency Bases ¶

Get Valid Frequency Bases by Key
GET`/award/api/v1/valid-frequency-bases/(key)`

Example URI

GET /award/api/v1/valid-frequency-bases/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "validFrequencyBaseId": "(val)",
  "frequencyCode": "(val)",
  "frequencyBaseCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Valid Frequency Bases
GET`/award/api/v1/valid-frequency-bases/`

Example URI

GET /award/api/v1/valid-frequency-bases/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "validFrequencyBaseId": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validFrequencyBaseId": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Valid Frequency Bases with Filtering
GET`/award/api/v1/valid-frequency-bases/`

Example URI

GET /award/api/v1/valid-frequency-bases/

URI Parameters

HideShow

validFrequencyBaseId: string (optional)
Valid Frequency Base Id. Maximum length is 22.
frequencyCode: string (optional)
Frequency Code. Maximum length is 3.
frequencyBaseCode: string (optional)
Frequency Base Code. Maximum length is 3.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "validFrequencyBaseId": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validFrequencyBaseId": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Valid Frequency Bases
GET`/award/api/v1/valid-frequency-bases/`

Example URI

GET /award/api/v1/valid-frequency-bases/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "validFrequencyBaseId",
    "frequencyCode",
    "frequencyBaseCode"
  ],
  "primaryKey": "validFrequencyBaseId"
}

Get Blueprint API specification for Valid Frequency Bases
GET`/award/api/v1/valid-frequency-bases/`

Example URI

GET /award/api/v1/valid-frequency-bases/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Valid Frequency Bases.md"
transfer-encoding: chunked

Update Valid Frequency Bases
PUT`/award/api/v1/valid-frequency-bases/(key)`

Example URI

PUT /award/api/v1/valid-frequency-bases/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "validFrequencyBaseId": "(val)",
  "frequencyCode": "(val)",
  "frequencyBaseCode": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Valid Frequency Bases
PUT`/award/api/v1/valid-frequency-bases/`

Example URI

PUT /award/api/v1/valid-frequency-bases/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "validFrequencyBaseId": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validFrequencyBaseId": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Valid Frequency Bases
PATCH`/award/api/v1/valid-frequency-bases/(key)`

Example URI

PATCH /award/api/v1/valid-frequency-bases/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "validFrequencyBaseId": "(val)",
  "frequencyCode": "(val)",
  "frequencyBaseCode": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "validFrequencyBaseId": "(val)",
  "frequencyCode": "(val)",
  "frequencyBaseCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Valid Frequency Bases
POST`/award/api/v1/valid-frequency-bases/`

Example URI

POST /award/api/v1/valid-frequency-bases/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "validFrequencyBaseId": "(val)",
  "frequencyCode": "(val)",
  "frequencyBaseCode": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "validFrequencyBaseId": "(val)",
  "frequencyCode": "(val)",
  "frequencyBaseCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Valid Frequency Bases
POST`/award/api/v1/valid-frequency-bases/`

Example URI

POST /award/api/v1/valid-frequency-bases/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "validFrequencyBaseId": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validFrequencyBaseId": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "validFrequencyBaseId": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validFrequencyBaseId": "(val)",
    "frequencyCode": "(val)",
    "frequencyBaseCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Valid Frequency Bases by Key
DELETE`/award/api/v1/valid-frequency-bases/(key)`

Example URI

DELETE /award/api/v1/valid-frequency-bases/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Valid Frequency Bases
DELETE`/award/api/v1/valid-frequency-bases/`

Example URI

DELETE /award/api/v1/valid-frequency-bases/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Valid Frequency Bases with Matching
DELETE`/award/api/v1/valid-frequency-bases/`

Example URI

DELETE /award/api/v1/valid-frequency-bases/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
validFrequencyBaseId: string (optional)
Valid Frequency Base Id. Maximum length is 22.
frequencyCode: string (optional)
Frequency Code. Maximum length is 3.
frequencyBaseCode: string (optional)
Frequency Base Code. Maximum length is 3.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Valid Rates ¶

Get Valid Rates by Key
GET`/award/api/v1/valid-rates/(key)`

Example URI

GET /award/api/v1/valid-rates/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "validRatesId": "(val)",
  "onCampusRate": "(val)",
  "offCampusRate": "(val)",
  "rateClassType": "(val)",
  "adjustmentKey": "(val)",
  "icrRateCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Valid Rates
GET`/award/api/v1/valid-rates/`

Example URI

GET /award/api/v1/valid-rates/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "validRatesId": "(val)",
    "onCampusRate": "(val)",
    "offCampusRate": "(val)",
    "rateClassType": "(val)",
    "adjustmentKey": "(val)",
    "icrRateCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validRatesId": "(val)",
    "onCampusRate": "(val)",
    "offCampusRate": "(val)",
    "rateClassType": "(val)",
    "adjustmentKey": "(val)",
    "icrRateCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Valid Rates with Filtering
GET`/award/api/v1/valid-rates/`

Example URI

GET /award/api/v1/valid-rates/

URI Parameters

HideShow

validRatesId: string (optional)
Valid Rates Id. Maximum length is 22.
onCampusRate: string (optional)
On Campus Rate. Maximum length is 22.
offCampusRate: string (optional)
Off CampusContractContract Rate. Maximum length is 22.
rateClassType: string (optional)
Rate Class Type. Maximum length is 20.
adjustmentKey: string (optional)
Adjustment Key. Maximum length is 6.
icrRateCode: string (optional)
ICR Rate Code. Maximum length is 3.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "validRatesId": "(val)",
    "onCampusRate": "(val)",
    "offCampusRate": "(val)",
    "rateClassType": "(val)",
    "adjustmentKey": "(val)",
    "icrRateCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validRatesId": "(val)",
    "onCampusRate": "(val)",
    "offCampusRate": "(val)",
    "rateClassType": "(val)",
    "adjustmentKey": "(val)",
    "icrRateCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Valid Rates
GET`/award/api/v1/valid-rates/`

Example URI

GET /award/api/v1/valid-rates/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "validRatesId",
    "onCampusRate",
    "offCampusRate",
    "rateClassType",
    "adjustmentKey",
    "icrRateCode"
  ],
  "primaryKey": "validRatesId"
}

Get Blueprint API specification for Valid Rates
GET`/award/api/v1/valid-rates/`

Example URI

GET /award/api/v1/valid-rates/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Valid Rates.md"
transfer-encoding: chunked

Update Valid Rates
PUT`/award/api/v1/valid-rates/(key)`

Example URI

PUT /award/api/v1/valid-rates/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "validRatesId": "(val)",
  "onCampusRate": "(val)",
  "offCampusRate": "(val)",
  "rateClassType": "(val)",
  "adjustmentKey": "(val)",
  "icrRateCode": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Valid Rates
PUT`/award/api/v1/valid-rates/`

Example URI

PUT /award/api/v1/valid-rates/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "validRatesId": "(val)",
    "onCampusRate": "(val)",
    "offCampusRate": "(val)",
    "rateClassType": "(val)",
    "adjustmentKey": "(val)",
    "icrRateCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validRatesId": "(val)",
    "onCampusRate": "(val)",
    "offCampusRate": "(val)",
    "rateClassType": "(val)",
    "adjustmentKey": "(val)",
    "icrRateCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Valid Rates
PATCH`/award/api/v1/valid-rates/(key)`

Example URI

PATCH /award/api/v1/valid-rates/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "validRatesId": "(val)",
  "onCampusRate": "(val)",
  "offCampusRate": "(val)",
  "rateClassType": "(val)",
  "adjustmentKey": "(val)",
  "icrRateCode": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "validRatesId": "(val)",
  "onCampusRate": "(val)",
  "offCampusRate": "(val)",
  "rateClassType": "(val)",
  "adjustmentKey": "(val)",
  "icrRateCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Valid Rates
POST`/award/api/v1/valid-rates/`

Example URI

POST /award/api/v1/valid-rates/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "validRatesId": "(val)",
  "onCampusRate": "(val)",
  "offCampusRate": "(val)",
  "rateClassType": "(val)",
  "adjustmentKey": "(val)",
  "icrRateCode": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "validRatesId": "(val)",
  "onCampusRate": "(val)",
  "offCampusRate": "(val)",
  "rateClassType": "(val)",
  "adjustmentKey": "(val)",
  "icrRateCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Valid Rates
POST`/award/api/v1/valid-rates/`

Example URI

POST /award/api/v1/valid-rates/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "validRatesId": "(val)",
    "onCampusRate": "(val)",
    "offCampusRate": "(val)",
    "rateClassType": "(val)",
    "adjustmentKey": "(val)",
    "icrRateCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validRatesId": "(val)",
    "onCampusRate": "(val)",
    "offCampusRate": "(val)",
    "rateClassType": "(val)",
    "adjustmentKey": "(val)",
    "icrRateCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "validRatesId": "(val)",
    "onCampusRate": "(val)",
    "offCampusRate": "(val)",
    "rateClassType": "(val)",
    "adjustmentKey": "(val)",
    "icrRateCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validRatesId": "(val)",
    "onCampusRate": "(val)",
    "offCampusRate": "(val)",
    "rateClassType": "(val)",
    "adjustmentKey": "(val)",
    "icrRateCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Valid Rates by Key
DELETE`/award/api/v1/valid-rates/(key)`

Example URI

DELETE /award/api/v1/valid-rates/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Valid Rates
DELETE`/award/api/v1/valid-rates/`

Example URI

DELETE /award/api/v1/valid-rates/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Valid Rates with Matching
DELETE`/award/api/v1/valid-rates/`

Example URI

DELETE /award/api/v1/valid-rates/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation
validRatesId: string (optional)
Valid Rates Id. Maximum length is 22.
onCampusRate: string (optional)
On Campus Rate. Maximum length is 22.
offCampusRate: string (optional)
Off CampusContractContract Rate. Maximum length is 22.
rateClassType: string (optional)
Rate Class Type. Maximum length is 20.
adjustmentKey: string (optional)
Adjustment Key. Maximum length is 6.
icrRateCode: string (optional)
ICR Rate Code. Maximum length is 3.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Kuali Research REST APIs - Awards ¶

Research Awards ¶

Awards ¶

Get Awards by KeyGET/award/api/v1/awards/(key)

Example URI

Headers

Headers

Body

Get All AwardsGET/award/api/v1/awards/

Example URI

Headers

Headers

Body

Get All Awards with FilteringGET/award/api/v1/awards/

Example URI

Headers

Headers

Body

Get Schema for AwardsGET/award/api/v1/awards/

Example URI

Headers

Headers

Body

Get Blueprint API specification for AwardsGET/award/api/v1/awards/

Example URI

Headers

Headers

Update AwardsPUT/award/api/v1/awards/(key)

Example URI

Headers

Body

Update Multiple AwardsPUT/award/api/v1/awards/

Example URI

Headers

Body

Update Specific Attributes AwardsPATCH/award/api/v1/awards/(key)

Example URI

Headers

Body

Body

Insert AwardsPOST/award/api/v1/awards/

Example URI

Headers

Body

Body

Insert Multiple AwardsPOST/award/api/v1/awards/

Example URI

Headers

Body

Body

Delete Awards by KeyDELETE/award/api/v1/awards/(key)

Example URI

Headers

Delete All AwardsDELETE/award/api/v1/awards/

Example URI

Headers

Delete All Awards with MatchingDELETE/award/api/v1/awards/

Example URI

Headers

Award Amount Infos ¶

Get Award Amount Infos by KeyGET/award/api/v1/award-amount-infos/(key)

Example URI

Headers

Headers

Body

Get All Award Amount InfosGET/award/api/v1/award-amount-infos/

Example URI

Headers

Headers

Body

Get All Award Amount Infos with FilteringGET/award/api/v1/award-amount-infos/

Example URI

Headers

Headers

Body

Get Schema for Award Amount InfosGET/award/api/v1/award-amount-infos/

Example URI

Headers

Headers

Body

Kuali Research REST APIs - Awards

Get Awards by Key
GET`/award/api/v1/awards/(key)`

Get All Awards
GET`/award/api/v1/awards/`

Get All Awards with Filtering
GET`/award/api/v1/awards/`

Get Schema for Awards
GET`/award/api/v1/awards/`

Get Blueprint API specification for Awards
GET`/award/api/v1/awards/`

Update Awards
PUT`/award/api/v1/awards/(key)`

Update Multiple Awards
PUT`/award/api/v1/awards/`

Update Specific Attributes Awards
PATCH`/award/api/v1/awards/(key)`

Insert Awards
POST`/award/api/v1/awards/`

Insert Multiple Awards
POST`/award/api/v1/awards/`

Delete Awards by Key
DELETE`/award/api/v1/awards/(key)`

Delete All Awards
DELETE`/award/api/v1/awards/`

Delete All Awards with Matching
DELETE`/award/api/v1/awards/`

Get Award Amount Infos by Key
GET`/award/api/v1/award-amount-infos/(key)`

Get All Award Amount Infos
GET`/award/api/v1/award-amount-infos/`

Get All Award Amount Infos with Filtering
GET`/award/api/v1/award-amount-infos/`

Get Schema for Award Amount Infos
GET`/award/api/v1/award-amount-infos/`

Get Blueprint API specification for Award Amount Infos
GET`/award/api/v1/award-amount-infos/`

Update Award Amount Infos
PUT`/award/api/v1/award-amount-infos/(key)`

Update Multiple Award Amount Infos
PUT`/award/api/v1/award-amount-infos/`

Update Specific Attributes Award Amount Infos
PATCH`/award/api/v1/award-amount-infos/(key)`

Get Award Amount Transactions by Key
GET`/award/api/v1/award-amount-transactions/(key)`

Get All Award Amount Transactions
GET`/award/api/v1/award-amount-transactions/`

Get All Award Amount Transactions with Filtering
GET`/award/api/v1/award-amount-transactions/`

Get Schema for Award Amount Transactions
GET`/award/api/v1/award-amount-transactions/`

Get Blueprint API specification for Award Amount Transactions
GET`/award/api/v1/award-amount-transactions/`

Update Award Amount Transactions
PUT`/award/api/v1/award-amount-transactions/(key)`

Update Multiple Award Amount Transactions
PUT`/award/api/v1/award-amount-transactions/`

Update Specific Attributes Award Amount Transactions
PATCH`/award/api/v1/award-amount-transactions/(key)`

Insert Award Amount Transactions
POST`/award/api/v1/award-amount-transactions/`

Insert Multiple Award Amount Transactions
POST`/award/api/v1/award-amount-transactions/`

Delete Award Amount Transactions by Key
DELETE`/award/api/v1/award-amount-transactions/(key)`

Delete All Award Amount Transactions
DELETE`/award/api/v1/award-amount-transactions/`