{ "opencollection": "1.0.0", "info": { "name": "Core AccessGroup Outlet API", "version": "core" }, "items": [ { "info": { "name": "Outlet", "type": "folder" }, "items": [ { "info": { "name": "Find with GUID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/outlets/:guid", "params": [ { "name": "guid", "value": "", "type": "path" }, { "name": "udf", "value": "", "type": "query" } ] }, "docs": "| Property | Description|\r\n| ------------------------- | ----------------------------------------------------------------------------- |\r\n| GUID | The GUID associated to the outlet|\r\n| Description | The description of the outlet|\r\n| IsDeleted | Whether the outlet is deleted |\r\n| AbbreviatedDescription | The abbreviated description of the outlet|\r\n| AnalysisCode | The analysis code of the outlet|\r\n| CompanyListIt" }, { "info": { "name": "Find with Filters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/outlets", "params": [ { "name": "filter", "value": "", "type": "query" }, { "name": "max", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "includeCount", "value": "", "type": "query" }, { "name": "udf", "value": "", "type": "query" } ] }, "docs": "| Property | Description|\r\n| ------------------------- | ----------------------------------------------------------------------------- |\r\n| GUID | The GUID associated to the outlet|\r\n| Description | The description of the outlet|\r\n| IsDeleted | Whether the outlet is deleted |\r\n| AbbreviatedDescription | The abbreviated description of the outlet|\r\n| AnalysisCode | The analysis code of the outlet|\r\n| CompanyListIt" }, { "info": { "name": "Find with GUID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/integrator/lists/outlets/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "links", "value": "", "type": "query" }, { "name": "include", "value": "", "type": "query" }, { "name": "expand", "value": "", "type": "query" }, { "name": "udf", "value": "", "type": "query" } ] }, "docs": "| Property | Description |\r\n| ---------------------------------------------------- | ---------------------------------------------------------------------------------- |\r\n| GUID | The GUID associated to the outlet |\r\n| Description | The descriptio" }, { "info": { "name": "Find with Filters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/integrator/lists/outlets", "params": [ { "name": "filter", "value": "", "type": "query" }, { "name": "search", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "max", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "includeCount", "value": "", "type": "query" }, { "name": "includeDeleted", "value": "", "type": "query" }, { "name": "links", "value": "", "type": "query" }, { "name": "udf", "value": "", "type": "query" } ] }, "docs": "| Property | Description |\r\n| ---------------------------------------------------- | ---------------------------------------------------------------------------------- |\r\n| GUID | The GUID associated to the outlet |\r\n| Description | The descriptio" }, { "info": { "name": "Create or Update an Outlet", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/visionai/api/integrator/outlets", "body": { "type": "json", "data": "{}" } }, "docs": "# Create or Update an Outlet\r\n\r\n| Parameter | Type | Description |\r\n|-------------|--------|----------------------------------|\r\n| OutletId | GUID | ID of the Outlet |\r\n| OutletName | string | Display name |\r\n| IsDeleted | bool | Outlet is no longer in use |\r\n\r\n## Sample API Requests\r\n\r\n```\r\n{\r\n \"OutletId\": \"B3E43C4D-BC76-4E59-9E2E-25BC33EA2EC4\",\r\n \"OutletName\": \"Primary Company Outlet\",\r\n \"IsDeleted\": false\r\n}\r\n```" } ] } ], "bundled": true }