Get Metadata
GET/metaData/{type?}
Returns Metadata of the requested Company, all the public Metadata, and all the Metadata for which the Company is whitelisted. When the Company has no Metadata an empty array will be returned.
Request
Path Parameters
- "normal"
- Returns all the Metadata, except those which are soft deleted.
- "trashed"
- Returns all the Metadata, including those which are soft deleted.
- "justtrashed"
- Returns only the Metadata which are soft deleted.
Possible values: [normal
, trashed
, justtrashed
]
Default value: normal
How to handle soft deleted ("archived") Metadata.
Responses
- 200
- 403
- 404
Metadata found.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
The guid of the Metadata.
Possible values: <= 255 characters
The human readable name for the Metadata.
Additional info for the Metadata, i.e. the description of the Metadata.
Possible values: [integer
, string
, date
, enum
, enumOther
, boolean
, values
, seatSelect
, phone
]
The type of the Metadata is related to UI that needs to be presented. The "seatSelect" type can only be set by an admin.
Possible values: <= 60000 characters
Extra information which is required for the type, i.e. this is Laravel validation rules.
When a ticket swap creates a new Ticket Type, whether the value of this Metadata should be copied to the new Ticket Type. If you are unsure, leave this false; incorrect usage could leak personal information.
Possible values: [none
, first_name
, last_name
, email
, gender
, date_of_birth
, age
, city
, country
]
The Facebook input type to auto fill the Metadata. This has been disabled by Facebook.
The translated name. This property is calculated.
Whether the Metadata is translatable or not.
[
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"shop_description": "string",
"type": "integer",
"extra": "string",
"copy_on_swap": true,
"auto_fill_facebook": "none",
"translate_name": "string",
"translatable": true
}
]
Unauthorized. You do not have permission to retrieve Metadata of the Company.
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}
Company not found.
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}