API docs by Redocly

Ebsconet integration API (0.0.1)

Ebsconet integration API

Validate

Responses

Response samples

Content type
application/json
{
  • "status": "Success"
}

Get single Ebsconet product order line

path Parameters
poLineNumber
required
string (order_line_number) ^[a-zA-Z0-9]{1,22}-[0-9]{1,3}$

product order line number

Responses

Response samples

Content type
application/json
{
  • "cancellationRestriction": true,
  • "cancellationRestrictionNote": "string",
  • "currency": "string",
  • "fundCode": "string",
  • "poLineNumber": "string",
  • "publisherName": "string",
  • "internalNote": "string",
  • "quantity": 0,
  • "subscriptionFromDate": "2019-08-24T14:15:22Z",
  • "subscriptionToDate": "2019-08-24T14:15:22Z",
  • "unitPrice": 0,
  • "vendor": "string",
  • "vendorAccountNumber": "string",
  • "vendorReferenceNumbers": [
    ],
  • "workflowStatus": "Pending",
  • "type": "string",
  • "customerNote": "string"
}

Save single Ebsconet product order line

path Parameters
poLineNumber
required
string (order_line_number) ^[a-zA-Z0-9]{1,22}-[0-9]{1,3}$

product order line number

Request Body schema: application/json
required
cancellationRestriction
boolean

Whether or not there are cancellation restrictions for this purchase order line

cancellationRestrictionNote
string

Free-form notes related to cancellation restrictions

currency
required
string

An ISO currency code

fundCode
string

Fund distribution code

poLineNumber
required
string (order_line_number) ^[a-zA-Z0-9]{1,22}-[0-9]{1,3}$

A human readable number, assigned to this product order line

publisherName
string

Publisher of the material

internalNote
string

Renewal note for this purchase order line

quantity
integer

Quantity of physical items or resources of 'Other' order format in this purchase order line

subscriptionFromDate
string or null <date-time>

the start date of the subscription

subscriptionToDate
string or null <date-time>

the end date of the subscription

unitPrice
number

The per-item list price for physical or resources of 'Other' order format

vendorAccountNumber
string

Account number on the vendor's end associated with this purchase order line

Array of objects (reference_number_item)

Reference number items array

Array
refNumber
string

a reference number for this purchase order line

refNumberType
string
Enum: "Vendor continuation reference number" "Vendor order reference number" "Vendor subscription reference number" "Vendor internal number" "Vendor title number"

the reference number type

workflowStatus
string (workflow_status)
Default: "Pending"
Enum: "Pending" "Open" "Closed"

Composite workflow status

customerNote
string

customerNote on the ebsconet's end can be associated with this purchase order line

Responses

Request samples

Content type
application/json
{
  • "cancellationRestriction": true,
  • "cancellationRestrictionNote": "string",
  • "currency": "string",
  • "fundCode": "string",
  • "poLineNumber": "string",
  • "publisherName": "string",
  • "internalNote": "string",
  • "quantity": 0,
  • "subscriptionFromDate": "2019-08-24T14:15:22Z",
  • "subscriptionToDate": "2019-08-24T14:15:22Z",
  • "unitPrice": 0,
  • "vendorAccountNumber": "string",
  • "vendorReferenceNumbers": [
    ],
  • "workflowStatus": "Pending",
  • "customerNote": "string"
}

Response samples

Content type
application/json
{
  • "value": {
    }
}