Skip to main content
POST
Ask the câmara for its LDL schedule grid

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Idempotency key for this state-changing request (required, max 255 characters).

Maximum string length: 255

Body

application/json
referenceDate
string<date>
required

The date to ask about (DtRef), YYYY-MM-DD.

scheduleType
enum<string>

P (padrão) or E (eventual). Omit to ask without constraining the type. Asking for E on a date with no eventual change is answered with the standard grid.

Available options:
P,
E

Response

Accepted

attempts
integer<int64>
required

Queue-put attempts made so far.

grids
object[]
required

The grades de horário the answer returned (never null; empty until the câmara answers).

id
string<uuid>
required

Schedule query id.

numCtrlIF
string
required

The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two.

nuop
string
required

The BCMSG operation number of the frame.

referenceDate
string<date>
required

The date asked about (DtRef).

status
enum<string>
required

Lifecycle state. REFUSED means the câmara received the query and returned its E twin (LDL0023E); FAILED means this rail could not deliver it. Both are terminal and they are different facts.

Available options:
SUBMITTED,
DISPATCHED,
ANSWERED,
REFUSED,
FAILED
submittedAt
string<date-time>
required

When the query was recorded.

answeredAt
string<date-time>

When the câmara's answer was applied; omitted until it is.

dispatchedAt
string<date-time>

When the frame reached the send queue; omitted until it has.

lastError
string

Why the last queue put failed; omitted when none has.

scheduleType
string

P (padrão) or E (eventual); omitted when the query did not constrain the type.