GET/Coverage
Lists every resource need on the event with how well it is covered: needed, secured, awaiting and
tentative quantities, a coverage status, what has been assigned and received, and the reservations,
order lines and receipts behind each figure. Use this to see which needs are still open; for the same
view across all of an organization's events, use Coverage_GetOrganizationCoverage. The
procurementResourceId on each row is the need's id.
Response
Type: GetCoverageResponse[]
GetCoverageResponse
| Field | Type | Description |
|---|
| procurementResourceId | uuid | |
| procurementId | uuid| null | |
| procurement | GetCoverageResponseProcurementInfo | |
| group | GetCoverageResponseGroupInfo | |
| type | GetCoverageResponseTypeInfo | |
| parentProcurementResourceId | uuid| null | |
| componentId | uuid| null | |
| componentLabel | string| null | |
| parentLabel | string| null | |
| isCompositeParent | boolean | |
| compositeCoverage | CompositeCoverageInfo | |
| neededQuantity | number | |
| securedQuantity | number | |
| awaitingQuantity | number | |
| tentativeQuantity | number | |
| coverageStatus | string| null | |
| assignedQuantity | number | |
| assignedCoverage | string| null | |
| receivedQuantity | number | |
| receivedCoverage | string| null | |
| orderingStatus | string| null | |
| changeStatus | string| null | |
| changes | GetCoverageResponseChangeInfo[]| null | |
| receipts | GetCoverageResponseReceiptInfo[]| null | |
| orderLines | GetCoverageResponseOrderLineInfo[]| null | |
| reservations | GetCoverageResponseReservationInfo[]| null | |
GetCoverageResponseProcurementInfo
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
GetCoverageResponseGroupInfo
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
| index | integer | |
GetCoverageResponseTypeInfo
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
| trackingType | string| null | |
| icon | string| null | |
| color | string| null | |
CompositeCoverageInfo
| Field | Type | Description |
|---|
| fulfilledUnits | number | |
| openUnits | number | |
| isFilled | boolean | |
| status | string| null | |
| perComponent | CompositeCoverageInfoComponentInfo[]| null | |
GetCoverageResponseChangeInfo
| Field | Type | Description |
|---|
| source | string| null | |
| sourceId | uuid | |
| phrasing | string| null | |
GetCoverageResponseReceiptInfo
| Field | Type | Description |
|---|
| fulfillmentId | uuid | |
| fulfillmentName | string| null | |
| itemId | uuid | |
| quantity | number | |
GetCoverageResponseOrderLineInfo
| Field | Type | Description |
|---|
| id | uuid | |
| quantity | number | |
| groupName | string| null | |
| order | GetCoverageResponseOrderInfo | |
GetCoverageResponseReservationInfo
| Field | Type | Description |
|---|
| id | uuid | |
| status | string| null | |
| needsReview | boolean | |
| origin | string| null | |
| quantity | number| null | |
| resource | GetCoverageResponseResourceInfo | |
CompositeCoverageInfoComponentInfo
| Field | Type | Description |
|---|
| childId | uuid | |
| componentId | uuid| null | |
| label | string| null | |
| neededQuantity | number | |
| securedQuantity | number | |
| awaitingQuantity | number | |
| tentativeQuantity | number | |
| status | string| null | |
GetCoverageResponseOrderInfo
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
GetCoverageResponseResourceInfo
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
| label | string| null | |
| identifier | string| null | |
| crewId | uuid| null | |