This API is provided to allow Airscout partners to place orders on behalf of their clients to enroll in the standard season long aerial imagery capture service.
\nIn order to use this API a consuming partner needs to request an “App User Key” which is unique to the consumer of the information and can be throttled or revoked if abuse is detected. Please see the documentation for the standard Airscout External Partner Imagery API for more details on how to use an Airscout External Partner API such as this one as this document assumes you understand the concepts covered in that document.
\nOrders are for the entire season – The airscout service is a season long aerial imagery service. A single order will be for an entire season, not just a single scene capture.
\nOrder Locking – Once an order is placed there is a period of time for which it sits in a state waiting to be assigned a flight route. Generally we try to create or modify flight routes within the context of several orders to build the most efficient flight routes possble. During the waiting period an order can be cancelled. However, once an order is assigned to a flight route it can subsequently be “locked” and no longer cancelled via the API. We try to give general guidance on when our cut offs will be for orders to be included in the flight route building process but we make guarentees. Please work with your Airscout contact or provider for details on when that might be.
\nHere are the various “Order Status” enumeration values that can be returned with an order:
\n1 – Not Ordered – No order has been placed for this field for this season\n2 – Ordered – An order has been placed for this field for this season and it is still active\n3 – Canceled – An order was once placed for this field for this season but has since been canceled\n4 – Locked – An order has been placed but the order has now been locked because the field is now part of a flight route and cannot be canceled
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"API Description:","slug":"api-description"},{"content":"How to Use:","slug":"how-to-use"},{"content":"Some More General Concepts:","slug":"some-more-general-concepts"}],"owner":"1765269","collectionId":"61e83b46-1c4a-6681-f860-89d75dac173b","publishedId":"7LhjkWk","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2017-12-15T19:31:35.000Z"},"item":[{"name":"Get All Seasons","id":"517e4631-83ac-3951-cf11-24fe432305c4","request":{"method":"GET","header":[{"key":"appUserKey","value":"{{appUserKey}}"}],"body":{"mode":"raw","raw":""},"url":"{{airscoutcloud_base_url}}/external-partners-api/orders/{{externalPartnerId}}/seasons","description":"Use this resource to get all season objects. It’s the ID of the season object that you will use to place orders.
\n","urlObject":{"path":["external-partners-api","orders","{{externalPartnerId}}","seasons"],"host":["{{airscoutcloud_base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"517e4631-83ac-3951-cf11-24fe432305c4"},{"name":"Get All Orders For Field","id":"9808749f-8af8-995a-7dc9-26d38a5e5389","request":{"method":"GET","header":[{"key":"appUserKey","value":"{{appUserKey}}"}],"body":{"mode":"raw","raw":""},"url":"{{airscoutcloud_base_url}}/external-partners-api/orders/{{externalPartnerId}}/field/orders?externalPartnerFieldId=725","description":"Use this resource to find all existing orders for a field. This includes the current season and past seasons.
\n","urlObject":{"path":["external-partners-api","orders","{{externalPartnerId}}","field","orders"],"host":["{{airscoutcloud_base_url}}"],"query":[{"description":{"content":"ID of external partner field to retrieve order information about
\n","type":"text/plain"},"key":"externalPartnerFieldId","value":"725"}],"variable":[]}},"response":[],"_postman_id":"9808749f-8af8-995a-7dc9-26d38a5e5389"},{"name":"Create Order for Field","id":"1cf5aca3-28a0-5844-2dba-714c07f17cd3","request":{"method":"POST","header":[{"key":"appUserKey","value":"{{appUserKey}}"}],"body":{"mode":"raw","raw":""},"url":"{{airscoutcloud_base_url}}/external-partners-api/orders/{{externalPartnerId}}/field/order?externalPartnerFieldId=4796&seasonId=3","description":"Use this resource to create an order for a field for a given season
\n","urlObject":{"path":["external-partners-api","orders","{{externalPartnerId}}","field","order"],"host":["{{airscoutcloud_base_url}}"],"query":[{"description":{"content":"ID of external partner field to place order for
\n","type":"text/plain"},"key":"externalPartnerFieldId","value":"4796"},{"description":{"content":"The ID of the season to place an order for. Get season IDs by querying “Get All Seasons” resource
\n","type":"text/plain"},"key":"seasonId","value":"3"}],"variable":[]}},"response":[],"_postman_id":"1cf5aca3-28a0-5844-2dba-714c07f17cd3"},{"name":"Cancel Order for Field","id":"38b545eb-a041-c91b-7ed2-807ffd3b995c","request":{"method":"DELETE","header":[{"key":"appUserKey","value":"{{appUserKey}}"}],"body":{"mode":"raw","raw":""},"url":"{{airscoutcloud_base_url}}/external-partners-api/orders/{{externalPartnerId}}/field/order?externalPartnerFieldId=4796&seasonId=3","urlObject":{"path":["external-partners-api","orders","{{externalPartnerId}}","field","order"],"host":["{{airscoutcloud_base_url}}"],"query":[{"description":{"content":"ID of external partner field to cancel order for
\n","type":"text/plain"},"key":"externalPartnerFieldId","value":"4796"},{"description":{"content":"The ID of the season to cancel an order for. Get season IDs by querying “Get All Seasons” resource.
\n","type":"text/plain"},"key":"seasonId","value":"3"}],"variable":[]}},"response":[],"_postman_id":"38b545eb-a041-c91b-7ed2-807ffd3b995c"}],"event":[{"listen":"prerequest","script":{"id":"962ae43d-aa06-48f9-8b5b-619ff7ee8916","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c0793447-09b6-499d-990f-6a3849d3ffd2","type":"text/javascript","exec":[""]}}]}