Catalog of Requisition API calls

Catalog of Requisition API calls

OpenLMIS v2 endpoints:

Requisition table:

 

Endpoint

Parameters

Return

Method

Endpoint

Parameters

Return

Method

/requisitions

@RequestParam("facilityId") Long facilityId,                                                 @RequestParam("programId") Long programId,                                                 @RequestParam("emergency") Boolean emergency,                                             HttpServletRequest request

ResponseEntity<OpenLmisResponse>

POST

/requisitions

RequisitionSearchCriteria criteria,

HttpServletRequest request

ResponseEntity<OpenLmisResponse>

GET

/requisitions/{id}

@PathVariable Long id,

HttpServletRequest request

ResponseEntity<OpenLmisResponse>

GET

/requisitions/{id}/skipped

@PathVariable Long id,

HttpServletRequest request

ResponseEntity<OpenLmisResponse>

GET

/requisitions/{id}/save

@PathVariable("id") Long id,

@RequestBody Rnr rnr,                                                  HttpServletRequest request

ResponseEntity<OpenLmisResponse>

PUT

/requisitions/{id}/submit

@PathVariable("id") Long id,

HttpServletRequest request

ResponseEntity<OpenLmisResponse>

PUT

/requisitions/{id}/authorize

@PathVariable Long id,

HttpServletRequest request

ResponseEntity<OpenLmisResponse>

PUT

/requisitions/{id}/approve

@PathVariable Long id,

HttpServletRequest request

ResponseEntity<OpenLmisResponse>

PUT

/requisitions/lossAndAdjustments/reference-data

-

ResponseEntity<OpenLmisResponse>

GET

/requisitions-for-approval

HttpServletRequest request

ResponseEntity<OpenLmisResponse>

GET

/requisitions-for-convert-to-order

@RequestParam(value = "searchType", required = false) String searchType,

@RequestParam(value  = "searchVal", required = false) String searchVal,                  

@RequestParam(value = "page", required = true)

Integer page,                                                        @RequestParam(value = "sortBy", required = false)

String sortBy,                                                           @RequestParam(value = "sortDirection", required = false)

String sortDirection,                                          HttpServletRequest request

ResponseEntity<OpenLmisResponse>

GET

/logistics/periods

RequisitionSearchCriteria criteria,

HttpServletRequest request

ResponseEntity<OpenLmisResponse>

GET

/requisitions/{id}/print

@PathVariable Long id

ModelAndView

GET

/requisitions/{id}/comments

@PathVariable("id") Long id,           

@RequestBody Comment comment,                HttpServletRequest request

ResponseEntity<OpenLmisResponse>

POST

/requisitions/{id}/comments

@PathVariable("id") Long id

ResponseEntity<OpenLmisResponse>

GET

/requisitions/delete/{id}

@PathVariable("id") Long rnrId

ResponseEntity<OpenLmisResponse>

POST

/requisitions/skip/{id}

@PathVariable("id") Long rnrId,

HttpServletRequest request

ResponseEntity<OpenLmisResponse>

POST

/requisitions/reject/{id}

@PathVariable("id") Long rnrId,

HttpServletRequest request

ResponseEntity<OpenLmisResponse>

POST

/requisitions/reopen/{id}

@PathVariable("id") Long rnrId,

HttpServletRequest request

ResponseEntity<OpenLmisResponse>

POST

 

 

RNRTemplate Table:

 

Endpoint

Parameters

Return

Method

Endpoint

Parameters

Return

Method

/program/{programId}/rnr-template

@PathVariable("programId") Long programId                                                           

RnrTemplateForm

GET

/rnr/{programId}/columns

@PathVariable("programId") Long programId

List<RnrColumn>

GET

/program/{programId}/rnr-template

@PathVariable("programId") Long programId,

@RequestBody RnrColumnList rnrColumnList,

HttpServletRequest request

ResponseEntity<OpenLmisResponse>

POST

 

 

OpenLmis v3 Requisition endpoints

Requistion endpoints:

 

Endpoint

Parameters

Return

Method

Endpoint

Parameters

Return

Method

/requisitions

@RequestBody Requisition requisition

ResponseEntity<?>

POST

/requisitions

-

ResponseEntity<?>

GET

/requisitions/initiate

@RequestBody Requisition requisitionDto

ResponseEntity<?>

POST

/requisitions/{id}/submit

@PathVariable("id") UUID requisitionId

@RequestBody Requisition requisition,                                BindingResult bindingResult,

ResponseEntity<?>

PUT

/requisitions/{id}

@PathVariable("id") UUID requisitionId

ResponseEntity<?>

DELETE

/requisitions/{id}

@PathVariable("id") UUID requisitionId

ResponseEntity<?>

GET

/requisitions/{id}

@PathVariable("id") UUID requisitionId

@RequestBody Requisition requisition,

ResponseEntity<?>

PUT

/requisitions/search

RequestParam(value = "facility", required = false)

Facility facility,

@RequestParam(value = "program",  required = false)

Program program,

@RequestParam(value = "createdDateFrom",  required = false)

LocalDateTime createdDateFrom,

@RequestParam(value = "createdDateTo",  required = false)

LocalDateTime createdDateTo,

@RequestParam(value = "processingPeriod",  required = false)  

Period processingPeriod,

@RequestParam(value = "supervisoryNode",  required = false)

SupervisoryNode supervisoryNode,

@RequestParam(value = "requisitionStatus",  required = false)

RequisitionStatus requisitionStatus

ResponseEntity<?>

GET

/requisitions/{id}/skip

@PathVariable("id") UUID requisitionId

ResponseEntity<?>

PUT

/requisitions/{id}/reject

@PathVariable("id") UUID id

ResponseEntity<?>

PUT

/requisitions/{id}/comments

@PathVariable("id") UUID id,

@RequestBody Comment comment,

OAuth2Authentication auth

ResponseEntity<Object>

POST

/requisitions/{id}/comments

@PathVariable("id") UUID id

ResponseEntity<Object>

GET

/requisitions/{id}/approve

@PathVariable("id") UUID requisitionId

ResponseEntity<?>

PUT

/requisitions/requisitions-for-approval

OAuth2Authentication auth

ResponseEntity<Object>

GET

/requisitions/submitted

-

ResponseEntity<?>

GET

/requisitions/{id}/authorize

@PathVariable("id") UUID requisitionId

@RequestBody Requisition requisitionDto,

BindingResult bindingResult,

ResponseEntity<?>

PUT

 

Requistion line endpoints:

 

Endpoint

Parameters

Return

Method

Endpoint

Parameters

Return

Method

/requisitionLines

@RequestBody RequisitionLines requisitionLines

ResponseEntity<?>

POST

/requisitionLines

-

ResponseEntity<?>

GET

/requisitionLines/{id}

@PathVariable("id") UUID requisitionLineId

ResponseEntity<?>

DELETE

/requisitionLines/{id}

@PathVariable("id") UUID requisitionLineId

ResponseEntity<?>

GET

/requisitionLines/{id}

@PathVariable("id") UUID requisitionLineId

@RequestBody Requisition requisition,

ResponseEntity<?>

PUT

/requisitionLines/search

@RequestParam(value = "requisition", required = true) Requisition requisition,

@RequestParam(value = "product", required = true) Product product

ResponseEntity<?>

GET

 

Requistion template endpoints:

 

Endpoint

Parameters

Return

Method

Endpoint

Parameters

Return

Method

/requisitionTemplates

@RequestBody RequisitionTemplates requisitionLines

ResponseEntity<?>

POST

/requisitionTemplates

-

ResponseEntity<?>

GET

/requisitionTemplates/{id}

@PathVariable("id") UUID requisitionTemplateId

ResponseEntity<?>

DELETE

/requisitionTemplates/{id}

@PathVariable("id") UUID requisitionTemplateId

Comments

OpenLMIS: the global initiative for powerful LMIS software