Mark an inbound transfer for urgent processing - Lerian

Mark an inbound transfer for urgent processing

curl --request POST \
  --url https://sta.sandbox.lerian.net/v1/inbound/transfers/{id}/mark-urgent \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sta.sandbox.lerian.net/v1/inbound/transfers/{id}/mark-urgent"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sta.sandbox.lerian.net/v1/inbound/transfers/{id}/mark-urgent', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://sta.sandbox.lerian.net/v1/inbound/transfers/{id}/mark-urgent"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

{
  "bytesDownloaded": 123,
  "bytesUploaded": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "credentialId": "<string>",
  "currentState": "<string>",
  "currentStateCode": 123,
  "direction": "<string>",
  "documentType": "<string>",
  "downloadAttempts": 123,
  "expired": true,
  "fileName": "<string>",
  "fileSizeBytes": 123,
  "hashMismatchAttempts": 123,
  "id": "<string>",
  "secondsRemaining": 123,
  "transmissionAttempts": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "uploadAttempts": 123,
  "errorCode": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "fileRef": "<string>",
  "lastTransitError": "<string>",
  "protocolGeneratedAt": "2023-11-07T05:31:56Z",
  "protocolNumber": "<string>",
  "sourceProduct": "<string>",
  "urgentRequestedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

POST

/

v1

/

inbound

/

transfers

/

{id}

/

mark-urgent

Mark an inbound transfer for urgent processing

curl --request POST \
  --url https://sta.sandbox.lerian.net/v1/inbound/transfers/{id}/mark-urgent \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sta.sandbox.lerian.net/v1/inbound/transfers/{id}/mark-urgent"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sta.sandbox.lerian.net/v1/inbound/transfers/{id}/mark-urgent', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://sta.sandbox.lerian.net/v1/inbound/transfers/{id}/mark-urgent"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

{
  "bytesDownloaded": 123,
  "bytesUploaded": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "credentialId": "<string>",
  "currentState": "<string>",
  "currentStateCode": 123,
  "direction": "<string>",
  "documentType": "<string>",
  "downloadAttempts": 123,
  "expired": true,
  "fileName": "<string>",
  "fileSizeBytes": 123,
  "hashMismatchAttempts": 123,
  "id": "<string>",
  "secondsRemaining": 123,
  "transmissionAttempts": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "uploadAttempts": 123,
  "errorCode": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "fileRef": "<string>",
  "lastTransitError": "<string>",
  "protocolGeneratedAt": "2023-11-07T05:31:56Z",
  "protocolNumber": "<string>",
  "sourceProduct": "<string>",
  "urgentRequestedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

id

string

requerido

Inbound transfer UUID

Ejemplo:

"018f3b2a-0c1d-7a2b-9e4f-1a2b3c4d5e6f"

Respuesta

OK

bytesDownloaded

integer<int64>

requerido

bytesUploaded

integer<int64>

requerido

createdAt

string<date-time>

requerido

credentialId

string

requerido

currentState

string

requerido

currentStateCode

integer<int64>

requerido

direction

string

requerido

documentType

string

requerido

downloadAttempts

integer<int64>

requerido

expired

boolean

requerido

fileName

string

requerido

fileSizeBytes

integer<int64>

requerido

hashMismatchAttempts

integer<int64>

requerido

id

string

requerido

secondsRemaining

integer<int64>

requerido

transmissionAttempts

integer<int64>

requerido

updatedAt

string<date-time>

requerido

uploadAttempts

integer<int64>

requerido

errorCode

string

expiresAt

string<date-time>

fileRef

string

lastTransitError

string

protocolGeneratedAt

string<date-time>

protocolNumber

string

sourceProduct

string

urgentRequestedAt

string<date-time>