Skip to content

Commit

Permalink
Merge pull request #971 from brentzundel/usda-permit2
Browse files Browse the repository at this point in the history 
USDA permit to import credential
  • Loading branch information
@mkhraisha
mkhraisha authored Sep 19, 2024
2 parents 0cb0e7f + 90e9a87 commit 09dd973
Show file tree
Hide file tree
Showing 2 changed files with 368 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/credentials-with-issuer-dependent-terms.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@
"type": "USMCACertificationOfOrigin",
"count": 6
},
{
"type": "USDAPermitToImportCredential",
"count": 6
}
{
"type": "ThingCredential",
"count": 0
Expand Down
364 changes: 364 additions & 0 deletions docs/openapi/components/schemas/credentials/USDAPermitToImportCredential.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,364 @@
$linkedData:
term: USDAPermitToImportCredential
'@id': https://w3id.org/traceability#USDAPermitToImportCredential
title: USDA Permit to Import Plants or Plant Products
tags:
- Agriculture
description: USDA APHIS (Animal and Plant Health Inspection Service) Permit to Import Plants or Plant Products
type: object
properties:
'@context':
type: array
readOnly: true
const:
- https://www.w3.org/2018/credentials/v1
- https://w3id.org/traceability/v1
default:
- https://www.w3.org/2018/credentials/v1
- https://w3id.org/traceability/v1
items:
type: string
enum:
- https://www.w3.org/2018/credentials/v1
- https://w3id.org/traceability/v1
type:
type: array
readOnly: true
const:
- VerifiableCredential
- USDAPermitToImportCredential
default:
- VerifiableCredential
- USDAPermitToImportCredential
items:
type: string
enum:
- VerifiableCredential
- USDAPermitToImportCredential
id:
type: string
issuanceDate:
type: string
format: date-time
expirationDate:
type: string
format: date-time
issuer:
$ref: ../common/Organization.yml
credentialSchema:
type: object
properties:
id:
title: Id
description: The url of the schema file to validate the shape of the json object
type: string
format: uri
example: https://w3id.org/traceability/openapi/components/schemas/credentials/USDAPermitToImportCredential.yml
default: https://w3id.org/traceability/openapi/components/schemas/credentials/USDAPermitToImportCredential.yml
readOnly: true
type:
title: Type
description: The type of validation to be run against the defined schema
const: OpenApiSpecificationValidator2022
credentialSubject:
title: Permit Details
type: object
properties:
applicationNumber:
title: Application Number
type: string
permitNumber:
title: Permit Number
type: string
applicant:
title: Applicant
description: Organization that applied for import.
$ref: ../common/Organization.yml
$linkedData:
term: applicant
'@id': https://vocabulary.uncefact.org/associatedParty
permittee:
title: Permittee
description: Organization permitted to import.
$ref: ../common/Organization.yml
$linkedData:
term: applicant
'@id': https://vocabulary.uncefact.org/associatedParty
shipment:
title: Shipment
description: Details for the shipment of agricultural goods.
$ref: ../common/AgricultureParcelDelivery.yml
$linkedData:
term: shipment
'@id': https://vocabulary.uncefact.org/transportPackage
intendedUse:
title: Intended Use
description: >-
The intended use for the imported products as reported in USDAPPQ587PlantImportApplication,
this would be "plants for planting", "small lots of seed", or "fruits and vegetables".
type: string
$linkedData:
term: intendedUse
'@id': https://vocabulary.uncefact.org/intendedUse
approvalDate:
title: Signature Date
description: Date when the application was approved.
type: string
$linkedData:
term: approvalDate
'@id': https://vocabulary.uncefact.org/issueDateTime
ppqHeadquarterOfficial:
title: PPQ Headquarter Official
description: The approving PPQ Headquarter Official
type: string
permitConditions:
title: Permit Conditions
type: string
additionalProperties: false
required:
- applicationNumber
- permitNumber
- applicant
- permittee
- intendedUse
- approvalDate
- ppqHeadquarterOfficial
- permitConditions
additionalProperties: false
required:
- '@context'
- type
- id
- issuanceDate
- issuer
- credentialSubject
example: |-
{
"@context": [
"https://www.w3.org/2018/credentials/v1",
"https://w3id.org/traceability/v1"
],
"id": "http://example.com/dd0c6f9a-5df6-40a3-bb34-863cd1fda606",
"credentialSchema": {
"type": "OpenApiSpecificationValidator2022",
"id": "https://w3id.org/traceability/openapi/components/schemas/credentials/USDAPermitToImportCredential.yml"
},
"type": [
"VerifiableCredential",
"USDAPermitToImportCredential"
],
"issuer": {
"type": [
"Organization"
],
"id": "did:web:usda.example.org",
"name": "USDA"
},
"issuanceDate": "2022-11-01T10:58:45-04:00",
"credentialSubject": {
"applicationNumber": "A-0000XXXX",
"permitNumber": "5A-91-287-XXXXX",
"applicant": {
"type": [
"Organization"
],
"name": "Ace Foodstuffs",
"description": "Agricultural goods shipping & distribution",
"email": "[email protected]",
"phoneNumber": "+1-133-555-3764",
"faxNumber": "+1-592-555-3697"
},
"permittee": {
"type": [
"Organization"
],
"name": "Ace Foodstuffs",
"description": "Agricultural goods shipping & distribution",
"email": "[email protected]",
"phoneNumber": "+1-133-555-3764",
"faxNumber": "+1-592-555-3697"
},
"shipment": {
"type": [
"AgricultureParcelDelivery"
],
"deliveryAddress": {
"type": [
"PostalAddress"
],
"name": "Bartell - Doyle",
"streetAddress": "84189 Roberts Route",
"addressLocality": "Kautzerstad",
"addressRegion": "Louisiana",
"postalCode": "37950-5855",
"addressCountry": "Mongolia"
},
"originAddress": {
"type": [
"PostalAddress"
],
"name": "Marks, Runte and Bartell",
"streetAddress": "97696 Weissnat Pines",
"addressLocality": "Reynabury",
"addressRegion": "North Dakota",
"postalCode": "51361-9603",
"addressCountry": "Virgin Islands, U.S."
},
"foreignPortExport": {
"type": [
"Place"
],
"globalLocationNumber": "4947538126450",
"geo": {
"type": [
"GeoCoordinates"
],
"latitude": "40.5464",
"longitude": "-37.6146"
},
"address": {
"type": [
"PostalAddress"
],
"name": "Moen - Swift",
"streetAddress": "9746 Laron Gardens",
"addressLocality": "Port Flossie",
"addressRegion": "Hawaii",
"postalCode": "64687",
"addressCountry": "Djibouti"
},
"unLocode": "DKCPH"
},
"portOfEntry": {
"type": [
"Place"
],
"globalLocationNumber": "2184109798407",
"geo": {
"type": [
"GeoCoordinates"
],
"latitude": "38.8485",
"longitude": "-34.0883"
},
"address": {
"type": [
"PostalAddress"
],
"name": "Mills, Daugherty and Nader",
"streetAddress": "39514 Kulas Terrace",
"addressLocality": "East Avis",
"addressRegion": "Utah",
"postalCode": "45553",
"addressCountry": "Northern Mariana Islands"
},
"unLocode": "DKCPH"
},
"deliveryMethod": "Truck transport",
"trackingNumber": "866440000109",
"expectedArrival": "2021-03-14",
"specialInstructions": "The package is top-heavy so handle with appropriate caution.",
"consignee": {
"type": [
"Organization"
],
"name": "Ace Foodstuffs",
"description": "Agricultural goods shipping & distribution",
"email": "[email protected]",
"phoneNumber": "+1-413-555-8078",
"faxNumber": "+1-625-555-7496"
},
"agriculturePackage": [
{
"type": [
"AgriculturePackage"
],
"packageName": "Avocados, Bulk",
"grade": "AA",
"responsibleParty": {
"type": [
"Organization"
],
"name": "Example Responsible Party Organization",
"email": "[email protected]",
"phoneNumber": "+1-470-555-7721"
},
"voicePickCode": "4642",
"harvestDate": "2021-03-14",
"labelImageUrl": "https://img.example.org/640/480/",
"labelImageHash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
"agricultureProduct": [
{
"type": [
"AgricultureProduct"
],
"plu": "94225",
"product": {
"type": [
"Product"
],
"manufacturer": {
"type": [
"Organization"
],
"email": "[email protected]",
"phoneNumber": "+1-300-555-2516"
},
"name": "Avocados",
"description": "Avocados, 4 pack boxes",
"weight": {
"type": [
"QuantitativeValue"
],
"unitCode": "hg/ha",
"value": "6960"
},
"sku": "81055399441"
},
"scientificName": "Persea americana",
"labelImageUrl": "https://img.example.org/033383401508/640/480/",
"labelImageHash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
}
]
}
],
"shipper": {
"type": [
"Organization"
],
"name": "Green Fields",
"description": "Growing & packaging for high quality produce",
"email": "[email protected]",
"phoneNumber": "+1-630-555-9134"
},
"purchaser": {
"type": [
"Organization"
],
"name": "Ace Foodstuffs",
"description": "Agricultural goods shipping & distribution",
"email": "[email protected]",
"phoneNumber": "+1-449-555-8392",
"faxNumber": "+1-542-555-0393"
},
"carrier": {
"type": [
"Organization"
],
"email": "[email protected]",
"phoneNumber": "+1-191-555-8578"
},
"broker": {
"type": [
"Organization"
],
"name": "Koch LLC",
"leiCode": "54321351219389121979"
}
},
"intendedUse": "fruits and vegetables",
"approvalDate": "2021-02-16",
"ppqHeadquarterOfficial": "APHIS eFile Automatic Issued Permit Regulated by 7 CFR 319.",
"permitConditions": "This permit authorizes the importation of the listed articles, under the conditions specified below. A copy of the first page of this permit must accompany all shipments authorized under this permit. For additional questions concerning this permit..."
}
}

0 comments on commit 09dd973

Please sign in to comment.