Edge API - Orders (v1)

https://github.com/folio-org/edge-orders

Table of contents

Edge API - Orders

Edge API to interface with FOLIO for 3rd party purchasing systems for placing orders

Validate

GET /orders/validate

Validate that the API Key provided can be used to place an order

GET /orders/validate
Query Parameters
  • type: required (string)

    purchasing system type

  • apikey: required (string)

    API Key

Response 200

Success

Body

Media type: application/xml

Type: any

Example:

<test>GET - OK</test>

Response 400

Bad Request

Body

Media type: application/xml

Type:

<?xml version="1.0" encoding="utf-8"?>
<!-- This document is confidential and proprietary to YBP Library Services. -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  elementFormDefault="qualified" attributeFormDefault="unqualified"
  version="1.0">
  <xs:annotation>
    <xs:documentation>YBP Library Services Response API XSD
    </xs:documentation>
  </xs:annotation>

  <xs:complexType name="ResponseError">
    <xs:annotation>
      <xs:documentation>API Error Response</xs:documentation>
    </xs:annotation>
    <xs:sequence minOccurs="1" maxOccurs="1">
      <xs:element name="Code" type="xs:string" minOccurs="1"
        maxOccurs="1" />
      <xs:element name="Message" type="ResponseErrorMessage"
        minOccurs="1" maxOccurs="1" />
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="PoLineNumber">
    <xs:annotation>
      <xs:documentation>This is the PO Line Number created on the ILS
        system
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="30" />
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="ResponseErrorMessage">
    <xs:annotation>
      <xs:documentation>API Response Error Message</xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="500" />
    </xs:restriction>
  </xs:simpleType>

  <xs:element name="Response">
    <xs:annotation>
      <xs:documentation>This is the returned API response
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:choice>
        <xs:element name="PoLineNumber" type="PoLineNumber">
          <xs:annotation>
            <xs:documentation>This is the created PO-Line number
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Error" type="ResponseError">
          <xs:annotation>
            <xs:documentation>This is a container for the error code and
              error message
            </xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:choice>
    </xs:complexType>
  </xs:element>

</xs:schema>

Response 401

Access Denied

Body

Media type: application/xml

Type:

<?xml version="1.0" encoding="utf-8"?>
<!-- This document is confidential and proprietary to YBP Library Services. -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  elementFormDefault="qualified" attributeFormDefault="unqualified"
  version="1.0">
  <xs:annotation>
    <xs:documentation>YBP Library Services Response API XSD
    </xs:documentation>
  </xs:annotation>

  <xs:complexType name="ResponseError">
    <xs:annotation>
      <xs:documentation>API Error Response</xs:documentation>
    </xs:annotation>
    <xs:sequence minOccurs="1" maxOccurs="1">
      <xs:element name="Code" type="xs:string" minOccurs="1"
        maxOccurs="1" />
      <xs:element name="Message" type="ResponseErrorMessage"
        minOccurs="1" maxOccurs="1" />
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="PoLineNumber">
    <xs:annotation>
      <xs:documentation>This is the PO Line Number created on the ILS
        system
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="30" />
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="ResponseErrorMessage">
    <xs:annotation>
      <xs:documentation>API Response Error Message</xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="500" />
    </xs:restriction>
  </xs:simpleType>

  <xs:element name="Response">
    <xs:annotation>
      <xs:documentation>This is the returned API response
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:choice>
        <xs:element name="PoLineNumber" type="PoLineNumber">
          <xs:annotation>
            <xs:documentation>This is the created PO-Line number
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Error" type="ResponseError">
          <xs:annotation>
            <xs:documentation>This is a container for the error code and
              error message
            </xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:choice>
    </xs:complexType>
  </xs:element>

</xs:schema>

Response 408

Request Timeout

Body

Media type: application/xml

Type:

<?xml version="1.0" encoding="utf-8"?>
<!-- This document is confidential and proprietary to YBP Library Services. -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  elementFormDefault="qualified" attributeFormDefault="unqualified"
  version="1.0">
  <xs:annotation>
    <xs:documentation>YBP Library Services Response API XSD
    </xs:documentation>
  </xs:annotation>

  <xs:complexType name="ResponseError">
    <xs:annotation>
      <xs:documentation>API Error Response</xs:documentation>
    </xs:annotation>
    <xs:sequence minOccurs="1" maxOccurs="1">
      <xs:element name="Code" type="xs:string" minOccurs="1"
        maxOccurs="1" />
      <xs:element name="Message" type="ResponseErrorMessage"
        minOccurs="1" maxOccurs="1" />
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="PoLineNumber">
    <xs:annotation>
      <xs:documentation>This is the PO Line Number created on the ILS
        system
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="30" />
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="ResponseErrorMessage">
    <xs:annotation>
      <xs:documentation>API Response Error Message</xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="500" />
    </xs:restriction>
  </xs:simpleType>

  <xs:element name="Response">
    <xs:annotation>
      <xs:documentation>This is the returned API response
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:choice>
        <xs:element name="PoLineNumber" type="PoLineNumber">
          <xs:annotation>
            <xs:documentation>This is the created PO-Line number
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Error" type="ResponseError">
          <xs:annotation>
            <xs:documentation>This is a container for the error code and
              error message
            </xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:choice>
    </xs:complexType>
  </xs:element>

</xs:schema>

Response 500

Internal Server Error

Body

Media type: application/xml

Type:

<?xml version="1.0" encoding="utf-8"?>
<!-- This document is confidential and proprietary to YBP Library Services. -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  elementFormDefault="qualified" attributeFormDefault="unqualified"
  version="1.0">
  <xs:annotation>
    <xs:documentation>YBP Library Services Response API XSD
    </xs:documentation>
  </xs:annotation>

  <xs:complexType name="ResponseError">
    <xs:annotation>
      <xs:documentation>API Error Response</xs:documentation>
    </xs:annotation>
    <xs:sequence minOccurs="1" maxOccurs="1">
      <xs:element name="Code" type="xs:string" minOccurs="1"
        maxOccurs="1" />
      <xs:element name="Message" type="ResponseErrorMessage"
        minOccurs="1" maxOccurs="1" />
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="PoLineNumber">
    <xs:annotation>
      <xs:documentation>This is the PO Line Number created on the ILS
        system
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="30" />
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="ResponseErrorMessage">
    <xs:annotation>
      <xs:documentation>API Response Error Message</xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="500" />
    </xs:restriction>
  </xs:simpleType>

  <xs:element name="Response">
    <xs:annotation>
      <xs:documentation>This is the returned API response
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:choice>
        <xs:element name="PoLineNumber" type="PoLineNumber">
          <xs:annotation>
            <xs:documentation>This is the created PO-Line number
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Error" type="ResponseError">
          <xs:annotation>
            <xs:documentation>This is a container for the error code and
              error message
            </xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:choice>
    </xs:complexType>
  </xs:element>

</xs:schema>

POST /orders/validate

Validate that the API Key provided can be used to place an order

POST /orders/validate
Query Parameters
  • type: required (string)

    purchasing system type

  • apikey: required (string)

    API Key

Response 200

Success

Body

Media type: application/xml

Type: any

Example:

<test>POST - OK</test>

Response 400

Bad Request

Body

Media type: application/xml

Type:

<?xml version="1.0" encoding="utf-8"?>
<!-- This document is confidential and proprietary to YBP Library Services. -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  elementFormDefault="qualified" attributeFormDefault="unqualified"
  version="1.0">
  <xs:annotation>
    <xs:documentation>YBP Library Services Response API XSD
    </xs:documentation>
  </xs:annotation>

  <xs:complexType name="ResponseError">
    <xs:annotation>
      <xs:documentation>API Error Response</xs:documentation>
    </xs:annotation>
    <xs:sequence minOccurs="1" maxOccurs="1">
      <xs:element name="Code" type="xs:string" minOccurs="1"
        maxOccurs="1" />
      <xs:element name="Message" type="ResponseErrorMessage"
        minOccurs="1" maxOccurs="1" />
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="PoLineNumber">
    <xs:annotation>
      <xs:documentation>This is the PO Line Number created on the ILS
        system
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="30" />
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="ResponseErrorMessage">
    <xs:annotation>
      <xs:documentation>API Response Error Message</xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="500" />
    </xs:restriction>
  </xs:simpleType>

  <xs:element name="Response">
    <xs:annotation>
      <xs:documentation>This is the returned API response
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:choice>
        <xs:element name="PoLineNumber" type="PoLineNumber">
          <xs:annotation>
            <xs:documentation>This is the created PO-Line number
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Error" type="ResponseError">
          <xs:annotation>
            <xs:documentation>This is a container for the error code and
              error message
            </xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:choice>
    </xs:complexType>
  </xs:element>

</xs:schema>

Response 401

Access Denied

Body

Media type: application/xml

Type:

<?xml version="1.0" encoding="utf-8"?>
<!-- This document is confidential and proprietary to YBP Library Services. -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  elementFormDefault="qualified" attributeFormDefault="unqualified"
  version="1.0">
  <xs:annotation>
    <xs:documentation>YBP Library Services Response API XSD
    </xs:documentation>
  </xs:annotation>

  <xs:complexType name="ResponseError">
    <xs:annotation>
      <xs:documentation>API Error Response</xs:documentation>
    </xs:annotation>
    <xs:sequence minOccurs="1" maxOccurs="1">
      <xs:element name="Code" type="xs:string" minOccurs="1"
        maxOccurs="1" />
      <xs:element name="Message" type="ResponseErrorMessage"
        minOccurs="1" maxOccurs="1" />
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="PoLineNumber">
    <xs:annotation>
      <xs:documentation>This is the PO Line Number created on the ILS
        system
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="30" />
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="ResponseErrorMessage">
    <xs:annotation>
      <xs:documentation>API Response Error Message</xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="500" />
    </xs:restriction>
  </xs:simpleType>

  <xs:element name="Response">
    <xs:annotation>
      <xs:documentation>This is the returned API response
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:choice>
        <xs:element name="PoLineNumber" type="PoLineNumber">
          <xs:annotation>
            <xs:documentation>This is the created PO-Line number
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Error" type="ResponseError">
          <xs:annotation>
            <xs:documentation>This is a container for the error code and
              error message
            </xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:choice>
    </xs:complexType>
  </xs:element>

</xs:schema>

Response 408

Request Timeout

Body

Media type: application/xml

Type:

<?xml version="1.0" encoding="utf-8"?>
<!-- This document is confidential and proprietary to YBP Library Services. -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  elementFormDefault="qualified" attributeFormDefault="unqualified"
  version="1.0">
  <xs:annotation>
    <xs:documentation>YBP Library Services Response API XSD
    </xs:documentation>
  </xs:annotation>

  <xs:complexType name="ResponseError">
    <xs:annotation>
      <xs:documentation>API Error Response</xs:documentation>
    </xs:annotation>
    <xs:sequence minOccurs="1" maxOccurs="1">
      <xs:element name="Code" type="xs:string" minOccurs="1"
        maxOccurs="1" />
      <xs:element name="Message" type="ResponseErrorMessage"
        minOccurs="1" maxOccurs="1" />
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="PoLineNumber">
    <xs:annotation>
      <xs:documentation>This is the PO Line Number created on the ILS
        system
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="30" />
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="ResponseErrorMessage">
    <xs:annotation>
      <xs:documentation>API Response Error Message</xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="500" />
    </xs:restriction>
  </xs:simpleType>

  <xs:element name="Response">
    <xs:annotation>
      <xs:documentation>This is the returned API response
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:choice>
        <xs:element name="PoLineNumber" type="PoLineNumber">
          <xs:annotation>
            <xs:documentation>This is the created PO-Line number
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Error" type="ResponseError">
          <xs:annotation>
            <xs:documentation>This is a container for the error code and
              error message
            </xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:choice>
    </xs:complexType>
  </xs:element>

</xs:schema>

Response 500

Internal Server Error

Body

Media type: application/xml

Type:

<?xml version="1.0" encoding="utf-8"?>
<!-- This document is confidential and proprietary to YBP Library Services. -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  elementFormDefault="qualified" attributeFormDefault="unqualified"
  version="1.0">
  <xs:annotation>
    <xs:documentation>YBP Library Services Response API XSD
    </xs:documentation>
  </xs:annotation>

  <xs:complexType name="ResponseError">
    <xs:annotation>
      <xs:documentation>API Error Response</xs:documentation>
    </xs:annotation>
    <xs:sequence minOccurs="1" maxOccurs="1">
      <xs:element name="Code" type="xs:string" minOccurs="1"
        maxOccurs="1" />
      <xs:element name="Message" type="ResponseErrorMessage"
        minOccurs="1" maxOccurs="1" />
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="PoLineNumber">
    <xs:annotation>
      <xs:documentation>This is the PO Line Number created on the ILS
        system
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="30" />
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="ResponseErrorMessage">
    <xs:annotation>
      <xs:documentation>API Response Error Message</xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="500" />
    </xs:restriction>
  </xs:simpleType>

  <xs:element name="Response">
    <xs:annotation>
      <xs:documentation>This is the returned API response
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:choice>
        <xs:element name="PoLineNumber" type="PoLineNumber">
          <xs:annotation>
            <xs:documentation>This is the created PO-Line number
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Error" type="ResponseError">
          <xs:annotation>
            <xs:documentation>This is a container for the error code and
              error message
            </xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:choice>
    </xs:complexType>
  </xs:element>

</xs:schema>

Place Order

POST /orders

Place an order

POST /orders
Query Parameters
  • type: required (string)

    purchasing system type

  • apikey: required (string)

    API Key

Response 201

Success

Body

Media type: application/xml

Type:

<?xml version="1.0" encoding="utf-8"?>
<!-- This document is confidential and proprietary to YBP Library Services. -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  elementFormDefault="qualified" attributeFormDefault="unqualified"
  version="1.0">
  <xs:annotation>
    <xs:documentation>YBP Library Services Response API XSD
    </xs:documentation>
  </xs:annotation>

  <xs:complexType name="ResponseError">
    <xs:annotation>
      <xs:documentation>API Error Response</xs:documentation>
    </xs:annotation>
    <xs:sequence minOccurs="1" maxOccurs="1">
      <xs:element name="Code" type="xs:string" minOccurs="1"
        maxOccurs="1" />
      <xs:element name="Message" type="ResponseErrorMessage"
        minOccurs="1" maxOccurs="1" />
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="PoLineNumber">
    <xs:annotation>
      <xs:documentation>This is the PO Line Number created on the ILS
        system
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="30" />
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="ResponseErrorMessage">
    <xs:annotation>
      <xs:documentation>API Response Error Message</xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="500" />
    </xs:restriction>
  </xs:simpleType>

  <xs:element name="Response">
    <xs:annotation>
      <xs:documentation>This is the returned API response
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:choice>
        <xs:element name="PoLineNumber" type="PoLineNumber">
          <xs:annotation>
            <xs:documentation>This is the created PO-Line number
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Error" type="ResponseError">
          <xs:annotation>
            <xs:documentation>This is a container for the error code and
              error message
            </xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:choice>
    </xs:complexType>
  </xs:element>

</xs:schema>

Response 400

Bad Request

Body

Media type: application/xml

Type:

<?xml version="1.0" encoding="utf-8"?>
<!-- This document is confidential and proprietary to YBP Library Services. -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  elementFormDefault="qualified" attributeFormDefault="unqualified"
  version="1.0">
  <xs:annotation>
    <xs:documentation>YBP Library Services Response API XSD
    </xs:documentation>
  </xs:annotation>

  <xs:complexType name="ResponseError">
    <xs:annotation>
      <xs:documentation>API Error Response</xs:documentation>
    </xs:annotation>
    <xs:sequence minOccurs="1" maxOccurs="1">
      <xs:element name="Code" type="xs:string" minOccurs="1"
        maxOccurs="1" />
      <xs:element name="Message" type="ResponseErrorMessage"
        minOccurs="1" maxOccurs="1" />
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="PoLineNumber">
    <xs:annotation>
      <xs:documentation>This is the PO Line Number created on the ILS
        system
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="30" />
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="ResponseErrorMessage">
    <xs:annotation>
      <xs:documentation>API Response Error Message</xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="500" />
    </xs:restriction>
  </xs:simpleType>

  <xs:element name="Response">
    <xs:annotation>
      <xs:documentation>This is the returned API response
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:choice>
        <xs:element name="PoLineNumber" type="PoLineNumber">
          <xs:annotation>
            <xs:documentation>This is the created PO-Line number
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Error" type="ResponseError">
          <xs:annotation>
            <xs:documentation>This is a container for the error code and
              error message
            </xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:choice>
    </xs:complexType>
  </xs:element>

</xs:schema>

Response 401

Access Denied

Body

Media type: application/xml

Type:

<?xml version="1.0" encoding="utf-8"?>
<!-- This document is confidential and proprietary to YBP Library Services. -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  elementFormDefault="qualified" attributeFormDefault="unqualified"
  version="1.0">
  <xs:annotation>
    <xs:documentation>YBP Library Services Response API XSD
    </xs:documentation>
  </xs:annotation>

  <xs:complexType name="ResponseError">
    <xs:annotation>
      <xs:documentation>API Error Response</xs:documentation>
    </xs:annotation>
    <xs:sequence minOccurs="1" maxOccurs="1">
      <xs:element name="Code" type="xs:string" minOccurs="1"
        maxOccurs="1" />
      <xs:element name="Message" type="ResponseErrorMessage"
        minOccurs="1" maxOccurs="1" />
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="PoLineNumber">
    <xs:annotation>
      <xs:documentation>This is the PO Line Number created on the ILS
        system
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="30" />
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="ResponseErrorMessage">
    <xs:annotation>
      <xs:documentation>API Response Error Message</xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="500" />
    </xs:restriction>
  </xs:simpleType>

  <xs:element name="Response">
    <xs:annotation>
      <xs:documentation>This is the returned API response
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:choice>
        <xs:element name="PoLineNumber" type="PoLineNumber">
          <xs:annotation>
            <xs:documentation>This is the created PO-Line number
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Error" type="ResponseError">
          <xs:annotation>
            <xs:documentation>This is a container for the error code and
              error message
            </xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:choice>
    </xs:complexType>
  </xs:element>

</xs:schema>

Response 408

Request Timeout

Body

Media type: application/xml

Type:

<?xml version="1.0" encoding="utf-8"?>
<!-- This document is confidential and proprietary to YBP Library Services. -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  elementFormDefault="qualified" attributeFormDefault="unqualified"
  version="1.0">
  <xs:annotation>
    <xs:documentation>YBP Library Services Response API XSD
    </xs:documentation>
  </xs:annotation>

  <xs:complexType name="ResponseError">
    <xs:annotation>
      <xs:documentation>API Error Response</xs:documentation>
    </xs:annotation>
    <xs:sequence minOccurs="1" maxOccurs="1">
      <xs:element name="Code" type="xs:string" minOccurs="1"
        maxOccurs="1" />
      <xs:element name="Message" type="ResponseErrorMessage"
        minOccurs="1" maxOccurs="1" />
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="PoLineNumber">
    <xs:annotation>
      <xs:documentation>This is the PO Line Number created on the ILS
        system
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="30" />
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="ResponseErrorMessage">
    <xs:annotation>
      <xs:documentation>API Response Error Message</xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="500" />
    </xs:restriction>
  </xs:simpleType>

  <xs:element name="Response">
    <xs:annotation>
      <xs:documentation>This is the returned API response
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:choice>
        <xs:element name="PoLineNumber" type="PoLineNumber">
          <xs:annotation>
            <xs:documentation>This is the created PO-Line number
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Error" type="ResponseError">
          <xs:annotation>
            <xs:documentation>This is a container for the error code and
              error message
            </xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:choice>
    </xs:complexType>
  </xs:element>

</xs:schema>

Response 500

Internal Server Error

Body

Media type: application/xml

Type:

<?xml version="1.0" encoding="utf-8"?>
<!-- This document is confidential and proprietary to YBP Library Services. -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  elementFormDefault="qualified" attributeFormDefault="unqualified"
  version="1.0">
  <xs:annotation>
    <xs:documentation>YBP Library Services Response API XSD
    </xs:documentation>
  </xs:annotation>

  <xs:complexType name="ResponseError">
    <xs:annotation>
      <xs:documentation>API Error Response</xs:documentation>
    </xs:annotation>
    <xs:sequence minOccurs="1" maxOccurs="1">
      <xs:element name="Code" type="xs:string" minOccurs="1"
        maxOccurs="1" />
      <xs:element name="Message" type="ResponseErrorMessage"
        minOccurs="1" maxOccurs="1" />
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="PoLineNumber">
    <xs:annotation>
      <xs:documentation>This is the PO Line Number created on the ILS
        system
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="30" />
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="ResponseErrorMessage">
    <xs:annotation>
      <xs:documentation>API Response Error Message</xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:minLength value="0" />
      <xs:maxLength value="500" />
    </xs:restriction>
  </xs:simpleType>

  <xs:element name="Response">
    <xs:annotation>
      <xs:documentation>This is the returned API response
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:choice>
        <xs:element name="PoLineNumber" type="PoLineNumber">
          <xs:annotation>
            <xs:documentation>This is the created PO-Line number
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Error" type="ResponseError">
          <xs:annotation>
            <xs:documentation>This is a container for the error code and
              error message
            </xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:choice>
    </xs:complexType>
  </xs:element>

</xs:schema>

Health Check

GET /admin/health

Health Check

GET /admin/health

Response 200

Success

Body

Media type: text/plain

Type: any