Jump to

• Request
• Response

Get a Trade License

get

/tradeLicenses/{licenseGid}

Request

Path Parameters

• licenseGid(required): string
  Resource ID

Query Parameters

• expand: string
  Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
• fields: string
  Comma-delimited string of field names that you wanted returned in a GET request.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=singular

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• approvalDate: approvalDate
  The date on which the license was approved by the licensing authority.
• attribute1: string
  No description.
• attribute10: string
  No description.
• attribute11: string
  No description.
• attribute12: string
  No description.
• attribute13: string
  No description.
• attribute14: string
  No description.
• attribute15: string
  No description.
• attribute16: string
  No description.
• attribute17: string
  No description.
• attribute18: string
  No description.
• attribute19: string
  No description.
• attribute2: string
  No description.
• attribute20: string
  No description.
• attribute3: string
  No description.
• attribute4: string
  No description.
• attribute5: string
  No description.
• attribute6: string
  No description.
• attribute7: string
  No description.
• attribute8: string
  No description.
• attribute9: string
  No description.
• attributeDate1: attributeDate1
  No description.
• attributeDate10: attributeDate10
  No description.
• attributeDate2: attributeDate2
  No description.
• attributeDate3: attributeDate3
  No description.
• attributeDate4: attributeDate4
  No description.
• attributeDate5: attributeDate5
  No description.
• attributeDate6: attributeDate6
  No description.
• attributeDate7: attributeDate7
  No description.
• attributeDate8: attributeDate8
  No description.
• attributeDate9: attributeDate9
  No description.
• attributeNumber1: number (double)
  No description.
• attributeNumber10: number (double)
  No description.
• attributeNumber2: number (double)
  No description.
• attributeNumber3: number (double)
  No description.
• attributeNumber4: number (double)
  No description.
• attributeNumber5: number (double)
  No description.
• attributeNumber6: number (double)
  No description.
• attributeNumber7: number (double)
  No description.
• attributeNumber8: number (double)
  No description.
• attributeNumber9: number (double)
  No description.
• controlTypeCodes: controlTypeCodes
• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The date on which the license is effective.
• endDate: endDate
  The date on which the license ends.
• expirationDate: expirationDate
  The date on which the license expires.
• gtmJurisdictionGid: string
  The GID for the jurisdiction.
• gtmRegimeGid: string
  The GID for the regime.
• indicator: string
  Marks the condition or state of the GTM license using colors.
• insertDate: insertDate
  Read Only: true

  insert date
• involvedParties: involvedParties
• isActive: boolean
  Checkbox indicating if the license record is active or not.
• isTemplate: boolean
  Checkbox indicating whether or not this license record will be used as a license template or not.
• licenseCategoryGid: string
  The GID for the GTM license category.
• licenseCode: string
  The license code assigned to the license.
• licenseDates: licenseDates
• licenseGid: string
  The GID for the GTM license.
• licenseNumber: string
  The license number issued by the licensing authority.
• licenseTypeGid: string
  The GID for the GTM license type.
• licenseXid: string
  The XID for the GTM license.
• lines: lines
• links: array links
  Read Only: true
• ports: ports
• refnums: refnums
• regions: regions
• remarks: remarks
• renewalDate: renewalDate
  The date on which the license was renewed with the licensing authority.
• requestedDate: requestedDate
  The date on which the license was requested from the licensing authority.
• statuses: statuses
• texts: texts
• tradeRelatedLicenses: tradeRelatedLicenses
• tradeRelatedRegistrations: tradeRelatedRegistrations
• typeCodes: typeCodes
• updateDate: updateDate
  Read Only: true

  update date
• userDefined1IconGid: string
  Marks the condition or state of the GTM license using images. It is a foreign key reference to ICON table.
• userDefined2IconGid: string
  Marks the condition or state of the GTM license using images. It is a foreign key reference to ICON table.
• userDefined3IconGid: string
  Marks the condition or state of the GTM license using images. It is a foreign key reference to ICON table.
• userDefined4IconGid: string
  Marks the condition or state of the GTM license using images. It is a foreign key reference to ICON table.
• userDefined5IconGid: string
  Marks the condition or state of the GTM license using images. It is a foreign key reference to ICON table.

{
    "properties":{
        "licenseGid":{
            "description":"The GID for the GTM license.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "licenseXid":{
            "description":"The XID for the GTM license.",
            "type":"string"
        },
        "licenseNumber":{
            "description":"The license number issued by the licensing authority.",
            "type":"string"
        },
        "licenseCategoryGid":{
            "description":"The GID for the GTM license category.",
            "type":"string"
        },
        "licenseTypeGid":{
            "description":"The GID for the GTM license type.",
            "type":"string"
        },
        "licenseCode":{
            "description":"The license code assigned to the license.",
            "type":"string"
        },
        "gtmRegimeGid":{
            "description":"The GID for the regime.",
            "type":"string"
        },
        "gtmJurisdictionGid":{
            "description":"The GID for the jurisdiction.",
            "type":"string"
        },
        "isTemplate":{
            "description":"Checkbox indicating whether or not this license record will be used as a license template or not.",
            "type":"boolean"
        },
        "indicator":{
            "description":"Marks the condition or state of the GTM license using colors.",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"Marks the condition or state of the GTM license using images. It is a foreign key reference to ICON table. ",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"Marks the condition or state of the GTM license using images. It is a foreign key reference to ICON table. ",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"Marks the condition or state of the GTM license using images. It is a foreign key reference to ICON table. ",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"Marks the condition or state of the GTM license using images. It is a foreign key reference to ICON table. ",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"Marks the condition or state of the GTM license using images. It is a foreign key reference to ICON table. ",
            "type":"string"
        },
        "isActive":{
            "description":"Checkbox indicating if the license record is active or not.",
            "type":"boolean"
        },
        "effectiveDate":{
            "description":"The date on which the license is effective.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"The date on which the license expires.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "requestedDate":{
            "description":"The date on which the license was requested from the licensing authority.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "approvalDate":{
            "description":"The date on which the license was approved by the licensing authority.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "renewalDate":{
            "description":"The date on which the license was renewed with the licensing authority.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "endDate":{
            "description":"The date on which the license ends.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attribute1":{
            "description":"No description.",
            "type":"string"
        },
        "attribute2":{
            "description":"No description.",
            "type":"string"
        },
        "attribute3":{
            "description":"No description.",
            "type":"string"
        },
        "attribute4":{
            "description":"No description.",
            "type":"string"
        },
        "attribute5":{
            "description":"No description.",
            "type":"string"
        },
        "attribute6":{
            "description":"No description.",
            "type":"string"
        },
        "attribute7":{
            "description":"No description.",
            "type":"string"
        },
        "attribute8":{
            "description":"No description.",
            "type":"string"
        },
        "attribute9":{
            "description":"No description.",
            "type":"string"
        },
        "attribute10":{
            "description":"No description.",
            "type":"string"
        },
        "attribute11":{
            "description":"No description.",
            "type":"string"
        },
        "attribute12":{
            "description":"No description.",
            "type":"string"
        },
        "attribute13":{
            "description":"No description.",
            "type":"string"
        },
        "attribute14":{
            "description":"No description.",
            "type":"string"
        },
        "attribute15":{
            "description":"No description.",
            "type":"string"
        },
        "attribute16":{
            "description":"No description.",
            "type":"string"
        },
        "attribute17":{
            "description":"No description.",
            "type":"string"
        },
        "attribute18":{
            "description":"No description.",
            "type":"string"
        },
        "attribute19":{
            "description":"No description.",
            "type":"string"
        },
        "attribute20":{
            "description":"No description.",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "lines":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeLicenses.lines"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeLicenses.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "typeCodes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeLicenses.typeCodes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeLicenses.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "tradeRelatedLicenses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeLicenses.tradeRelatedLicenses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "tradeRelatedRegistrations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeLicenses.tradeRelatedRegistrations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "ports":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeLicenses.ports"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "controlTypeCodes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeLicenses.controlTypeCodes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeLicenses.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeLicenses.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "regions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeLicenses.regions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeLicenses.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "licenseDates":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeLicenses.licenseDates"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : approvalDate

The date on which the license was approved by the licensing authority.

Match All

Show Source

• object dateType

{
    "description":"The date on which the license was approved by the licensing authority.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : attributeDate1

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : controlTypeCodes

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeLicenses.controlTypeCodes"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The date on which the license is effective.

Match All

Show Source

• object dateType

{
    "description":"The date on which the license is effective.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : endDate

The date on which the license ends.

Match All

Show Source

• object dateType

{
    "description":"The date on which the license ends.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

The date on which the license expires.

Match All

Show Source

• object dateType

{
    "description":"The date on which the license expires.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeLicenses.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : licenseDates

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeLicenses.licenseDates"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : lines

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeLicenses.lines"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : ports

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeLicenses.ports"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeLicenses.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : regions

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeLicenses.regions"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeLicenses.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : renewalDate

The date on which the license was renewed with the licensing authority.

Match All

Show Source

• object dateType

{
    "description":"The date on which the license was renewed with the licensing authority.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : requestedDate

The date on which the license was requested from the licensing authority.

Match All

Show Source

• object dateType

{
    "description":"The date on which the license was requested from the licensing authority.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeLicenses.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : texts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeLicenses.texts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : tradeRelatedLicenses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeLicenses.tradeRelatedLicenses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : tradeRelatedRegistrations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeLicenses.tradeRelatedRegistrations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : typeCodes

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeLicenses.typeCodes"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object tradeLicenses.controlTypeCodes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeLicenses.controlTypeCodes"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeLicenses.controlTypeCodes

Type: object

Show Source

• controlCode: string
  The control code associated with the GTM license.
• domainName: string
  Database domain where this data is stored.
• gtmControlTypeGid: string
  The GID for the control type associated with the GTM license.
• links: array links
  Read Only: true

{
    "properties":{
        "gtmControlTypeGid":{
            "description":"The GID for the control type associated with the GTM license.",
            "type":"string"
        },
        "controlCode":{
            "description":"The control code associated with the GTM license.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object tradeLicenses.involvedParties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeLicenses.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeLicenses.involvedParties

Type: object

Show Source

• comMethodGid: string
  The GID for the communication method of the involved party.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContactGid: string
  The GID for the involved party contact or party.
• involvedPartyQualGid: string
  The GID for the involved party qualifier.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The GID for the involved party qualifier.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The GID for the involved party contact or party.",
            "type":"string"
        },
        "comMethodGid":{
            "description":"The GID for the communication method of the involved party.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tradeLicenses.licenseDates

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeLicenses.licenseDates"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeLicenses.licenseDates

Type: object

Show Source

• dateQualifierGid: string
  The GID for the date qualifier.
• domainName: string
  Database domain where this data is stored.
• licenseDate: licenseDate
  The license date.
• links: array links
  Read Only: true

{
    "properties":{
        "dateQualifierGid":{
            "description":"The GID for the date qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "licenseDate":{
            "description":"The license date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : licenseDate

The license date.

Match All

Show Source

• object dateType

{
    "description":"The license date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tradeLicenses.lines

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeLicenses.lines"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeLicenses.lines

Type: object

Show Source

• attribute1: string
  No description.
• attribute10: string
  No description.
• attribute11: string
  No description.
• attribute12: string
  No description.
• attribute13: string
  No description.
• attribute14: string
  No description.
• attribute15: string
  No description.
• attribute16: string
  No description.
• attribute17: string
  No description.
• attribute18: string
  No description.
• attribute19: string
  No description.
• attribute2: string
  No description.
• attribute20: string
  No description.
• attribute3: string
  No description.
• attribute4: string
  No description.
• attribute5: string
  No description.
• attribute6: string
  No description.
• attribute7: string
  No description.
• attribute8: string
  No description.
• attribute9: string
  No description.
• attributeDate1: attributeDate1
  No description.
• attributeDate10: attributeDate10
  No description.
• attributeDate2: attributeDate2
  No description.
• attributeDate3: attributeDate3
  No description.
• attributeDate4: attributeDate4
  No description.
• attributeDate5: attributeDate5
  No description.
• attributeDate6: attributeDate6
  No description.
• attributeDate7: attributeDate7
  No description.
• attributeDate8: attributeDate8
  No description.
• attributeDate9: attributeDate9
  No description.
• attributeNumber1: number (double)
  No description.
• attributeNumber10: number (double)
  No description.
• attributeNumber2: number (double)
  No description.
• attributeNumber3: number (double)
  No description.
• attributeNumber4: number (double)
  No description.
• attributeNumber5: number (double)
  No description.
• attributeNumber6: number (double)
  No description.
• attributeNumber7: number (double)
  No description.
• attributeNumber8: number (double)
  No description.
• attributeNumber9: number (double)
  No description.
• balanceQuantity: number (double)
  The Total Available Quantity which is calculated as Authorized Quantity - Used Quantity - Reserved Quantity.
• balanceQuantityUomCode: string
  The unit of measure of the available quantity on the license line.
• balCurrencyValue: balCurrencyValue
  The Total Available Value which is calculated as Authorized Value - Used Value - Reserved Value.
• commodityGid: string
  The GID for commodity associated with the GTM license line.
• currencyValue: currencyValue
  The value that is authorized by the licensing authority.
• domainName: string
  Database domain where this data is stored.
• gtmQuantityTypeGid: string
  The GID for the GTM license line quantity qualifier.
• gtmValueQualifierGid: string
  The GID for the GTM license line value qualifier.
• indicator: string
  Marks the condition or state of the GTM license line using colors.
• items: items
• licenseItemName: string
  Description of the license line.
• licenseLineGid: string
  The GID for the GTM license line.
• licenseLineXid: string
  The XID for the GTM license line.
• lineType: string
  Indicates if the license line is an export or an import.
• links: array links
  Read Only: true
• productClassification: string
  Specifies the product classification code or formula used to match a license line to a transaction line or declaration line.
• quantity: number (double)
  The quantity that is authorized by the licensing authority.
• quantityUomCode: string
  The unit of measure of the authorized quantity on the license line.
• refnums: refnums
• remarks: remarks
• reservedQuantity: number (double)
  The quantity that is reserved on the license line.
• reservedQuantityUomCode: string
  The unit of measure of the reserved quantity on the license line.
• reservedValue: reservedValue
  The value that is reserved on the license line.
• usedQuantity: number (double)
  The quantity that is used with respect to the authorized quantity on the license line.
• usedQuantityUomCode: string
  The unit of measure of the used quantity on the license line.
• usedValue: usedValue
  The value that is used with respect to the authorized value on the license line.
• userDefined1IconGid: string
  Marks the condition or state of the GTM license line using images. It is a foreign key reference to ICON table.
• userDefined2IconGid: string
  Marks the condition or state of the GTM license line using images. It is a foreign key reference to ICON table.
• userDefined3IconGid: string
  Marks the condition or state of the GTM license line using images. It is a foreign key reference to ICON table.
• userDefined4IconGid: string
  Marks the condition or state of the GTM license line using images. It is a foreign key reference to ICON table.
• userDefined5IconGid: string
  Marks the condition or state of the GTM license line using images. It is a foreign key reference to ICON table.
• userDefinedCommodityGid: string
  The GID for user-defined commodity associated with the GTM license line.
• values: values

{
    "properties":{
        "licenseLineGid":{
            "description":"The GID for the GTM license line.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "licenseLineXid":{
            "description":"The XID for the GTM license line.",
            "type":"string"
        },
        "commodityGid":{
            "description":"The GID for commodity associated with the GTM license line.",
            "type":"string"
        },
        "userDefinedCommodityGid":{
            "description":"The GID for user-defined commodity associated with the GTM license line.",
            "type":"string"
        },
        "balanceQuantity":{
            "description":"The Total Available Quantity which is calculated as Authorized Quantity - Used Quantity - Reserved Quantity.",
            "type":"number",
            "format":"double"
        },
        "lineType":{
            "description":"Indicates if the license line is an export or an import. ",
            "type":"string"
        },
        "productClassification":{
            "description":"Specifies the product classification code or formula used to match a license line to a transaction line or declaration line. ",
            "type":"string"
        },
        "licenseItemName":{
            "description":"Description of the license line.",
            "type":"string"
        },
        "quantity":{
            "description":"The quantity that is authorized by the licensing authority.",
            "type":"number",
            "format":"double"
        },
        "balanceQuantityUomCode":{
            "description":"The unit of measure of the available quantity on the license line. ",
            "type":"string"
        },
        "gtmValueQualifierGid":{
            "description":"The GID for the GTM license line value qualifier.",
            "type":"string"
        },
        "gtmQuantityTypeGid":{
            "description":"The GID for the GTM license line quantity qualifier.",
            "type":"string"
        },
        "quantityUomCode":{
            "description":"The unit of measure of the authorized quantity on the license line. ",
            "type":"string"
        },
        "currencyValue":{
            "description":"The value that is authorized by the licensing authority.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "balCurrencyValue":{
            "description":"The Total Available Value which is calculated as Authorized Value - Used Value - Reserved Value.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "indicator":{
            "description":"Marks the condition or state of the GTM license line using colors.",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"Marks the condition or state of the GTM license line using images. It is a foreign key reference to ICON table. ",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"Marks the condition or state of the GTM license line using images. It is a foreign key reference to ICON table. ",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"Marks the condition or state of the GTM license line using images. It is a foreign key reference to ICON table. ",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"Marks the condition or state of the GTM license line using images. It is a foreign key reference to ICON table. ",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"Marks the condition or state of the GTM license line using images. It is a foreign key reference to ICON table. ",
            "type":"string"
        },
        "usedQuantity":{
            "description":"The quantity that is used with respect to the authorized quantity on the license line.",
            "type":"number",
            "format":"double"
        },
        "usedQuantityUomCode":{
            "description":"The unit of measure of the used quantity on the license line. ",
            "type":"string"
        },
        "reservedQuantity":{
            "description":"The quantity that is reserved on the license line.",
            "type":"number",
            "format":"double"
        },
        "reservedQuantityUomCode":{
            "description":"The unit of measure of the reserved quantity on the license line. ",
            "type":"string"
        },
        "usedValue":{
            "description":"The value that is used with respect to the authorized value on the license line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "reservedValue":{
            "description":"The value that is reserved on the license line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attribute1":{
            "description":"No description.",
            "type":"string"
        },
        "attribute2":{
            "description":"No description.",
            "type":"string"
        },
        "attribute3":{
            "description":"No description.",
            "type":"string"
        },
        "attribute4":{
            "description":"No description.",
            "type":"string"
        },
        "attribute5":{
            "description":"No description.",
            "type":"string"
        },
        "attribute6":{
            "description":"No description.",
            "type":"string"
        },
        "attribute7":{
            "description":"No description.",
            "type":"string"
        },
        "attribute8":{
            "description":"No description.",
            "type":"string"
        },
        "attribute9":{
            "description":"No description.",
            "type":"string"
        },
        "attribute10":{
            "description":"No description.",
            "type":"string"
        },
        "attribute11":{
            "description":"No description.",
            "type":"string"
        },
        "attribute12":{
            "description":"No description.",
            "type":"string"
        },
        "attribute13":{
            "description":"No description.",
            "type":"string"
        },
        "attribute14":{
            "description":"No description.",
            "type":"string"
        },
        "attribute15":{
            "description":"No description.",
            "type":"string"
        },
        "attribute16":{
            "description":"No description.",
            "type":"string"
        },
        "attribute17":{
            "description":"No description.",
            "type":"string"
        },
        "attribute18":{
            "description":"No description.",
            "type":"string"
        },
        "attribute19":{
            "description":"No description.",
            "type":"string"
        },
        "attribute20":{
            "description":"No description.",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "items":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeLicenses.lines.items"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "values":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeLicenses.lines.values"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeLicenses.lines.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeLicenses.lines.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : balCurrencyValue

The Total Available Value which is calculated as Authorized Value - Used Value - Reserved Value.

Match All

Show Source

• object currencyType

{
    "description":"The Total Available Value which is calculated as Authorized Value - Used Value - Reserved Value.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : currencyValue

The value that is authorized by the licensing authority.

Match All

Show Source

• object currencyType

{
    "description":"The value that is authorized by the licensing authority.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : items

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeLicenses.lines.items"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeLicenses.lines.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeLicenses.lines.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : reservedValue

The value that is reserved on the license line.

Match All

Show Source

• object currencyType

{
    "description":"The value that is reserved on the license line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : usedValue

The value that is used with respect to the authorized value on the license line.

Match All

Show Source

• object currencyType

{
    "description":"The value that is used with respect to the authorized value on the license line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : values

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeLicenses.lines.values"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : currencyType

Type: object

Show Source

• currency: string
  ISO 4217 currency code
• value: number
  Numeric value that specifies a currency

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies a currency",
            "type":"number"
        },
        "currency":{
            "description":"ISO 4217 currency code",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object tradeLicenses.lines.items

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeLicenses.lines.items"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeLicenses.lines.items

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• itemGid: string
  The GID for the item associated with the GTM license line.
• links: array links
  Read Only: true

{
    "properties":{
        "itemGid":{
            "description":"The GID for the item associated with the GTM license line.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tradeLicenses.lines.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeLicenses.lines.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeLicenses.lines.refnums

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• gtmLicLineRefnumQualGid: string
  The GID for the GTM license line reference number qualifier.
• links: array links
  Read Only: true
• refnumValue: string
  The value of the reference number.

{
    "properties":{
        "refnumValue":{
            "description":"The value of the reference number.",
            "type":"string"
        },
        "gtmLicLineRefnumQualGid":{
            "description":"The GID for the GTM license line reference number qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tradeLicenses.lines.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeLicenses.lines.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeLicenses.lines.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The GID for the GTM license line remark.
• remarkSequence: number (int64)
  The sequence number for the GTM license line remark.
• remarkText: string
  The remark text for the GTM license line.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence number for the GTM license line remark. ",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarkQualGid":{
            "description":"The GID for the GTM license line remark.",
            "type":"string"
        },
        "remarkText":{
            "description":"The remark text for the GTM license line. ",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tradeLicenses.lines.values

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeLicenses.lines.values"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeLicenses.lines.values

Type: object

Show Source

• currencyValue: currencyValue
  The currency value of the license line.
• domainName: string
  Database domain where this data is stored.
• gtmValueQualifierGid: string
  The GID for the value qualifier on the license line.
• isBalanceCalc: boolean
  Indicates if the balance has been calculated. Values are Y/N.
• links: array links
  Read Only: true

{
    "properties":{
        "gtmValueQualifierGid":{
            "description":"The GID for the value qualifier on the license line.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "isBalanceCalc":{
            "description":"Indicates if the balance has been calculated. Values are Y/N.",
            "type":"boolean"
        },
        "currencyValue":{
            "description":"The currency value of the license line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : currencyValue

The currency value of the license line.

Match All

Show Source

• object currencyType

{
    "description":"The currency value of the license line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tradeLicenses.ports

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeLicenses.ports"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeLicenses.ports

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• gtmPortQualifierGid: string
  The GID for the GTM port qualifier.
• links: array links
  Read Only: true
• locationGid: string
  The GID for the location.

{
    "properties":{
        "gtmPortQualifierGid":{
            "description":"The GID for the GTM port qualifier.",
            "type":"string"
        },
        "locationGid":{
            "description":"The GID for the location.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tradeLicenses.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeLicenses.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeLicenses.refnums

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• gtmLicenseRefnumQualGid: string
  The GID for the GTM license reference number qualifier.
• links: array links
  Read Only: true
• refnumValue: string
  The value of the reference number.

{
    "properties":{
        "refnumValue":{
            "description":"The value of the reference number.",
            "type":"string"
        },
        "gtmLicenseRefnumQualGid":{
            "description":"The GID for the GTM license reference number qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tradeLicenses.regions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeLicenses.regions"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeLicenses.regions

Type: object

Show Source

• countryCode3Gid: string
  The GID for the country code.
• domainName: string
  Database domain where this data is stored.
• licenseRegionSequence: number (int64)
  The sequence number for the GTM license region.
• links: array links
  Read Only: true
• regionGid: string
  The GID for the GTM license region.
• regionQualGid: string
  The GID for the GTM license region qualifier.

{
    "properties":{
        "licenseRegionSequence":{
            "description":"The sequence number for the GTM license region. ",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "regionQualGid":{
            "description":"The GID for the GTM license region qualifier.",
            "type":"string"
        },
        "regionGid":{
            "description":"The GID for the GTM license region.",
            "type":"string"
        },
        "countryCode3Gid":{
            "description":"The GID for the country code.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tradeLicenses.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeLicenses.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeLicenses.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The GID for the GTM license remark qualifier.
• remarkSequence: number (int64)
  The sequence number for the GTM license remark.
• remarkText: string
  The remark text for the GTM license.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence number for the GTM license remark. ",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarkQualGid":{
            "description":"The GID for the GTM license remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"The remark text for the GTM license. ",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tradeLicenses.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeLicenses.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeLicenses.statuses

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  The GID for the license status type.
• statusValueGid: string
  The GID for the license status value.

{
    "properties":{
        "statusTypeGid":{
            "description":"The GID for the license status type.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The GID for the license status value.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tradeLicenses.texts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeLicenses.texts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeLicenses.texts

Type: object

Show Source

• documentDefGid: string
  The GID for the document type associated with the GTM license text template.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• textOverride: string
  Transactional override for the template on the specific document
• textTemplateGid: string
  The GID for the text template associated with the GTM license.

{
    "properties":{
        "textTemplateGid":{
            "description":"The GID for the text template associated with the GTM license.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"The GID for the document type associated with the GTM license text template.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "textOverride":{
            "description":"Transactional override for the template on the specific document",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tradeLicenses.tradeRelatedLicenses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeLicenses.tradeRelatedLicenses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeLicenses.tradeRelatedLicenses

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• relatedLicenseGid: string
  The GID for related license associated with the GTM license.

{
    "properties":{
        "relatedLicenseGid":{
            "description":"The GID for related license associated with the GTM license.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tradeLicenses.tradeRelatedRegistrations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeLicenses.tradeRelatedRegistrations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeLicenses.tradeRelatedRegistrations

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• gtmRegistrationGid: string
  The GID for related registration associated with the GTM license.
• links: array links
  Read Only: true

{
    "properties":{
        "gtmRegistrationGid":{
            "description":"The GID for related registration associated with the GTM license.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tradeLicenses.typeCodes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeLicenses.typeCodes"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeLicenses.typeCodes

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• gtmCode: string
  The corresponding code for the GTM type.
• gtmTypeGid: string
  The GID for the GTM type or user-defined type.
• links: array links
  Read Only: true

{
    "properties":{
        "gtmTypeGid":{
            "description":"The GID for the GTM type or user-defined type. ",
            "type":"string"
        },
        "gtmCode":{
            "description":"The corresponding code for the GTM type.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Back to Top