Get a filing pack

GET

/packs/{pack_id}

curl --request GET \
  --url https://api.europlaybook.com/v1/packs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• Production

A pack with its lines (the figures as filed with the scheme).

Authorizations

• BearerTokenAuth

Parameters

Path Parameters

pack_id

required

Pack Id

string format: uuid

Responses

200

OK

Media typeapplication/json

PackDetailOut

object

id

required

Id

string format: uuid

period_id

required

Period Id

string format: uuid

scheme

required

Scheme

string

report_type

required

Report Type

string

kind

required

Kind

Original or amendment.

string

status

required

Status

Draft, ready, approved or filed.

string

format

required

Format

string

has_file

required

Has File

boolean

approved_at

Any of:

string

string format: date-time

null

null

filed_at

Any of:

string

string format: date-time

null

null

filing_ref

Filing Ref

string

""

created_at

required

Created At

string format: date-time

lines

Lines

Array<object>

default:

PackLineOut

object

line_no

required

Line No

integer

key

required

Key

string

label

required

Label

string

value

required

Value

Kg with three decimals; counts as whole numbers.

string

unit

required

Unit

string

Allowed values: kg units parcels

Example

{
  "id": "0199f5a2-7c1e-7b4a-9d0e-3f6c2a1b8e44",
  "filing_ref": "",
  "lines": []
}

400

Bad Request

Media typeapplication/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object

object

key

additional properties

any

null

null

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

401

Unauthorized

Media typeapplication/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object

object

key

additional properties

any

null

null

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

403

Forbidden

Media typeapplication/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object

object

key

additional properties

any

null

null

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

404

Not Found

Media typeapplication/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object

object

key

additional properties

any

null

null

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

409

Conflict

Media typeapplication/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object

object

key

additional properties

any

null

null

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

422

Unprocessable Content

Media typeapplication/json

PublicValidationErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object

object

key

additional properties

any

null

null

errors

Errors

Per-field problems (pydantic format: loc, msg, type).

Array<object>

default:

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  },
  "errors": []
}

429

Too Many Requests

Media typeapplication/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object

object

key

additional properties

any

null

null

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}