Get Organization Coverage Documentation

GET/organizations/{orgId}/coverage

Lists the resource needs of every event in the organization with the same coverage figures as Coverage_GetCoverage, plus the event each need belongs to. Archived events are left out unless includeArchived is true. Requires organization basic access. Not bounded by date, so needs with no window of their own are included.

Path Parameters

Field	Type	Required	Description
orgId	uuid	Required

Query Parameters

Field	Type	Required	Description
includeArchived	boolean	Optional

Response

Type: GetOrganizationCoverageResponse[]

GetOrganizationCoverageResponse

Field	Type	Description
procurementResourceId	uuid
procurementId	uuid\| null
procurement	GetOrganizationCoverageResponseProcurementInfo
group	GetOrganizationCoverageResponseGroupInfo
type	GetOrganizationCoverageResponseTypeInfo
event	GetOrganizationCoverageResponseEventInfo
owner	uuid\| null
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	GetOrganizationCoverageResponseChangeInfo[]\| null
receipts	GetOrganizationCoverageResponseReceiptInfo[]\| null
orderLines	GetOrganizationCoverageResponseOrderLineInfo[]\| null
reservations	GetOrganizationCoverageResponseReservationInfo[]\| null

GetOrganizationCoverageResponseProcurementInfo

Field	Type	Description
id	uuid
name	string\| null

GetOrganizationCoverageResponseGroupInfo

Field	Type	Description
id	uuid
name	string\| null
index	integer

GetOrganizationCoverageResponseTypeInfo

Field	Type	Description
id	uuid
name	string\| null
trackingType	string\| null
icon	string\| null
color	string\| null

GetOrganizationCoverageResponseEventInfo

Field	Type	Description
id	uuid
name	string\| null

CompositeCoverageInfo

Field	Type	Description
fulfilledUnits	number
openUnits	number
isFilled	boolean
status	string\| null
perComponent	CompositeCoverageInfoComponentInfo[]\| null

GetOrganizationCoverageResponseChangeInfo

Field	Type	Description
source	string\| null
sourceId	uuid
phrasing	string\| null

GetOrganizationCoverageResponseReceiptInfo

Field	Type	Description
fulfillmentId	uuid
fulfillmentName	string\| null
itemId	uuid
quantity	number

GetOrganizationCoverageResponseOrderLineInfo

Field	Type	Description
id	uuid
quantity	number
groupName	string\| null
order	GetOrganizationCoverageResponseOrderInfo

GetOrganizationCoverageResponseReservationInfo

Field	Type	Description
id	uuid
status	string\| null
needsReview	boolean
origin	string\| null
quantity	number\| null
resource	GetOrganizationCoverageResponseResourceInfo

CompositeCoverageInfoComponentInfo

Field	Type	Description
childId	uuid
componentId	uuid\| null
label	string\| null
neededQuantity	number
securedQuantity	number
awaitingQuantity	number
tentativeQuantity	number
status	string\| null

GetOrganizationCoverageResponseOrderInfo

Field	Type	Description
id	uuid
name	string\| null

GetOrganizationCoverageResponseResourceInfo

Field	Type	Description
id	uuid
name	string\| null
label	string\| null
identifier	string\| null
crewId	uuid\| null