OpenLMIS Requisition API API documentation version 1.0.0

http://localhost:8080/api

Getting Started

Welcome to the OpenLMIS requisition-service documentation. This minimal API is intended for illustrative purposes.

Order

get

get

Get CSV from Order.

Get CSV from Order.

URI Parameters

  • Order id: required (string)

HTTP status code 200

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

Body

Type: application/json

HTTP status code 400

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

get

get

Find Orders with matched SupplyingFacility.

Find Orders with matched SupplyingFacility.

URI Parameters

  • Order id: required (string)

Query Parameters

  • supplyingFacility: required (string)

    SupplyingFacility ID

HTTP status code 200

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

Body

Type: application/json

HTTP status code 500

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

get

get

Find Orders with matched SupplyingFacility and RequestingFacility.

Find Orders with matched SupplyingFacility and RequestingFacility.

URI Parameters

  • Order id: required (string)

Query Parameters

  • supplyingFacility: required (string)

    SupplyingFacility ID

  • requestingFacility: required (string)

    RequestingFacility ID

HTTP status code 200

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

Body

Type: application/json

HTTP status code 500

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

get

get

Find Orders with matched SupplyingFacility and Program.

Find Orders with matched SupplyingFacility and Program.

URI Parameters

  • Order id: required (string)

Query Parameters

  • supplyingFacility: required (string)

    SupplyingFacility ID

  • program: required (string)

    Program ID

HTTP status code 200

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

Body

Type: application/json

HTTP status code 500

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

get

get

Find Orders with matched SupplyingFacility, RequestingFacility and Program.

Find Orders with matched SupplyingFacility, RequestingFacility and Program.

URI Parameters

  • Order id: required (string)

Query Parameters

  • supplyingFacility: required (string)

    SupplyingFacility ID

  • requestingFacility: required (string)

    RequestingFacility ID

  • program: required (string)

    Program ID

HTTP status code 200

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

Body

Type: application/json

HTTP status code 500

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

Period

get

get

Display total days of period.

Display total days of period.

URI Parameters

  • id: required (string)

HTTP status code 200

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

Body

Type: application/json

HTTP status code 400

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

HTTP status code 500

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

get

get

Find Periods with matched ProcessingSchedule.

get

get

Get last Period.

ProductCategories

get

get

Find ProductCategories with matched Code.

Requisition

put

put

Skip chosen requisition period.

Skip chosen requisition period.

URI Parameters

  • id: required (string)

HTTP status code 200

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

Body

Type: application/json

HTTP status code 400

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

put

put

Reject requisition which is waiting for approval.

Reject requisition which is waiting for approval.

URI Parameters

  • id: required (string)

HTTP status code 200

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

Body

Type: application/json

HTTP status code 400

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

put

put

Submit earlier initiated requisition.

Submit earlier initiated requisition.

URI Parameters

  • id: required (string)

Body

Type: application/json

Schema:

requsition

HTTP status code 200

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

Body

Type: application/json

Schema:

{   "type": "object",
    "$schema": "http://json-schema.org/draft-03/schema",
    "title": "Requisition",
    "properties": {
        "id": { "type": "string", "required": true, "title": "id" },
        "createdDate": { "type": "string", "required": false, "title": "createdDate" },
        "facility": { "$ref":"facility", "required": true, "title": "facility" },
        "program": { "$ref":"program", "required": true, "title": "program" },
        "processingPeriod": { "$ref":"period", "required": true, "title": "processingPeriod" },
        "status": { "type": "string", "required": true, "title": "status" },
        "creator": { "$ref":"user", "required": false, "title": "creator" },
        "requisitionLines": { "$ref":"requisitionLine", "type": "array", "required": false, "title": "requisitionLines", "items": { "ref":"requisitionLine" }, "uniqueItems": false }
    }
}

HTTP status code 400

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

get

get

Search requisitions created by logged user.

Search requisitions created by logged user.

URI Parameters

  • creatorId: required (string)

HTTP status code 200

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

Body

Type: application/json

HTTP status code 400

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

HTTP status code 500

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

get

Schedule

get

get

Display total days and months of schedule periods.

Display total days and months of schedule periods.

URI Parameters

  • id: required (string)

    ScheduleId

HTTP status code 200

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

Body

Type: application/json

HTTP status code 404

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

User

get

get

Search Users with matched FirstName

get

get

Search Users with matched LastName.

get

get

Search Users with matched Verified.

get

get

Search Users with matched Active.

get

get

Search Users with matched HomeFacility.

get

get

Search Users with matched Username.

get

get

Search Users with matched FirstName and LastName.

SupplyLines

post

post

Save a supplyLine

Save a supplyLine

Body

Type: application/json

Schema:

{   "type": "object",
    "$schema": "http://json-schema.org/draft-03/schema",
    "title": "SupplyLine",
    "properties": {
        "id": { "type": "string", "required": true, "title": "id" },
        "supervisoryNode": { "$ref": "supervisoryNode", "required": true },
        "description": { "type": "string", "required": false, "title": "description" },
        "program": { "$ref": "program", "required": true },
        "supplyingFacility": { "$ref": "facility", "required": true }
    }
}

HTTP status code 200

SupplyLine sucessfully saved.

Headers

  • X-Content-Type-Options: (string)
  • X-XSS-Protection: (string)

Body

Type: application/json

Schema:

{   "type": "object",
    "$schema": "http://json-schema.org/draft-03/schema",
    "title": "SupplyLine",
    "properties": {
        "id": { "type": "string", "required": true, "title": "id" },
        "supervisoryNode": { "$ref": "supervisoryNode", "required": true },
        "description": { "type": "string", "required": false, "title": "description" },
        "program": { "$ref": "program", "required": true },
        "supplyingFacility": { "$ref": "facility", "required": true }
    }
}