643 matches
13 actions
Prime ReportStream
13 actions
- delete_settings_organizations_organizationNameDELETEv1.0.0
- delete_settings_organizations_organizationName_receivers_receiverNameDELETEv1.0.0
- delete_settings_organizations_organizationName_senders_senderNameDELETEv1.0.0
- get_settings_organizationsGETv1.0.0
- get_settings_organizations_organizationNameGETv1.0.0
- get_settings_organizations_organizationName_receiversGETv1.0.0
- get_settings_organizations_organizationName_receivers_receiverNameGETv1.0.0
- get_settings_organizations_organizationName_sendersGETv1.0.0
- get_settings_organizations_organizationName_senders_senderNameGETv1.0.0
- Post a report to the data hubPOSTv1.0.0
- put_settings_organizations_organizationNamePUTv1.0.0
- put_settings_organizations_organizationName_receivers_receiverNamePUTv1.0.0
- put_settings_organizations_organizationName_senders_senderNamePUTv1.0.0
Other/Prime ReportStream
Post a report to the data hub
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
{
"type": "object",
"properties": {
"client": {
"type": "string"
},
"default": {
"type": "array",
"items": {
"type": "string"
}
},
"option": {
"type": "string",
"enum": [
"ValidatePayload",
"CheckConnections",
"SendImmediately",
"SkipSend",
"SkipInvalidItems"
]
},
"routeTo": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"client"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
{
"type": "object",
"required": [
"id"
],
"properties": {
"destinationCount": {
"type": "integer",
"description": "total destinations recieving the report(s)"
},
"destinations": {
"type": "array",
"description": "where the report is being sent to",
"items": {
"type": "object",
"properties": {
"itemCount": {
"type": "integer",
"description": "The number of reports being sent to this destination"
},
"organization": {
"type": "string",
"description": "The name of the organization reciving the report"
},
"organization_id": {
"type": "string",
"description": "The organization id (i.e. {state abbreviation}-phd)"
},
"sending_at": {
"type": "string",
"format": "date-time",
"description": "The time at which the report will be sent"
},
"service": {
"type": "string",
"description": "The service used for delivering the report"
}
}
}
},
"errorCount": {
"type": "integer",
"description": "total errors found during initial validation. There may be multiple errors per item."
},
"errors": {
"type": "array",
"description": "a list of errors in the report",
"items": {
"type": "object",
"properties": {
"detail": {
"type": "string",
"description": "The details of the error"
},
"id": {
"type": "string",
"description": "Depends on scope, either the item's id (message_id) or the report's id"
},
"scope": {
"type": "string",
"description": "Does the error apply to one item",
"enum": [
"Parameter",
"Report",
"Item"
]
}
}
}
},
"id": {
"type": "string",
"description": "the id for the report assigned by the Hub"
},
"reportItemCount": {
"type": "integer",
"description": "total number of individual reports sent to the Hub (in a csv, the number of data lines sent)"
},
"routing": {
"type": "array",
"description": "The receiver destination names for each item in the report. This is displayed when verbose=true is present on the query string.",
"items": {
"type": "object",
"properties": {
"destinations": {
"type": "array",
"description": "The organization and service destinations",
"items": {
"type": "string"
}
},
"reportIndex": {
"type": "integer",
"description": "the index of the item in the submitted report (0 based)"
},
"trackingId": {
"type": "string",
"description": "The tracking id provided by the sender defined in the schema, null otherwise"
}
}
}
},
"timestamp": {
"type": "string",
"format": "time-date",
"description": "the timestamp for this report submission"
},
"topic": {
"type": "string",
"description": "the topic configured for the client organization sender"
},
"warningCount": {
"type": "integer",
"description": "total warnings found during initial validation. There may be multiple warnings per item."
},
"warnings": {
"type": "array",
"description": "a list of warnings in the report",
"items": {
"type": "object",
"properties": {
"detail": {
"type": "string",
"description": "The details of the error"
},
"id": {
"type": "string",
"description": "Depends on scope, either the item's id (message_id) or the report's id"
},
"scope": {
"type": "string",
"description": "Does the error apply to one item",
"enum": [
"Parameter",
"Report",
"Item"
]
}
}
}
}
}
}