{ "opencollection": "1.0.0", "info": { "name": "Core AccessGroup Site API", "version": "core" }, "items": [ { "info": { "name": "Site", "type": "folder" }, "items": [ { "info": { "name": "Retrieve changes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/directory/sites/changes", "params": [ { "name": "since", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" } ] }, "docs": "| Property| Description|\r\n| ------------------------------------------------- | ------------------------------------------------------------------------------------------------- |\r\n| GUID| The GUID associated to the site.|\r\n| Name| The site's name.|\r\n| Reference| An alternative name used for the site. Filterable|\r\n| FederalId| The site's local authority / government / tax reference.|\r\n| AnalysisCode| The site's analysis code|\r\n| UniqueCustomerSiteCode| The unique code assigned to the site if sys" }, { "info": { "name": "Find with GUID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/directory/sites/: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 site.|\r\n| Name| The site's name.|\r\n| Reference| An alternative name used for the site. Filterable|\r\n| FederalId| The site's local authority / government / tax reference.|\r\n| AnalysisCode| The site's analysis code|\r\n| UniqueCustomerSiteCode| The unique code assigned to the site if sys" }, { "info": { "name": "Partial update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/directory/sites/:guid", "params": [ { "name": "guid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "| Property| Description| Required |\r\n| ------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -------- |\r\n| GUID| The GUID associated to the site.| No |\r\n| Name| The site's name.| Yes |\r\n| Reference| An alternative name used for the site.| No |\r\n| FederalId| The site's local authority / government / tax reference.| No |\r\n| AnalysisCode| The site's analysis code.| No |\r\n| UniqueCustomerSi" }, { "info": { "name": "Find with Filters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/directory/sites", "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 site.|\r\n| Name| The site's name.|\r\n| Reference| An alternative name used for the site. Filterable|\r\n| FederalId| The site's local authority / government / tax reference.|\r\n| AnalysisCode| The site's analysis code|\r\n| UniqueCustomerSiteCode| The unique code assigned to the site if sys" }, { "info": { "name": "Create or update", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/directory/sites", "body": { "type": "json", "data": "{}" } }, "docs": "| Property | Description | Required |\r\n| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |\r\n| GUID| The GUID associated to the site.| No |\r\n| Name| The site's name.| Yes |\r\n| Reference| An alternative name used for the site.| No |\r\n| FederalId| The site's local authority / government / tax reference.| No |\r\n| An" } ] } ], "bundled": true }