AMCS Group RouteTemplate API

openapi: 3.2.0
info:
  title: Core AccessGroup Route Template API
  version: core
servers:
- url: https://rstapi-sbx-svc-core.amcsplatform.com/erp/api/integrator/erp
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: RouteTemplate
paths:
  /transport/routeTemplates/changes:
    get:
      tags:
      - RouteTemplate
      summary: Retrieve changes
      description: "| Property| Description|\n| --------------------------------------------- | ----------------------------------------------------------------------------------------------------- |\n| GUID| The GUID associated to the route.|\n| AcceptedMaterials| An array of accepted materials.|\n| AcceptedMaterials[0].Guid| The GUID of accepted material.|\n| AcceptedMaterials[0].IsDeleted| Whether accepted material is deleted.|\n| AcceptedMaterials[0].MaterialClassListItem| The GUID and Description of material class|\n| ArchiveMissedRouteVisitReasonListItem| The GUID and description of the archive missed route visit reason associated to the route template. |\n| ArchiveRouteVisitDays| The archive route visit days associated to the route template.|\n| AreaOfOriginListItem| The GUID and description of the area of origin associated to the route template. |\n| AuditDays| The audit days associated to the route template.|\n| AuditStartDate| The audit start date associated to the route template.|\n| AutoCompleteVisits| Whether auto complete visits associated to the route template.| \n| AutoSend| Whether auto send associated to the route template.| \n| BuildDaysBeforeNextPlannedDate| The build days before next planned date associated to the route template.| \n| BuildSimpleRouteInstance| Whether build simple route instance associated to the route template.| \n| CanRunOnSchedule| Whether can run on schedule associated to the route template.| \n| CompanyOutletListItem| The GUID and description of the company outlet associated to the route template. |\n| DayOccurrenceInMonthListItem| The GUID and description of the day occurrence in month associated to the route template. |\n| DayOfWeekListItem| The GUID and description of the day of week associated to the route template. |\n| DaysBeforeExpiry| The days before expiry associated to the route template.| \n| DefaultTipMaterialListItem| The GUID and description of the material associated to the route template. |\n| Description| The description associated to the route.|\n| DiffReasonRequired| Whether different reason required associated to the route template.|\n| DoubleDumpTimeInSeconds| The double dump time in seconds associated to the route template.|\n| ExcludeMunicipalCustomerFromHandheld| Whether exclude municipal customer from handheld associated to the route template.|\n| ExcludeMunicipalCustomerFromRouteConfirmation| Whether exclude municipal customer from route confirmation associated to the route template.|\n| ExcludeMunicipalCustomerFromRouteWorksheet| Whether exclude municipal customer from route worksheet associated to the route template.|\n| ForceWeightsOnRouteCompletion| Whether force weights on route completion associated to the route template.|\n| GPSMatchingEnabled| Whether GPS matching enabled associated to the route template.|\n| GpsMatchingMaxRange| The Gps matching max range associated to the route.|\n| GpsmatchingMinProximity| The Gps matching min proximity associated to the route.|\n| GuidedNavigationPassword| The guided navigation password associated to the route.|\n| GuidedNavigationUsername| The guided navigation username associated to the route.|\n| GuideVersion| The guide version associated to the route.|\n| HideTipLocationMapMarkers| Whether hide tip location map markers associated to the route template.|\n| IsAutoCompleteOnBuild| Whether the route template is auto complete on build.|\n| IsDeleted| Whether the route template is deleted.|\n| IsNightRoute| Whether the route template is for night route.|\n| IsProximityOrderedVisits| Whether the route template is proximity ordered visits.|\n| IsRouteNavigationEnabled| Whether the route template has route navigation enabled.|\n| IsRouteStatisticGenerationOn| Whether the route template is route statistic generation is On.|\n| IsSubContracted| Whether the route template is sub contracted.|\n| MarketListItem| The GUID and description of the market associated to the route template. |\n| MissedReasonRequired| Whether the missed reason is required for route template.|\n| MobileForceManualLiftMatching| Whether the mobile force manual lift matching for route template.|\n| MobileSettingsProfileListItem| The GUID and description of the mobile settings profile associated to the route template.|\n| NextPlannedDate| The next planned date associated to the route template.|\n| NoMatchAlertThreshold| The No match alert threshold to the route template.|\n| NoTagStopEnabled| Whether the route template has no tag stop enabled.|\n| Notes| The notes associated to the route template.|\n| PickupIntervalListItem| The GUID and description of the pick up interval associated to the route template.|\n| PlannedEndTime| The planned end time associated to the route template.|\n| PlannedStartTime| The planned start time associated to the route template.|\n| PrintExceptionsOnly| Whether the route template should print exceptions only.|\n| PromptForLiftsOnVisitCompletion| Whether the route template should prompt for lifts on visit completion.|\n| RelatedCompanyOutletGuidFilter| Used to filter by the related company outlet GUID.|\n| RelatedLocationDestinationGuid| The GUID of location destination associated to the route template. Filterable.|\n| RelatedMasterRouteGuid| The GUID of master route associated to the route template. Filterable.|\n| RelatedRouteGroupGuid| The GUID of route group associated to the route template.|\n| RelatedSupplierSiteGuid| The GUID of supplier site associated to the route template. Filterable.|\n| RelatedSupplierSiteTransportGuid| The GUID of supplier site transport associated to the route template. Filterable.|\n| RelatedVehicleDefaultExternalGuid| The GUID of external vehicle associated to the route template. Filterable.|\n| RelatedVehicleDefaultGuid| The GUID of vehicle associated to the route template. Filterable.|\n| RelatedUserDefaultDriverGuid| The GUID of driver user associated to the route template. Filterable.|\n| RFIDAlertThreshold| The RFID alert threshold associated to the route template.|\n| RouteManagementTypeListItem| The GUID and description of the route management type associated to the route template.|\n| RouteNo| The route number associated to the route template.|\n| RouteVisitProximityRadius| The route visit proximity radius associated to the route template.|\n| StoplistPollingRate| The stoplist polling rate associated to the route template.|\n| SupplierEmailAddress| The supplier email address associated to the route template.|\n| UseOrderSupplierForCostGeneration| Whether the route template can use order supplier for cost generation.|\n| UseSystemGPSMatchingSettings| Whether the route template can use system GPS matching settings.|\n| VehicleTypeListItem| The GUID and description of the vehicle type associated to the route template.|\n| ZeroWeightAlertThreshold| The zero weight alert threshold associated to the route template.|\n| TeamBoardListItem| The GUID and description of the TeamBoard associated to the route template.|\n| IsManagedExternally| Whether the route template is created by Master Route Module Team.|"
      operationId: RouteTemplate_GetChanges
      parameters:
      - name: since
        in: query
        schema:
          type: string
      - name: cursor
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceChanges_ApiIntegratorRouteTemplateResource'
  /transport/routeTemplates/{guid}:
    get:
      tags:
      - RouteTemplate
      summary: Find with GUID
      description: "| Property| Description|\n| --------------------------------------------- | ----------------------------------------------------------------------------------------------------- |\n| GUID| The GUID associated to the route.|\n| AcceptedMaterials| An array of accepted materials.|\n| AcceptedMaterials[0].Guid| The GUID of accepted material.|\n| AcceptedMaterials[0].IsDeleted| Whether accepted material is deleted.|\n| AcceptedMaterials[0].MaterialClassListItem| The GUID and Description of material class|\n| ArchiveMissedRouteVisitReasonListItem| The GUID and description of the archive missed route visit reason associated to the route template. |\n| ArchiveRouteVisitDays| The archive route visit days associated to the route template.|\n| AreaOfOriginListItem| The GUID and description of the area of origin associated to the route template. |\n| AuditDays| The audit days associated to the route template.|\n| AuditStartDate| The audit start date associated to the route template.|\n| AutoCompleteVisits| Whether auto complete visits associated to the route template.| \n| AutoSend| Whether auto send associated to the route template.| \n| BuildDaysBeforeNextPlannedDate| The build days before next planned date associated to the route template.| \n| BuildSimpleRouteInstance| Whether build simple route instance associated to the route template.| \n| CanRunOnSchedule| Whether can run on schedule associated to the route template.| \n| CompanyOutletListItem| The GUID and description of the company outlet associated to the route template. |\n| DayOccurrenceInMonthListItem| The GUID and description of the day occurrence in month associated to the route template. |\n| DayOfWeekListItem| The GUID and description of the day of week associated to the route template. |\n| DaysBeforeExpiry| The days before expiry associated to the route template.| \n| DefaultTipMaterialListItem| The GUID and description of the material associated to the route template. |\n| Description| The description associated to the route.|\n| DiffReasonRequired| Whether different reason required associated to the route template.|\n| DoubleDumpTimeInSeconds| The double dump time in seconds associated to the route template.|\n| ExcludeMunicipalCustomerFromHandheld| Whether exclude municipal customer from handheld associated to the route template.|\n| ExcludeMunicipalCustomerFromRouteConfirmation| Whether exclude municipal customer from route confirmation associated to the route template.|\n| ExcludeMunicipalCustomerFromRouteWorksheet| Whether exclude municipal customer from route worksheet associated to the route template.|\n| ForceWeightsOnRouteCompletion| Whether force weights on route completion associated to the route template.|\n| GPSMatchingEnabled| Whether GPS matching enabled associated to the route template.|\n| GpsMatchingMaxRange| The Gps matching max range associated to the route.|\n| GpsmatchingMinProximity| The Gps matching min proximity associated to the route.|\n| GuidedNavigationPassword| The guided navigation password associated to the route.|\n| GuidedNavigationUsername| The guided navigation username associated to the route.|\n| GuideVersion| The guide version associated to the route.|\n| HideTipLocationMapMarkers| Whether hide tip location map markers associated to the route template.|\n| IsAutoCompleteOnBuild| Whether the route template is auto complete on build.|\n| IsDeleted| Whether the route template is deleted.|\n| IsNightRoute| Whether the route template is for night route.|\n| IsProximityOrderedVisits| Whether the route template is proximity ordered visits.|\n| IsRouteNavigationEnabled| Whether the route template has route navigation enabled.|\n| IsRouteStatisticGenerationOn| Whether the route template is route statistic generation is On.|\n| IsSubContracted| Whether the route template is sub contracted.|\n| MarketListItem| The GUID and description of the market associated to the route template. |\n| MissedReasonRequired| Whether the missed reason is required for route template.|\n| MobileForceManualLiftMatching| Whether the mobile force manual lift matching for route template.|\n| MobileSettingsProfileListItem| The GUID and description of the mobile settings profile associated to the route template.|\n| NextPlannedDate| The next planned date associated to the route template.|\n| NoMatchAlertThreshold| The No match alert threshold to the route template.|\n| NoTagStopEnabled| Whether the route template has no tag stop enabled.|\n| Notes| The notes associated to the route template.|\n| PickupIntervalListItem| The GUID and description of the pick up interval associated to the route template.|\n| PlannedEndTime| The planned end time associated to the route template.|\n| PlannedStartTime| The planned start time associated to the route template.|\n| PrintExceptionsOnly| Whether the route template should print exceptions only.|\n| PromptForLiftsOnVisitCompletion| Whether the route template should prompt for lifts on visit completion.|\n| RelatedCompanyOutletGuidFilter| Used to filter by the related company outlet GUID.|\n| RelatedLocationDestinationGuid| The GUID of location destination associated to the route template. Filterable.|\n| RelatedMasterRouteGuid| The GUID of master route associated to the route template. Filterable.|\n| RelatedRouteGroupGuid| The GUID of route group associated to the route template.|\n| RelatedSupplierSiteGuid| The GUID of supplier site associated to the route template. Filterable.|\n| RelatedSupplierSiteTransportGuid| The GUID of supplier site transport associated to the route template. Filterable.|\n| RelatedVehicleDefaultExternalGuid| The GUID of external vehicle associated to the route template. Filterable.|\n| RelatedVehicleDefaultGuid| The GUID of vehicle associated to the route template. Filterable.|\n| RelatedUserDefaultDriverGuid| The GUID of driver user associated to the route template. Filterable.|\n| RFIDAlertThreshold| The RFID alert threshold associated to the route template.|\n| RouteManagementTypeListItem| The GUID and description of the route management type associated to the route template.|\n| RouteNo| The route number associated to the route template.|\n| RouteVisitProximityRadius| The route visit proximity radius associated to the route template.|\n| StoplistPollingRate| The stoplist polling rate associated to the route template.|\n| SupplierEmailAddress| The supplier email address associated to the route template.|\n| UseOrderSupplierForCostGeneration| Whether the route template can use order supplier for cost generation.|\n| UseSystemGPSMatchingSettings| Whether the route template can use system GPS matching settings.|\n| VehicleTypeListItem| The GUID and description of the vehicle type associated to the route template.|\n| ZeroWeightAlertThreshold| The zero weight alert threshold associated to the route template.|\n| TeamBoardListItem| The GUID and description of the TeamBoard associated to the route template.|\n| IsManagedExternally| Whether the route template is created by Master Route Module Team.|"
      operationId: RouteTemplate_Get
      parameters:
      - name: guid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: udf
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceResultEntity_ApiIntegratorRouteTemplateResource'
    put:
      tags:
      - RouteTemplate
      summary: Partial update
      description: "| Property| Description| Required |\n| --------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------- |\n| GUID| The GUID associated to the route.| No |\n| AcceptedMaterials| An array of accepted materials.| No |\n| AcceptedMaterials.Guid| Guid of accepted material.| No |\n| AcceptedMaterials.IsDeleted| Whether the accepted material is deleted.| Yes |\n| AcceptedMaterials.MaterialClassItem| Guid and description of material class.| Yes |\n| ArchiveMissedRouteVisitReasonListItem| The GUID and description of the archive missed route visit reason associated to the route template. | No |\n| ArchiveRouteVisitDays| The archive route visit days associated to the route template.| No |\n| AreaOfOriginListItem| The GUID and description of the area of origin associated to the route template. | Yes |\n| AuditDays| The audit days associated to the route template.| No |\n| AuditStartDate| The audit start date associated to the route template.| No |\n| AutoSend| Whether auto send associated to the route template.| No |\n| BuildDaysBeforeNextPlannedDate| The build days before next planned date associated to the route template.| No |\n| BuildSimpleRouteInstance| Whether build simple route instance associated to the route template.| No | \n| CanRunOnSchedule| Whether can run on schedule associated to the route template.| Yes |\n| CompanyOutletListItem| The GUID and description of the company outlet associated to the route template. | Yes |\n| DayOccurrenceInMonthListItem| The GUID and description of the day occurrence in month associated to the route template. | No |\n| DayOfWeekListItem| The GUID and description of the day of week associated to the route template. | Yes |\n| DaysBeforeExpiry| The days before expiry associated to the route template.| No | \n| DefaultTipMaterialListItem| The GUID and description of the material associated to the route template. | No |\n| Description| The description associated to the route.| Yes |\n| DiffReasonRequired| Whether different reason required associated to the route template.| No |\n| ExcludeMunicipalCustomerFromHandheld| Whether exclude municipal customer from handheld associated to the route template.| No |\n| ExcludeMunicipalCustomerFromRouteConfirmation| Whether exclude municipal customer from route confirmation associated to the route template.| No |\n| ExcludeMunicipalCustomerFromRouteWorksheet| Whether exclude municipal customer from route worksheet associated to the route template.| No |\n| ForceWeightsOnRouteCompletion| Whether force weights on route completion associated to the route template.| No |\n| GuidedNavigationPassword| The guided navigation password associated to the route.| No |\n| GuidedNavigationUsername| The guided navigation username associated to the route.| No |\n| GuideVersion| The guide version associated to the route.| No |\n| IsAutoCompleteOnBuild| Whether the route template is auto complete on build.| No |\n| IsDeleted| Whether the route template is deleted.| No |\n| IsNightRoute| Whether the route template is for night route.| No |\n| IsRouteNavigationEnabled| Whether the route template has route navigation enabled.| No |\n| IsRouteStatisticGenerationOn| Whether the route template is route statistic generation is On.| No |\n| MarketListItem| The GUID and description of the market associated to the route template. | No |\n| MissedReasonRequired| Whether the missed reason is required for route template.| No |\n| MobileSettingsProfileListItem| The GUID and description of the mobile settings profile associated to the route template.| Yes |\n| NextPlannedDate| The next planned date associated to the route template.| Yes |\n| Notes| The notes associated to the route template.| No |\n| PickupIntervalListItem| The GUID and description of the pick up interval associated to the route template.| Yes |\n| PlannedEndTime| The planned end time associated to the route template.| No |\n| PlannedStartTime| The planned start time associated to the route template.| No |\n| PrintExceptionsOnly| Whether the route template should print exceptions only.| No |\n| RelatedCompanyOutletGuidFilter| Used to filter by the related company outlet GUID.| No |\n| RelatedLocationDestinationGuid| The GUID of location destination associated to the route template. Filterable.| No |\n| RelatedMasterRouteGuid| The GUID of master route associated to the route template. Filterable.| No |\n| RelatedSupplierSiteGuid| The GUID of supplier site associated to the route template. Filterable.| No |\n| RelatedSupplierSiteTransportGuid| The GUID of supplier site transport associated to the route template. Filterable.| No |\n| RelatedVehicleDefaultExternalGuid| The GUID of external vehicle associated to the route template. Filterable.| No |\n| RelatedVehicleDefaultGuid| The GUID of vehicle associated to the route template. Filterable.| No |\n| RelatedUserDefaultDriverGuid| The GUID of driver user associated to the route template. Filterable.| No |\n| RouteManagementTypeListItem| The GUID and description of the route management type associated to the route template.| Yes |\n| RouteNo| The route number associated to the route template.| Yes |\n| SupplierEmailAddress| The supplier email address associated to the route template.| Yes |\n| UseOrderSupplierForCostGeneration| Whether the route template can use order supplier for cost generation.| No |\n| VehicleTypeListItem| The GUID and description of the vehicle type associated to the route template.| Yes |\n| IsManagedExternally| Whether the route template is created by Master Route Module Team.| No |\n\n**Extra validations**\n\n| Condition | Error message |\n| --------- | ------------- |\n| If IsDeleted is true | IsDeleted is TRUE. Could not process the request. Resources can not be deleted via the REST API. |\n| Updating a deleted RouteTemplate | Failed to save/update RouteTemplate because attempt to update a deleted RouteTemplate is not allowed. Could not process the request. |\n| AcceptedMaterials.MaterialClassListItem is being edited | AcceptedMaterials.MaterialClassListItem is a read-only property. |\n| AcceptedMaterials.MaterialClassListItem.Guid is duplicate | The MaterialClassListItem must be unique per AcceptedMaterials |"
      operationId: RouteTemplate_Update
      parameters:
      - name: guid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiIntegratorRouteTemplateResource'
        required: true
        x-bodyName: null
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceId'
  /transport/routeTemplates:
    get:
      tags:
      - RouteTemplate
      summary: Find with Filters
      description: "| Property| Description|\n| --------------------------------------------- | ----------------------------------------------------------------------------------------------------- |\n| GUID| The GUID associated to the route.|\n| AcceptedMaterials| An array of accepted materials.|\n| AcceptedMaterials[0].Guid| The GUID of accepted material.|\n| AcceptedMaterials[0].IsDeleted| Whether accepted material is deleted.|\n| AcceptedMaterials[0].MaterialClassListItem| The GUID and Description of material class|\n| ArchiveMissedRouteVisitReasonListItem| The GUID and description of the archive missed route visit reason associated to the route template. |\n| ArchiveRouteVisitDays| The archive route visit days associated to the route template.|\n| AreaOfOriginListItem| The GUID and description of the area of origin associated to the route template. |\n| AuditDays| The audit days associated to the route template.|\n| AuditStartDate| The audit start date associated to the route template.|\n| AutoCompleteVisits| Whether auto complete visits associated to the route template.| \n| AutoSend| Whether auto send associated to the route template.| \n| BuildDaysBeforeNextPlannedDate| The build days before next planned date associated to the route template.| \n| BuildSimpleRouteInstance| Whether build simple route instance associated to the route template.| \n| CanRunOnSchedule| Whether can run on schedule associated to the route template.| \n| CompanyOutletListItem| The GUID and description of the company outlet associated to the route template. |\n| DayOccurrenceInMonthListItem| The GUID and description of the day occurrence in month associated to the route template. |\n| DayOfWeekListItem| The GUID and description of the day of week associated to the route template. |\n| DaysBeforeExpiry| The days before expiry associated to the route template.| \n| DefaultTipMaterialListItem| The GUID and description of the material associated to the route template. |\n| Description| The description associated to the route.|\n| DiffReasonRequired| Whether different reason required associated to the route template.|\n| DoubleDumpTimeInSeconds| The double dump time in seconds associated to the route template.|\n| ExcludeMunicipalCustomerFromHandheld| Whether exclude municipal customer from handheld associated to the route template.|\n| ExcludeMunicipalCustomerFromRouteConfirmation| Whether exclude municipal customer from route confirmation associated to the route template.|\n| ExcludeMunicipalCustomerFromRouteWorksheet| Whether exclude municipal customer from route worksheet associated to the route template.|\n| ForceWeightsOnRouteCompletion| Whether force weights on route completion associated to the route template.|\n| GPSMatchingEnabled| Whether GPS matching enabled associated to the route template.|\n| GpsMatchingMaxRange| The Gps matching max range associated to the route.|\n| GpsmatchingMinProximity| The Gps matching min proximity associated to the route.|\n| GuidedNavigationPassword| The guided navigation password associated to the route.|\n| GuidedNavigationUsername| The guided navigation username associated to the route.|\n| GuideVersion| The guide version associated to the route.|\n| HideTipLocationMapMarkers| Whether hide tip location map markers associated to the route template.|\n| IsAutoCompleteOnBuild| Whether the route template is auto complete on build.|\n| IsDeleted| Whether the route template is deleted.|\n| IsNightRoute| Whether the route template is for night route.|\n| IsProximityOrderedVisits| Whether the route template is proximity ordered visits.|\n| IsRouteNavigationEnabled| Whether the route template has route navigation enabled.|\n| IsRouteStatisticGenerationOn| Whether the route template is route statistic generation is On.|\n| IsSubContracted| Whether the route template is sub contracted.|\n| MarketListItem| The GUID and description of the market associated to the route template. |\n| MissedReasonRequired| Whether the missed reason is required for route template.|\n| MobileForceManualLiftMatching| Whether the mobile force manual lift matching for route template.|\n| MobileSettingsProfileListItem| The GUID and description of the mobile settings profile associated to the route template.|\n| NextPlannedDate| The next planned date associated to the route template.|\n| NoMatchAlertThreshold| The No match alert threshold to the route template.|\n| NoTagStopEnabled| Whether the route template has no tag stop enabled.|\n| Notes| The notes associated to the route template.|\n| PickupIntervalListItem| The GUID and description of the pick up interval associated to the route template.|\n| PlannedEndTime| The planned end time associated to the route template.|\n| PlannedStartTime| The planned start time associated to the route template.|\n| PrintExceptionsOnly| Whether the route template should print exceptions only.|\n| PromptForLiftsOnVisitCompletion| Whether the route template should prompt for lifts on visit completion.|\n| RelatedCompanyOutletGuidFilter| Used to filter by the related company outlet GUID.|\n| RelatedLocationDestinationGuid| The GUID of location destination associated to the route template. Filterable.|\n| RelatedMasterRouteGuid| The GUID of master route associated to the route template. Filterable.|\n| RelatedRouteGroupGuid| The GUID of route group associated to the route template.|\n| RelatedSupplierSiteGuid| The GUID of supplier site associated to the route template. Filterable.|\n| RelatedSupplierSiteTransportGuid| The GUID of supplier site transport associated to the route template. Filterable.|\n| RelatedVehicleDefaultExternalGuid| The GUID of external vehicle associated to the route template. Filterable.|\n| RelatedVehicleDefaultGuid| The GUID of vehicle associated to the route template. Filterable.|\n| RelatedUserDefaultDriverGuid| The GUID of driver user associated to the route template. Filterable.|\n| RFIDAlertThreshold| The RFID alert threshold associated to the route template.|\n| RouteManagementTypeListItem| The GUID and description of the route management type associated to the route template.|\n| RouteNo| The route number associated to the route template.|\n| RouteVisitProximityRadius| The route visit proximity radius associated to the route template.|\n| StoplistPollingRate| The stoplist polling rate associated to the route template.|\n| SupplierEmailAddress| The supplier email address associated to the route template.|\n| UseOrderSupplierForCostGeneration| Whether the route template can use order supplier for cost generation.|\n| UseSystemGPSMatchingSettings| Whether the route template can use system GPS matching settings.|\n| VehicleTypeListItem| The GUID and description of the vehicle type associated to the route template.|\n| ZeroWeightAlertThreshold| The zero weight alert threshold associated to the route template.|\n| TeamBoardListItem| The GUID and description of the TeamBoard associated to the route template.|\n| IsManagedExternally| Whether the route template is created by Master Route Module Team.|"
      operationId: RouteTemplate_GetCollection
      parameters:
      - name: filter
        in: query
        schema:
          type: string
      - name: max
        in: query
        schema:
          type: integer
          format: int32
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: includeCount
        in: query
        schema:
          type: boolean
      - name: udf
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceResultCollection_ApiIntegratorRouteTemplateResource'
    post:
      tags:
      - RouteTemplate
      summary: Create or update
      description: "| Property| Description| Required |\n| --------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------- |\n| GUID| The GUID associated to the route.| No |\n| AcceptedMaterials| An array of accepted materials.| No |\n| AcceptedMaterials.Guid| Guid of accepted material.| No |\n| AcceptedMaterials.IsDeleted| Whether the accepted material is deleted.| Yes |\n| AcceptedMaterials.MaterialClassItem| Guid and description of material class.| Yes |\n| ArchiveMissedRouteVisitReasonListItem| The GUID and description of the archive missed route visit reason associated to the route template. | No |\n| ArchiveRouteVisitDays| The archive route visit days associated to the route template.| No |\n| AreaOfOriginListItem| The GUID and description of the area of origin associated to the route template. | Yes |\n| AuditDays| The audit days associated to the route template.| No |\n| AuditStartDate| The audit start date associated to the route template.| No |\n| AutoSend| Whether auto send associated to the route template.| No |\n| BuildDaysBeforeNextPlannedDate| The build days before next planned date associated to the route template.| No |\n| BuildSimpleRouteInstance| Whether build simple route instance associated to the route template.| No | \n| CanRunOnSchedule| Whether can run on schedule associated to the route template.| Yes |\n| CompanyOutletListItem| The GUID and description of the company outlet associated to the route template. | Yes |\n| DayOccurrenceInMonthListItem| The GUID and description of the day occurrence in month associated to the route template. | No |\n| DayOfWeekListItem| The GUID and description of the day of week associated to the route template. | Yes |\n| DaysBeforeExpiry| The days before expiry associated to the route template.| No | \n| DefaultTipMaterialListItem| The GUID and description of the material associated to the route template. | No |\n| Description| The description associated to the route.| Yes |\n| DiffReasonRequired| Whether different reason required associated to the route template.| No |\n| ExcludeMunicipalCustomerFromHandheld| Whether exclude municipa

# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amcs-group/refs/heads/main/openapi/amcs-group-routetemplate-api-openapi.yml