Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

A Küldemény (Consignment) entitás hordozza egy megrendelés, egy levelének adatait.

AdattagTípusMagyarázatKötelezőMegszorítások
startPage
id
integer

pageCount

integer

Oldalak száma.

igen

  • értéktartomány: 1 .. 80
  • borítékmérettől függ

recipientAddress

long
Kezdőoldal sorszáma.

igen

  • értéktartomány: 1 .. n
  • értéke első küldemény esetén: 1
  • későbbi küldemények esetén a korábbi küldemény
    • kezdőoldala + oldalszáma
Küldemény azonosítója.Read only 

documentStructure

DocumentStructure vagy PartialDocumentStructure

A küldemény dokumentuma és a mellékletek vagy a megrendelés fődokumentumához tartozó leíró és a mellékletek.

Igen

  • Ha a megrendelés tartalmaz dokumentumot, akkor PartialDocumentStructure-nek kell lennie.
  • Ha a megrendelés nem tartalmaz dokumentumot, akkor DocumentStructure-nek kell lennie.

recipientAddress

FourLineAddress

vagy

FiveLineAddress

Címzett címe.
igen

Igen

Az értéke nem lehet null.

senderAddress

FourLineAddress

Feladó címe.
igen

Igen

Az értéke nem lehet null.

recordedDelivery

RecordedDelivery

vagy

OfficialMailRecordedDelivery

A tértivevényhez vagy hivatalos irat tértivevényéhez szükséges adatok.
nem

Nem

Csak

Tértivevény csak akkor adható meg, amennyiben

a megrendeléshez

kiválasztásra került a

Tértivevényes különszolgáltatás a postázási

Tértivevény különszolgáltatás a Postázási tulajdonságokban.

Hivatalos irat csak akkor adható meg, ha a megfelelő Levél típus kiválasztásra került a Postázási tulajdonságokban.

cheques

Vagy YellowCheque

[]

, vagy

WhiteCheque[]

WhiteCheque objektumokat tartalmazó tömb.

Küldeményhez tartozó csekkek.
nem

Nem

  • elemszám: 0..(küldemény oldalszáma – 1) *
  • egyik csekk sem kerülhet a küldemény első oldalára **
  • több csekk nem kerülhet azonos oldalra
  • a csekkeknek ugyanolyan típusúnak kell lenniük

responseEnvelopes

ResponseEnvelope[]

Küldeményhez tartozó válaszborítékok.

Nem

  • ha nem bevizsgálásra készül:
    • elemszám: maximum 1
    • egy válaszboríték egy oldal „kivételét” jelenti a maximális lapszámból
      • tehát a borítékokban elhelyezett lapok + válaszborítékok számának összegét kell viszonyítani a borítéktípusban elhelyezhető maximum lapszámhoz
      • amennyiben a küldemény tartalmaz legalább egy nagyméretű válaszborítékot, akkor csak
TC4
      • LC4-es borítékméret használható a küldeménynél

...

title*
  • ha bevizsgálásra készül:
    • a tömbnek üresnek kell lennie
sequenceNumberintegerA küldemény sorszáma a megrendelésben.Read only 
consignmentStatesConsignmentState[]Küldemény állapotai.Read only 
trackingNumberstringKövetési azonosító.Read only 
metadataMetadata[]Kiegészítő adatokNem 
createAddressPagebooleanKéri-e a címzőoldal küldemény elé való helyezését?IgenAz értéke nem lehet null.
attachmentsAttachment[]A küldeményhez csatolandó dokumentumok listája.Nem 

A küldemény első oldala a címhordozó oldal, ezért maximum a küldemény oldalszáma - 1 db csekket tartalmazhat egy levél.

** A küldemény első oldala a címhordozó, amely nem lehet csekk.