Validate Import

POST 
/import/validate

Validates the Import data.

Request

application/json

Body

Input data

csv_string string

Content of an import CSV file. This is required when path is not given in the request.

path url

The URL path to an import CSV file. This is only used if the csv_string is not given in the request. This is required when csv_string is not given in the request.

Responses

200

Validation successful.

application/json

Schema

Schema

• Array [

order

object

shop_id uuid

The guid of the Shop associated with the Order.

firstName string

The first name of the Receiver.

lastName string

The last name of the Receiver.

email email

The email address of the Receiver.

locale IETF BCP 47

The locale of the Receiver.

created_at ISO 8601

The time it was created.

tickets

object[]

Array [

ticket_id uuid

The guid of the Ticket.

ticket_number string

The barcode of the Ticket.

created_at ISO 8601

The time it was created.

metadata

object

guid string

The guid of the Metadata.

]

metadata

object

guid string

The guid of the Metadata.

• ]

Example (from schema)

[
  {
    "order": {
      "shop_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "firstName": "string",
      "lastName": "string",
      "email": "user@example.com",
      "locale": "string",
      "created_at": "string",
      "tickets": [
        {
          "ticket_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "ticket_number": "string",
          "created_at": "string",
          "metadata": {
            "guid": "string"
          }
        }
      ],
      "metadata": {
        "guid": "string"
      }
    }
  }
]

403

The user does not have the correct role(s), or the CSV data contained invalid Shops or Ticket Types.

application/json

Schema

Schema

error_code string

The general error code.

error_description stringrequired

The exact reason of failure.

Example (from schema)

{
  "error_code": "string",
  "error_description": "string"
}

404

Company or Metadata not found.

application/json

Schema

Schema

error_code string

The general error code.

error_description stringrequired

The exact reason of failure.

Example (from schema)

{
  "error_code": "string",
  "error_description": "string"
}

406

The request variables are invalid, the CSV data is invalid or the user is not allowed to make the operation on (one of) the shops and/or Ticket Types, the

• import data is returned as JSON in the error message

application/json

Schema

Schema

error_code string

The general error code.

error_description stringrequired

The exact reason of failure.

Example (from schema)

{
  "error_code": "string",
  "error_description": "string"
}

500

Internal server error. Something went wrong during the validation of the Import data.

application/json

Schema

Schema

error_code string

The general error code.

error_description stringrequired

The exact reason of failure.

Example (from schema)

{
  "error_code": "string",
  "error_description": "string"
}

Loading...