Comharraich cùl-fhilidh mar sin-sgrìobhte

Comharraich sgrìobhainn mar shaor nuair a bhios ainm-sgrìobhaidh corporra no às an àbhaist fhaighinn. Faodaidh tu comharrachadh gu bheil an sgrìobhainn slàn deiseil, no comharrachadh gu bheil neach-faighinn fa-leth deiseil mura h-eil feadhainn eile fhathast a’ soidhnigeadh. Faodaidh tu PDF soidhnichte a luchdachadh suas aig an aon àm.

Ro-riatanasan

• Do ID sgrìobhainn (crypted ann am base64) — ma tha UUID REST agad, cuir doc roimhe agus cryptaich an toraidh ann am base64 (m.e. doc + <your-document-uuid> → base64). Faic Understand Web IDs and API IDs airson barrachd fiosrachaidh.

Roghainn A: Comharraich mar shaor gun luchdachadh suas PDF

Cuir fios gu markAsComplete le isUploaded: false. Tha an raon declarationText riatanach — cleachd e airson a chlàradh carson a tha an sgrìobhainn air a chomharrachadh deiseil (m.e. "Verbal confirmation received", "Wet signature obtained"). Faodar a leigeil falach mar shrìobhaidhean bàn, ach tha luach brìoghmhor feumail airson adhbharan sgrùdaidh-bheachdan.

mutation MarkAsComplete {
  markAsComplete(input: {
    documentId: "<document-id>"
    declarationText: "Verbal confirmation received"
    isUploaded: false
  })
}

Roghainn B: Comharraich mar shaor le luchdachadh suas PDF

Ceum 1: Faigh URL luchdachadh suas ro-shoidhnichte

Cuir fios chun upload query le uploadType: MARKASCOMPLETE airson URL S3 goirid-beatha fhaighinn.

query GetUploadUrl {
  upload(
    id: "<document-id>"
    uploadType: MARKASCOMPLETE
    extension: "pdf"
  ) {
    url
  }
}

Freagairt:

{
  "data": {
    "upload": {
      "url": "https://lon-files-clearing.s3-accelerate.amazonaws.com/upload/..."
    }
  }
}

Ceum 2: Cuir am faidhle gu S3 le PUT

Luchdaich am PDF soidhnichte dìreach chun an URL a chaidh a thoirt air ais le HTTP PUT iarrtas le Content-Type: application/pdf. Tha an URL goirid-beatha — cleachd e sa bhad. Faic Upload files airson tuilleadh fiosraichte mun cheum PUT.

curl -X PUT \
  -H "Content-Type: application/pdf" \
  --data-binary @signed-copy.pdf \
  "<url from previous step>"

Ceum 3: Comharraich an sgrìobhainn mar deiseil

Cuir fios gu markAsComplete le isUploaded: true. Bidh an raon declarationText ag obair mar an ceudna ri Roghainn A.

mutation MarkAsComplete {
  markAsComplete(input: {
    documentId: "<document-id>"
    declarationText: "Signed copy received by post"
    isUploaded: true
  })
}

Comharraich neach-faighinn fa-leth mar shaor

Cleachd markRecipientAsComplete nuair a tha neach fa leth air soidhnigeadh às an àbhaist ach nach eil feadhainn eile.

Ma tha thu airson PDF soidhnichte a luchdachadh suas airson an neach-faighinn, faigh an toiseach URL ro-shoidhnichte le uploadType: MARKRECIPIENTASCOMPLETE:

query GetUploadUrl {
  upload(
    id: "<recipient-id>"
    uploadType: MARKRECIPIENTASCOMPLETE
    extension: "pdf"
  ) {
    url
  }
}

An uair sin cuir am faidhle chun an URL air ais le PUT — faic Upload files.

Raointean cudromach:

• suppressNextRecipientNotification — suidhich gu true airson casg a chur air an ath neach-faighinn sa òrdugh soidhnidh a bhith air a thoirt fios sa bhad.
• auditlogText — roghnach. Leig falach e bàn mura h-eil feum air, ach tha luach brìoghmhor feumail airson adhbharan sgrùdaidh-bheachdan.

An dèidh sin, cuir fios gu markRecipientAsComplete:

mutation MarkRecipientAsComplete {
  markRecipientAsComplete(input: {
    recipientId: "<recipient-id>"
    documentOptions: NONE
    suppressNextRecipientNotification: false
    auditlogText: "Signed copy received by post"
  }) {
    id
    uploadId
  }
}

Clàr-seilbhe an sgrìobhainn (roghnach)

Cho luath ‘s a bhios e comharraichte mar deiseil, faodaidh tu an sgrìobhainn a chlàr-seilbhe gus a thoirt air falbh bhon sealladh sgrìobhainnean gnìomhach.

mutation ArchiveDocument {
  archiveDocument(input: {
    documentId: "<document-id>"
    restore: false
  })
}

Suidhich restore: true airson a chuir air ais às an clàr-seilbhe.

Co-cheangailte

• Authenticate
• markAsComplete
• markRecipientAsComplete
• upload query