> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pingintel.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Generate Acc/Loc Files
> **⚠️ Under active development — subject to change.**
Kicks off an asynchronous job to generate files. Poll the Acc/Loc File Status endpoint to check progress and retrieve download URLs.
## OpenAPI
````yaml https://vision.staging.pingintel.com/api/schema/?format=json post /api/v1/submission/{pingid}/cat/acc-loc-files
openapi: 3.0.3
info:
title: Ping.Vision API
version: v1.0
description: >
### Ping.Vision API
This API provides convenient, efficient access to Ping Intel's data and
services. It is designed to be used by developers and data scientists to
integrate Ping Intel's capabilities into their applications.
Once SSO is set up with your organization, you can create an Organization or
Personal API key at https://auth.pingintel.com/org.
Please see the Python client library
[pingintel-api](https://pypi.org/project/pingintel-api/) for commandline
tools and programmatic access, and you
can refer to the following documentation for details on interacting with the
system via the HTTP API.
contact:
email: support@pingintel.com
name: Ping Intel
url: https://www.pingintel.com
servers:
- url: https://vision.pingintel.com
description: Ping.Vision API
- url: https://vision.staging.pingintel.com
description: Ping.Vision API (staging)
security: []
tags:
- name: Create Submission
description: The Create Submission API allows you to add new data into the system.
- name: Update Submission
description: >-
The Update Submission API provides various endpoints to update, modify, or
act upon existing submissions.
- name: Get Submission Data
description: ''
- name: User Memberships
description: >-
The User Memberships API allows you to add, remove, and change the role of
users in different teams, divisions, or companies.
- name: Miscellaneous
description: ''
paths:
/api/v1/submission/{pingid}/cat/acc-loc-files:
post:
tags:
- CAT Modeling
summary: Generate Acc/Loc Files
description: >-
**⚠️ Under active development — subject to change.**
Kicks off an asynchronous job to generate files. Poll the Acc/Loc File Status endpoint to check
progress and retrieve download URLs.
operationId: api_v1_submission_cat_acc_loc_files_create
parameters:
- in: path
name: pingid
schema:
type: string
description: Ping ID of the submission.
required: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccLocFileJobCreate'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AccLocFileJobCreate'
multipart/form-data:
schema:
$ref: '#/components/schemas/AccLocFileJobCreate'
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/AccLocFileJob'
examples:
Accepted:
value:
uuid: a1b2c3d4-0000-0000-0000-000000000001
status: pending
processing_pct_complete: 50
modeling_sets:
- status: I
acc_file_url: null
loc_file_url: null
cat_model_type: AIR
use_secondary_modifiers: true
use_ping_geocoding: false
modeling_option_uuid: a1b2c3d4-0000-0000-0000-000000000001
coverate_option_uuid: a1b2c3d4-0000-0000-0000-000000000010
layer_structure_uuid: a1b2c3d4-0000-0000-0000-000000009999
layer_uuids:
- a1b2c3d4-0000-0000-0000-000000000101
- a1b2c3d4-0000-0000-0000-000000000102
layer_output: C
- status: F
acc_file_url: null
loc_file_url: null
cat_model_type: AIR
use_secondary_modifiers: true
use_ping_geocoding: false
modeling_option_uuid: a1b2c3d4-0000-0000-0000-000000000002
coverate_option_uuid: a1b2c3d4-0000-0000-0000-000000000011
layer_structure_uuid: a1b2c3d4-0000-0000-0000-000000009999
layer_uuids:
- a1b2c3d4-0000-0000-0000-000000000101
- a1b2c3d4-0000-0000-0000-000000000102
layer_output: C
description: ''
security:
- authorization_header: []
components:
schemas:
AccLocFileJobCreate:
type: object
properties:
air_modeling_workflow_name:
type: string
nullable: true
description: AIR Workflow name to use for generating acc/loc files.
cat_model_type:
enum:
- AIR
- RMS
- null
type: string
x-spec-enum-id: 6ec9844f44dcfbf7
nullable: true
description: >-
CAT model to generate files for (`AIR` or `RMS`). The submission
must have configuration for the requested model via its
team/division settings. If omitted, files are generated for all CAT
models that are configured for the submission.
* `AIR` - AIR Modeling
* `RMS` - RMS Modeling
layer_output:
enum:
- C
- P
- null
type: string
x-spec-enum-id: 560025be91e18ee1
nullable: true
description: >-
Controls how acc/loc file pairs are generated per tower. `C` -
Combined: produces one file pair including all layers; `P` - Per
Layer: produces a separate file pair for each layer.If omitted,
configured default is used.
* `C` - Combined
* `P` - Per Layer
modeling_option_uuids:
type: array
items:
type: string
format: uuid
nullable: true
description: >-
Limit generation to a specific set of modeling options. If omitted,
files are generated for all modeling options on the submission.
rms_edm_name:
type: string
nullable: true
description: RMS EDM name to use for generating acc/loc files.
use_ping_geocoding:
type: boolean
nullable: true
description: >-
When true, Ping-derived lat/longs are included in the generated
acc/loc files. If omitted, configured default is used.
use_secondary_modifiers:
type: boolean
nullable: true
description: >-
When true, secondary modifiers are included in the generated acc/loc
files. If omitted, configured default is used.
AccLocFileJob:
type: object
properties:
modeling_sets:
type: array
items:
$ref: '#/components/schemas/ModelingSet'
description: >-
Acc/Loc file pairs being generated. Each entry has its own status
and may complete independently before the overall job is finished.
processing_pct_complete:
type: integer
description: >-
An integer from 0 to 100 indicating the percentage of the job that
is complete. When status is `C`, this will be 100; when status is
`I`, this may be 0 or some intermediate value; when status is `F`,
this may be 0, 100, or some intermediate value depending on when the
failure occurred.
status:
enum:
- 'N'
- I
- C
- F
type: string
x-spec-enum-id: 62fef98fcd687813
description: >-
`N`: job is not processed. `I`: job is in progress. `C`: files are
ready. `F`: generation encountered an error.
* `N` - Not Processed
* `I` - In Progress
* `C` - Completed
* `F` - Failed
uuid:
type: string
format: uuid
description: Unique identifier for this generation job.
required:
- modeling_sets
- processing_pct_complete
- status
- uuid
ModelingSet:
type: object
properties:
acc_file_url:
type: string
readOnly: true
description: >-
Pre-signed download URL for the generated acc file. Null until
status is `complete`.
cat_model_type:
enum:
- AIR
- RMS
type: string
x-spec-enum-id: 6ec9844f44dcfbf7
description: |-
CAT model these files were generated for.
* `AIR` - AIR Modeling
* `RMS` - RMS Modeling
coverage_option_uuid:
type: string
format: uuid
description: UUID of the coverage option this file pair was generated for.
layer_output:
enum:
- C
- P
type: string
x-spec-enum-id: 560025be91e18ee1
description: >-
Controls whether mutiple layers are included in a single acc/loc
file pair, or independently in a set of files for each layer. `C` =
combined, `P` = per layer.
* `C` - Combined
* `P` - Per Layer
layer_structure_uuid:
type: string
format: uuid
description: UUID of the layer structure this file pair was generated for.
layer_uuids:
type: string
readOnly: true
description: >-
UUIDs of the layers this file pair was generated for. Only populated
when layer_output=per_layer.
loc_file_url:
type: string
readOnly: true
description: >-
Pre-signed download URL for the generated loc file. Null until
status is `complete`.
modeling_option_uuid:
type: string
format: uuid
description: UUID of the modeling option this file pair was generated for.
status:
enum:
- Q
- I
- C
- F
type: string
x-spec-enum-id: 62e2f2047a3eaed8
description: |-
`Q`: Queued. `I`: In Progress. `C`: Complete. `F`: Failed.
* `Q` - Queued
* `I` - In Progress
* `C` - Complete
* `F` - Failed
use_ping_geocoding:
type: boolean
description: Whether Ping-derived lat/longs were included in the generated files.
use_secondary_modifiers:
type: boolean
description: Whether secondary modifiers were included in the generated files.
required:
- acc_file_url
- cat_model_type
- coverage_option_uuid
- layer_output
- layer_structure_uuid
- layer_uuids
- loc_file_url
- modeling_option_uuid
- status
- use_ping_geocoding
- use_secondary_modifiers
securitySchemes:
authorization_header:
type: apiKey
in: header
name: Authorization
description: >-
Supports `Token `-prefixed API keys and `Bearer `-prefixed JWT-based
authentication.
````