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

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

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

Maximum string length: 255

Corpo

application/json
referenceDate
string<date>
obrigatório

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.

Opções disponíveis:
P,
E

Resposta

Accepted

attempts
integer<int64>
obrigatório

Queue-put attempts made so far.

grids
object[]
obrigatório

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

id
string<uuid>
obrigatório

Schedule query id.

numCtrlIF
string
obrigatório

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

nuop
string
obrigatório

The BCMSG operation number of the frame.

referenceDate
string<date>
obrigatório

The date asked about (DtRef).

status
enum<string>
obrigatório

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.

Opções disponíveis:
SUBMITTED,
DISPATCHED,
ANSWERED,
REFUSED,
FAILED
submittedAt
string<date-time>
obrigatório

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.