Generate Acc/Loc Files

curl --request POST \
  --url https://vision.pingintel.com/api/v1/submission/{pingid}/cat/acc-loc-files \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "air_modeling_workflow_name": "<string>",
  "modeling_option_uuids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "rms_edm_name": "<string>",
  "use_ping_geocoding": true,
  "use_secondary_modifiers": true
}
'

import requests

url = "https://vision.pingintel.com/api/v1/submission/{pingid}/cat/acc-loc-files"

payload = {
    "air_modeling_workflow_name": "<string>",
    "modeling_option_uuids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "rms_edm_name": "<string>",
    "use_ping_geocoding": True,
    "use_secondary_modifiers": True
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    air_modeling_workflow_name: '<string>',
    modeling_option_uuids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    rms_edm_name: '<string>',
    use_ping_geocoding: true,
    use_secondary_modifiers: true
  })
};

fetch('https://vision.pingintel.com/api/v1/submission/{pingid}/cat/acc-loc-files', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://vision.pingintel.com/api/v1/submission/{pingid}/cat/acc-loc-files",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'air_modeling_workflow_name' => '<string>',
    'modeling_option_uuids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'rms_edm_name' => '<string>',
    'use_ping_geocoding' => true,
    'use_secondary_modifiers' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://vision.pingintel.com/api/v1/submission/{pingid}/cat/acc-loc-files"

	payload := strings.NewReader("{\n  \"air_modeling_workflow_name\": \"<string>\",\n  \"modeling_option_uuids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"rms_edm_name\": \"<string>\",\n  \"use_ping_geocoding\": true,\n  \"use_secondary_modifiers\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://vision.pingintel.com/api/v1/submission/{pingid}/cat/acc-loc-files")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"air_modeling_workflow_name\": \"<string>\",\n  \"modeling_option_uuids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"rms_edm_name\": \"<string>\",\n  \"use_ping_geocoding\": true,\n  \"use_secondary_modifiers\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://vision.pingintel.com/api/v1/submission/{pingid}/cat/acc-loc-files")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"air_modeling_workflow_name\": \"<string>\",\n  \"modeling_option_uuids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"rms_edm_name\": \"<string>\",\n  \"use_ping_geocoding\": true,\n  \"use_secondary_modifiers\": true\n}"

response = http.request(request)
puts response.read_body

{
  "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",
      "documents": []
    },
    {
      "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",
      "documents": []
    }
  ]
}

POST

api

submission

{pingid}

cat

acc-loc-files

Generate Acc/Loc Files

curl --request POST \
  --url https://vision.pingintel.com/api/v1/submission/{pingid}/cat/acc-loc-files \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "air_modeling_workflow_name": "<string>",
  "modeling_option_uuids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "rms_edm_name": "<string>",
  "use_ping_geocoding": true,
  "use_secondary_modifiers": true
}
'

import requests

url = "https://vision.pingintel.com/api/v1/submission/{pingid}/cat/acc-loc-files"

payload = {
    "air_modeling_workflow_name": "<string>",
    "modeling_option_uuids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "rms_edm_name": "<string>",
    "use_ping_geocoding": True,
    "use_secondary_modifiers": True
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    air_modeling_workflow_name: '<string>',
    modeling_option_uuids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    rms_edm_name: '<string>',
    use_ping_geocoding: true,
    use_secondary_modifiers: true
  })
};

fetch('https://vision.pingintel.com/api/v1/submission/{pingid}/cat/acc-loc-files', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://vision.pingintel.com/api/v1/submission/{pingid}/cat/acc-loc-files",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'air_modeling_workflow_name' => '<string>',
    'modeling_option_uuids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'rms_edm_name' => '<string>',
    'use_ping_geocoding' => true,
    'use_secondary_modifiers' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://vision.pingintel.com/api/v1/submission/{pingid}/cat/acc-loc-files"

	payload := strings.NewReader("{\n  \"air_modeling_workflow_name\": \"<string>\",\n  \"modeling_option_uuids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"rms_edm_name\": \"<string>\",\n  \"use_ping_geocoding\": true,\n  \"use_secondary_modifiers\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://vision.pingintel.com/api/v1/submission/{pingid}/cat/acc-loc-files")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"air_modeling_workflow_name\": \"<string>\",\n  \"modeling_option_uuids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"rms_edm_name\": \"<string>\",\n  \"use_ping_geocoding\": true,\n  \"use_secondary_modifiers\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://vision.pingintel.com/api/v1/submission/{pingid}/cat/acc-loc-files")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"air_modeling_workflow_name\": \"<string>\",\n  \"modeling_option_uuids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"rms_edm_name\": \"<string>\",\n  \"use_ping_geocoding\": true,\n  \"use_secondary_modifiers\": true\n}"

response = http.request(request)
puts response.read_body

{
  "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",
      "documents": []
    },
    {
      "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",
      "documents": []
    }
  ]
}

Authorizations

Authorization

string

header

required

Supports Token-prefixed API keys and Bearer-prefixed JWT-based authentication.

Path Parameters

pingid

string

required

Ping ID of the submission.

Body

air_modeling_workflow_name

string | null

AIR Workflow name to use for generating acc/loc files.

cat_model_type

enum<string> | null

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

Available options:

AIR,

RMS,

null

layer_output

enum<string> | null

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

Available options:

C,

P,

null

modeling_option_uuids

string<uuid>[] | null

Limit generation to a specific set of modeling options. If omitted, files are generated for all modeling options on the submission.

rms_edm_name

string | null

RMS EDM name to use for generating acc/loc files.

use_ping_geocoding

boolean | null

When true, Ping-derived lat/longs are included in the generated acc/loc files. If omitted, configured default is used.

use_secondary_modifiers

boolean | null

When true, secondary modifiers are included in the generated acc/loc files. If omitted, configured default is used.

Response

202 - application/json

modeling_sets

object[]

required

Acc/Loc file pairs being generated. Each entry has its own status and may complete independently before the overall job is finished.

Show child attributes

processing_pct_complete

integer

required

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<string>

required

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

Available options:

N,

I,

C,

F

uuid

string<uuid>

required

Unique identifier for this generation job.

⌘I

Overview

Ping.Extraction

Ping.Data

Ping.Vision

Generate Acc/Loc Files

Authorizations

Path Parameters

Body

Response