Rahat Sistem

İrsaliye Dışa Aktarma

RahatSistem Demo

https://apidemo.rahatsistem.com.tr

POST

/v2/documents/despatch.export

İrsaliyee-İrsaliye

Açıklama

Bu endpoint, resmi gelen ve giden irsaliyelerinizi dışa aktarmak için kullanılır.

WARNING

mime bilgisi json gönderilmesi durumunda irsaliyenin directionbilgisi gönderilmelidir.

CAUTION

decoding bilgisi, true gönderilmesi durumunda response olarak dönen data binary olarak dönecektir. Bu bilgi varsayılan olarak false içerir ve dönen data base64 encode edilmiş şekilde response olarak döner. Bu durum JSON formatı için geçerli değildir. JSON her iki durumda da JSON Object olarak dönecektir.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/json

earchive

uuid

string

required

Resmi İrsaliye UUID Bilgisi

mime

enum<string>

required

Talep edilen export datanın MimeType bilgisi

Allowed values:

pdfxmlhtmljson

Examples:

htmlxml

decoded

boolean

optional

Response datanın binary olarak dönmesi talep edilirse true gönderilir. Varsayılan olarak false bilgisi ile base64 encoded olarak döner

Default:

false

direction

enum<string>

optional

mime bilgisinin JSON olarak talep edilmesi durumunda zorunludur

Allowed values:

outin

Example

{
  "uuid": "string",
  "mime": "pdf",
  "decoded": false,
  "direction": "out"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://apidemo.rahatsistem.com.tr/v2/documents/despatch.export' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "uuid": "string",
    "mime": "pdf",
    "decoded": false,
    "direction": "out"
}'

Responses

🟢200OK

application/json

Body

data

string

required

Base64 encoded irsaliye çıktısının bilgisidir

Default:

Successfully deleted

Example

{
  "data": "Successfully deleted"
}

🟢200OK

🟠400Bad Request

Taslaktaki İrsaliyeyi Gönderme

İrsaliye Listeleme

İrsaliye Dışa Aktarma

Açıklama#

Request

Request samples

Responses

Açıklama