DocumentNumber

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getDocumentNumber

post

Retrieve document number data.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getDocumentNumber

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getDocumentNumber HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "DocumentNumber": {
    "Certificate": 1,
    "Check": [
      {
        "EntryId": 1,
        "Check": 1
      }
    ],
    "Receipt": 1
  }
}

getDocumentNumberSelectFields

post

Retrieve select fields for document number data.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getDocumentNumberSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getDocumentNumberSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 254

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllDocumentNumberFields": true,
    "DocumentNumberFields": {
      "Certificate": true,
      "Check": [
        1
      ],
      "Receipt": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "DocumentNumber": {
    "Certificate": 1,
    "Check": [
      {
        "EntryId": 1,
        "Check": 1
      }
    ],
    "Receipt": 1
  }
}

updateDocumentNumberByID

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/updateDocumentNumberByID

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/updateDocumentNumberByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 220

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DocumentNumberUpdatableFields": {
    "Certificate": 1,
    "Check": [
      {
        "EntryId": 1,
        "Check": 1
      }
    ],
    "Receipt": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}