GET districtsearch/TheftFraudStoreData/{searchTerm}?mailCode={mailCode}&year={year}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| mailCode | string |
Required |
|
| year | integer |
Required |
|
| searchTerm | string |
None. |
Body Parameters
None.
Response Information
Resource Description
TheftFraudStorePackage| Name | Description | Type | Additional information |
|---|---|---|---|
| StoreData | TheftFraudStoreFact |
None. |
|
| KeyMetrics | Collection of TheftFraudKeyMetric |
None. |
|
| AssociateFactsAPM | Collection of TheftFraudAssociateFact |
None. |
|
| AssociateFactsAPS | Collection of TheftFraudAssociateFact |
None. |
|
| RateFactItem | RateFact |
None. |
|
| ShrinkFacts | Collection of TheftFraudShrinkFact |
None. |
Response Formats
application/json, text/json
Sample:
{
"StoreData": {
"FacilityID": 1,
"OrgItem": "sample string 2",
"FiscalYear": 3,
"FiscalWeek": 4,
"InternalCount": 5.1,
"ExternalCount": 6.1,
"LYInternalCount": 7.1,
"LYExternalCount": 8.1,
"InternalDollars": 9.1,
"ExternalDollars": 10.1,
"LYInternalDollars": 11.1,
"LYExternalDollars": 12.1,
"LaborHours": 13.1,
"LYLaborHours": 14.1,
"SalesPlan": 15.1,
"LYSalesPlan": 16.1,
"ExternalAvgValue": 17.1,
"InternalAvgValue": 18.1,
"LYExternalAvgValue": 19.1,
"LYInternalAvgValue": 20.1,
"ExternalAppsMetric": 21.1,
"LYExternalAppsMetric": 22.1,
"InternalAppsMetric": 23.1,
"LYInternalAppsMetric": 24.1
},
"KeyMetrics": [
{
"FacilityID": 1,
"KeyMetric": "sample string 2",
"MetricValue": 3.1,
"LYMetricValue": 4.1,
"CompanyRank": 5,
"DivisionRank": 6,
"RegionRank": 7,
"DistrictRank": 8,
"CompanyCount": 9,
"DivisionCount": 10,
"RegionCount": 11,
"DistrictCount": 12
},
{
"FacilityID": 1,
"KeyMetric": "sample string 2",
"MetricValue": 3.1,
"LYMetricValue": 4.1,
"CompanyRank": 5,
"DivisionRank": 6,
"RegionRank": 7,
"DistrictRank": 8,
"CompanyCount": 9,
"DivisionCount": 10,
"RegionCount": 11,
"DistrictCount": 12
}
],
"AssociateFactsAPM": [
{
"UserID": "sample string 1",
"AssociateName": "sample string 2",
"Stores": "sample string 3",
"Division": "sample string 4",
"Region": "sample string 5",
"District": "sample string 6",
"Type": "sample string 7",
"InternalCount": 8.1,
"ExternalCount": 9.1,
"LYInternalCount": 10.1,
"LYExternalCount": 11.1,
"InternalDollars": 12.1,
"ExternalDollars": 13.1,
"LYInternalDollars": 14.1,
"LYExternalDollars": 15.1,
"LaborHours": 16.1,
"LYLaborHours": 17.1,
"SalesPlan": 18.1,
"LYSalesPlan": 19.1,
"ExternalAvgValue": 20.1,
"InternalAvgValue": 21.1,
"LYExternalAvgValue": 22.1,
"LYInternalAvgValue": 23.1,
"ExternalAppsMetric": 24.1,
"LYExternalAppsMetric": 25.1,
"InternalAppsMetric": 26.1,
"LYInternalAppsMetric": 27.1,
"PercentDifference": 28.1,
"CompanyRank": 29,
"DivisionRank": 30,
"RegionRank": 31,
"DistrictRank": 32,
"CompanyCount": 33,
"DivisionCount": 34,
"RegionCount": 35,
"DistrictCount": 36,
"BeginDate": "2025-05-02T23:02:45.2842321-04:00",
"CurriculumPastDue": [
"sample string 1",
"sample string 2"
],
"ShrinkFacts": [
{
"FacilityID": 1,
"MailCode": "sample string 2",
"Division": "sample string 3",
"Region": "sample string 4",
"District": "sample string 5",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"InventoryDate": "2025-05-02T23:02:45.2842321-04:00",
"TYShrinkGoal": 1.1,
"LYShrinkGoal": 1.1,
"TYSalesGoal": 1.1,
"LYSalesGoal": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1
},
{
"FacilityID": 1,
"MailCode": "sample string 2",
"Division": "sample string 3",
"Region": "sample string 4",
"District": "sample string 5",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"InventoryDate": "2025-05-02T23:02:45.2842321-04:00",
"TYShrinkGoal": 1.1,
"LYShrinkGoal": 1.1,
"TYSalesGoal": 1.1,
"LYSalesGoal": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1
}
],
"RoutineReporting": {
"Entity": "sample string 1",
"EntityType": "sample string 2",
"FiscalYear": 3,
"FiscalPeriod": 4,
"Daily": 1.1,
"Weekly": 1.1,
"Quarterly": 1.1,
"Monthly": 1.1,
"Overnight": 1.1,
"Total": 1.1,
"ReportingType": "sample string 5"
},
"CaseDetails": [
{
"MailCode": "sample string 1",
"Division": "sample string 2",
"Region": "sample string 3",
"District": "sample string 4",
"IICE_ID": "sample string 5",
"EventDate": "2025-05-02T23:02:45.2842321-04:00",
"EventSubType": "sample string 7",
"CaseValue": 1.1,
"Category": "sample string 8"
},
{
"MailCode": "sample string 1",
"Division": "sample string 2",
"Region": "sample string 3",
"District": "sample string 4",
"IICE_ID": "sample string 5",
"EventDate": "2025-05-02T23:02:45.2842321-04:00",
"EventSubType": "sample string 7",
"CaseValue": 1.1,
"Category": "sample string 8"
}
],
"APCertFlag": "sample string 38",
"APCertDate": "2025-05-02T23:02:45.2842321-04:00"
},
{
"UserID": "sample string 1",
"AssociateName": "sample string 2",
"Stores": "sample string 3",
"Division": "sample string 4",
"Region": "sample string 5",
"District": "sample string 6",
"Type": "sample string 7",
"InternalCount": 8.1,
"ExternalCount": 9.1,
"LYInternalCount": 10.1,
"LYExternalCount": 11.1,
"InternalDollars": 12.1,
"ExternalDollars": 13.1,
"LYInternalDollars": 14.1,
"LYExternalDollars": 15.1,
"LaborHours": 16.1,
"LYLaborHours": 17.1,
"SalesPlan": 18.1,
"LYSalesPlan": 19.1,
"ExternalAvgValue": 20.1,
"InternalAvgValue": 21.1,
"LYExternalAvgValue": 22.1,
"LYInternalAvgValue": 23.1,
"ExternalAppsMetric": 24.1,
"LYExternalAppsMetric": 25.1,
"InternalAppsMetric": 26.1,
"LYInternalAppsMetric": 27.1,
"PercentDifference": 28.1,
"CompanyRank": 29,
"DivisionRank": 30,
"RegionRank": 31,
"DistrictRank": 32,
"CompanyCount": 33,
"DivisionCount": 34,
"RegionCount": 35,
"DistrictCount": 36,
"BeginDate": "2025-05-02T23:02:45.2842321-04:00",
"CurriculumPastDue": [
"sample string 1",
"sample string 2"
],
"ShrinkFacts": [
{
"FacilityID": 1,
"MailCode": "sample string 2",
"Division": "sample string 3",
"Region": "sample string 4",
"District": "sample string 5",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"InventoryDate": "2025-05-02T23:02:45.2842321-04:00",
"TYShrinkGoal": 1.1,
"LYShrinkGoal": 1.1,
"TYSalesGoal": 1.1,
"LYSalesGoal": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1
},
{
"FacilityID": 1,
"MailCode": "sample string 2",
"Division": "sample string 3",
"Region": "sample string 4",
"District": "sample string 5",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"InventoryDate": "2025-05-02T23:02:45.2842321-04:00",
"TYShrinkGoal": 1.1,
"LYShrinkGoal": 1.1,
"TYSalesGoal": 1.1,
"LYSalesGoal": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1
}
],
"RoutineReporting": {
"Entity": "sample string 1",
"EntityType": "sample string 2",
"FiscalYear": 3,
"FiscalPeriod": 4,
"Daily": 1.1,
"Weekly": 1.1,
"Quarterly": 1.1,
"Monthly": 1.1,
"Overnight": 1.1,
"Total": 1.1,
"ReportingType": "sample string 5"
},
"CaseDetails": [
{
"MailCode": "sample string 1",
"Division": "sample string 2",
"Region": "sample string 3",
"District": "sample string 4",
"IICE_ID": "sample string 5",
"EventDate": "2025-05-02T23:02:45.2842321-04:00",
"EventSubType": "sample string 7",
"CaseValue": 1.1,
"Category": "sample string 8"
},
{
"MailCode": "sample string 1",
"Division": "sample string 2",
"Region": "sample string 3",
"District": "sample string 4",
"IICE_ID": "sample string 5",
"EventDate": "2025-05-02T23:02:45.2842321-04:00",
"EventSubType": "sample string 7",
"CaseValue": 1.1,
"Category": "sample string 8"
}
],
"APCertFlag": "sample string 38",
"APCertDate": "2025-05-02T23:02:45.2842321-04:00"
}
],
"AssociateFactsAPS": [
{
"UserID": "sample string 1",
"AssociateName": "sample string 2",
"Stores": "sample string 3",
"Division": "sample string 4",
"Region": "sample string 5",
"District": "sample string 6",
"Type": "sample string 7",
"InternalCount": 8.1,
"ExternalCount": 9.1,
"LYInternalCount": 10.1,
"LYExternalCount": 11.1,
"InternalDollars": 12.1,
"ExternalDollars": 13.1,
"LYInternalDollars": 14.1,
"LYExternalDollars": 15.1,
"LaborHours": 16.1,
"LYLaborHours": 17.1,
"SalesPlan": 18.1,
"LYSalesPlan": 19.1,
"ExternalAvgValue": 20.1,
"InternalAvgValue": 21.1,
"LYExternalAvgValue": 22.1,
"LYInternalAvgValue": 23.1,
"ExternalAppsMetric": 24.1,
"LYExternalAppsMetric": 25.1,
"InternalAppsMetric": 26.1,
"LYInternalAppsMetric": 27.1,
"PercentDifference": 28.1,
"CompanyRank": 29,
"DivisionRank": 30,
"RegionRank": 31,
"DistrictRank": 32,
"CompanyCount": 33,
"DivisionCount": 34,
"RegionCount": 35,
"DistrictCount": 36,
"BeginDate": "2025-05-02T23:02:45.2842321-04:00",
"CurriculumPastDue": [
"sample string 1",
"sample string 2"
],
"ShrinkFacts": [
{
"FacilityID": 1,
"MailCode": "sample string 2",
"Division": "sample string 3",
"Region": "sample string 4",
"District": "sample string 5",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"InventoryDate": "2025-05-02T23:02:45.2842321-04:00",
"TYShrinkGoal": 1.1,
"LYShrinkGoal": 1.1,
"TYSalesGoal": 1.1,
"LYSalesGoal": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1
},
{
"FacilityID": 1,
"MailCode": "sample string 2",
"Division": "sample string 3",
"Region": "sample string 4",
"District": "sample string 5",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"InventoryDate": "2025-05-02T23:02:45.2842321-04:00",
"TYShrinkGoal": 1.1,
"LYShrinkGoal": 1.1,
"TYSalesGoal": 1.1,
"LYSalesGoal": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1
}
],
"RoutineReporting": {
"Entity": "sample string 1",
"EntityType": "sample string 2",
"FiscalYear": 3,
"FiscalPeriod": 4,
"Daily": 1.1,
"Weekly": 1.1,
"Quarterly": 1.1,
"Monthly": 1.1,
"Overnight": 1.1,
"Total": 1.1,
"ReportingType": "sample string 5"
},
"CaseDetails": [
{
"MailCode": "sample string 1",
"Division": "sample string 2",
"Region": "sample string 3",
"District": "sample string 4",
"IICE_ID": "sample string 5",
"EventDate": "2025-05-02T23:02:45.2842321-04:00",
"EventSubType": "sample string 7",
"CaseValue": 1.1,
"Category": "sample string 8"
},
{
"MailCode": "sample string 1",
"Division": "sample string 2",
"Region": "sample string 3",
"District": "sample string 4",
"IICE_ID": "sample string 5",
"EventDate": "2025-05-02T23:02:45.2842321-04:00",
"EventSubType": "sample string 7",
"CaseValue": 1.1,
"Category": "sample string 8"
}
],
"APCertFlag": "sample string 38",
"APCertDate": "2025-05-02T23:02:45.2842321-04:00"
},
{
"UserID": "sample string 1",
"AssociateName": "sample string 2",
"Stores": "sample string 3",
"Division": "sample string 4",
"Region": "sample string 5",
"District": "sample string 6",
"Type": "sample string 7",
"InternalCount": 8.1,
"ExternalCount": 9.1,
"LYInternalCount": 10.1,
"LYExternalCount": 11.1,
"InternalDollars": 12.1,
"ExternalDollars": 13.1,
"LYInternalDollars": 14.1,
"LYExternalDollars": 15.1,
"LaborHours": 16.1,
"LYLaborHours": 17.1,
"SalesPlan": 18.1,
"LYSalesPlan": 19.1,
"ExternalAvgValue": 20.1,
"InternalAvgValue": 21.1,
"LYExternalAvgValue": 22.1,
"LYInternalAvgValue": 23.1,
"ExternalAppsMetric": 24.1,
"LYExternalAppsMetric": 25.1,
"InternalAppsMetric": 26.1,
"LYInternalAppsMetric": 27.1,
"PercentDifference": 28.1,
"CompanyRank": 29,
"DivisionRank": 30,
"RegionRank": 31,
"DistrictRank": 32,
"CompanyCount": 33,
"DivisionCount": 34,
"RegionCount": 35,
"DistrictCount": 36,
"BeginDate": "2025-05-02T23:02:45.2842321-04:00",
"CurriculumPastDue": [
"sample string 1",
"sample string 2"
],
"ShrinkFacts": [
{
"FacilityID": 1,
"MailCode": "sample string 2",
"Division": "sample string 3",
"Region": "sample string 4",
"District": "sample string 5",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"InventoryDate": "2025-05-02T23:02:45.2842321-04:00",
"TYShrinkGoal": 1.1,
"LYShrinkGoal": 1.1,
"TYSalesGoal": 1.1,
"LYSalesGoal": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1
},
{
"FacilityID": 1,
"MailCode": "sample string 2",
"Division": "sample string 3",
"Region": "sample string 4",
"District": "sample string 5",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"InventoryDate": "2025-05-02T23:02:45.2842321-04:00",
"TYShrinkGoal": 1.1,
"LYShrinkGoal": 1.1,
"TYSalesGoal": 1.1,
"LYSalesGoal": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1
}
],
"RoutineReporting": {
"Entity": "sample string 1",
"EntityType": "sample string 2",
"FiscalYear": 3,
"FiscalPeriod": 4,
"Daily": 1.1,
"Weekly": 1.1,
"Quarterly": 1.1,
"Monthly": 1.1,
"Overnight": 1.1,
"Total": 1.1,
"ReportingType": "sample string 5"
},
"CaseDetails": [
{
"MailCode": "sample string 1",
"Division": "sample string 2",
"Region": "sample string 3",
"District": "sample string 4",
"IICE_ID": "sample string 5",
"EventDate": "2025-05-02T23:02:45.2842321-04:00",
"EventSubType": "sample string 7",
"CaseValue": 1.1,
"Category": "sample string 8"
},
{
"MailCode": "sample string 1",
"Division": "sample string 2",
"Region": "sample string 3",
"District": "sample string 4",
"IICE_ID": "sample string 5",
"EventDate": "2025-05-02T23:02:45.2842321-04:00",
"EventSubType": "sample string 7",
"CaseValue": 1.1,
"Category": "sample string 8"
}
],
"APCertFlag": "sample string 38",
"APCertDate": "2025-05-02T23:02:45.2842321-04:00"
}
],
"RateFactItem": {
"EntityType": "sample string 1",
"EntityName": "sample string 2",
"OSHARate": 3.1,
"LTRate": 4.1,
"GLBIRate": 5.1,
"LYOSHARate": 6.1,
"LYLTRate": 7.1,
"LYGLBIRate": 8.1,
"OSHADifferential": 9.1,
"OSHAPlan": 10.1,
"GLBIDifferentialLY": 11.1
},
"ShrinkFacts": [
{
"FacilityID": 1,
"MailCode": "sample string 2",
"Division": "sample string 3",
"Region": "sample string 4",
"District": "sample string 5",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"InventoryDate": "2025-05-02T23:02:45.2842321-04:00",
"TYShrinkGoal": 1.1,
"LYShrinkGoal": 1.1,
"TYSalesGoal": 1.1,
"LYSalesGoal": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1
},
{
"FacilityID": 1,
"MailCode": "sample string 2",
"Division": "sample string 3",
"Region": "sample string 4",
"District": "sample string 5",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"InventoryDate": "2025-05-02T23:02:45.2842321-04:00",
"TYShrinkGoal": 1.1,
"LYShrinkGoal": 1.1,
"TYSalesGoal": 1.1,
"LYSalesGoal": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1
}
]
}