beach-day

{ "swagger": "2.0", "info": { "description": "\n\n-----------------\n## Error Codes\n\n **0001** - Unexpected Error\n\n**1000** - Service offline\n\n**1001** - User not found\n\n**1002** - Validation failed\n\n**1003** - Transaction failed\n\n**1004** - Card already exists\n\n**1005** - Already exists\n\n**1006** - Authentication failed\n\n**1007** - Invalid manifest\n\n**1008** - Login error\n\n**1009** - Permissions error\n\n**1010** - Old pin invalid\n\n**9001** - OneProfile error\n\n\n\n-----------------\n## Structure\nThe API needs to be invoked with the token in the Authorization header.\n### RestResponse\nEvery response is contained by an object called RestResponse. \n \n The results property is polymorphic and can be any of the following swagger data types: null, array, object, string, number, integer. The actual data type for results is defined on each API under the responses section \n```json\n{\n \"success\": true,\n \"message\": \"\",\n \"results\": {\n\t...\n},\n \"totalItems\": 1,\n \"responseCode\": \"0000\"\n}\n```\n\n\n\n\n#### PAGINATION\n\n\n\nCalling certain methods in this API can result in a huge result set being returned. We implemented pagination in this method for this reason. The method will by default return a maximum of 10 records. If you require more records to be returned, you can specify the pageSize in the endpoint. The pageSize can be set to a max of 100 (pageSize=100) due to the degradation of service. For example:\n```\n https://dev-ws02.pdws.co.za:8253/pepcollect/0.0.1/lookup/node/getNodesListFor3rdParty?pageSize=2\n```\n\n\nThere is also a parameter that allows you to set the start index of the result set (this parameter must also be set in the URL). So consider the above result set, but specifying that the start index is set to example 1. If start index is not populated it is defaulted to 0. So now that it is set to 1 you will notice that the result set below is starting with the second node from the result set above.\n```\n https://dev-ws02.pdws.co.za:8253/pepcollect/0.0.1/lookup/node/getNodesListFor3rdParty?pageSize=2&startIndex=1\n```\n", "version": "16.0.4", "title": "Parcel Management Module" }, "host": "172.24.184.133:8080", "basePath": "/ParcelManagementModule", "tags": [ { "name": "notifications-controller", "description": "Notifications Controller" }, { "name": "rest-controller", "description": "Rest Controller" }, { "name": "rest-controller-external", "description": "Rest Controller External" } ], "paths": { "/clearAllCache": { "get": { "tags": [ "PAXI" ], "summary": "Clears out all the cache in PMM", "operationId": "clearAllCacheUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/dropToken/deleteDropToken": { "post": { "tags": [ "DropToken" ], "summary": "Delete Drop Token", "description": "Delete an existing `DropToken` record.", "operationId": "deleteDropTokenUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "DropToken to delete", "required": true, "schema": { "$ref": "#/definitions/DropTokenDeleteRequest" } } ], "responses": { "200": { "description": "Drop Token successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/dropToken/generateDropTokens": { "post": { "tags": [ "DropToken" ], "summary": "Generate Drop Tokens", "description": "Generate specified number of `DropToken` objects.", "operationId": "generateDropTokensUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "DropTokens to Generate", "required": true, "schema": { "$ref": "#/definitions/DropTokenGenerationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/StringListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/dropToken/getActiveDropTokens": { "get": { "tags": [ "DropToken" ], "summary": "All Active Drop Tokens", "description": "Gets all active `DropToken` objects.", "operationId": "getActiveDropTokensUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DropTokenListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/dropToken/getAllDropTokens": { "get": { "tags": [ "DropToken" ], "summary": "All Drop Tokens", "description": "Gets all `DropToken` objects.", "operationId": "getAllDropTokensUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DropTokenListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/dropToken/getDropToken": { "post": { "tags": [ "DropToken" ], "summary": "Drop Token", "description": "Gets the `DropToken` object for a specific DropToken.", "operationId": "getDropTokenUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "DropToken to search for", "required": true, "schema": { "$ref": "#/definitions/DropTokenRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DropTokenResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/dropToken/getDropTokenByCriteria": { "post": { "tags": [ "DropToken" ], "summary": "Drop Token", "description": "Gets all `DropToken` object for a specific criteria.", "operationId": "getDropTokenByCriteriaUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "DropToken to search for", "required": true, "schema": { "$ref": "#/definitions/DropTokenRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DropTokenListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/dropToken/insertDropToken": { "post": { "tags": [ "DropToken" ], "summary": "Insert Drop Token", "description": "Insert a new `DropToken` record.", "operationId": "insertDropTokenUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "DropToken to insert", "required": true, "schema": { "$ref": "#/definitions/DropTokenInsertRequest" } } ], "responses": { "200": { "description": "Drop Token successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Drop Token Code must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/dropToken/updateDropToken": { "post": { "tags": [ "DropToken" ], "summary": "Update Drop Token", "description": "Update an existing `DropToken` record.", "operationId": "updateDropTokenUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "DropToken to update", "required": true, "schema": { "$ref": "#/definitions/DropTokenUpdateRequest" } } ], "responses": { "200": { "description": "Drop Token successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Drop Token does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/dropToken/updateDropTokenForPOS": { "post": { "tags": [ "DropToken" ], "summary": "Update Drop Token For POS", "description": "Update an existing `DropToken` record.", "operationId": "updateDropTokenForPOSUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "DropToken to update", "required": true, "schema": { "$ref": "#/definitions/DropTokenUpdateRequest" } } ], "responses": { "200": { "description": "Drop Token successfully updated", "schema": { "$ref": "#/definitions/DropTokenResponse" } }, "400": { "description": "Specified Drop Token does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/dropToken/validateDropToken": { "post": { "tags": [ "DropToken" ], "summary": "Validate Drop Token", "description": "Validate a `DropToken`.", "operationId": "validateDropTokenUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "DropToken to validate", "required": true, "schema": { "$ref": "#/definitions/DropTokenValidationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DropTokenValidationResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/jwt": { "get": { "tags": [ "PAXI" ], "summary": "JWT Test Method", "operationId": "checkJwtUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "X-JWT-Assertion", "in": "header", "description": "X-JWT-Assertion", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/LspServiceType/delete": { "post": { "tags": [ "LspServiceType" ], "summary": "LSP Service Type", "description": "delete an existing `LspServiceType` object.", "operationId": "deleteLspServiceTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LspServiceType to be deleted", "required": true, "schema": { "$ref": "#/definitions/LspServiceTypeDeleteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/LspServiceType/getLspServiceType": { "post": { "tags": [ "LspServiceType" ], "summary": "LSP Service Type", "description": "Gets the `LspServiceType` object for a specific LspServiceType.", "operationId": "getLspServiceTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LspServiceType to search for", "required": true, "schema": { "$ref": "#/definitions/LspServiceTypeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LspServiceTypeResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/LspServiceType/getLspServiceTypes": { "get": { "tags": [ "LspServiceType" ], "summary": "LSP Service Type", "description": "Gets all `LspServiceType`objects.", "operationId": "getLspServiceTypesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LspServiceTypeListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/LspServiceType/insert": { "post": { "tags": [ "LspServiceType" ], "summary": "LSP Service Type", "description": "Create a new `LspServiceType` object.", "operationId": "insertLspServiceTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LspServiceType to insert", "required": true, "schema": { "$ref": "#/definitions/LspServiceTypeInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/LspServiceType/update": { "post": { "tags": [ "LspServiceType" ], "summary": "LSP Service Type", "description": "update an existing `LspServiceType` object.", "operationId": "updateLspServiceTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LspServiceType to update", "required": true, "schema": { "$ref": "#/definitions/LspServiceTypeUpdateRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/OneProfile/addOneProfileUser": { "post": { "tags": [ "OneProfile" ], "summary": "OneProfile", "operationId": "addOneProfileUserUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/OneProfileInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OneProfileResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/ProductTypeLspServiceType/delete": { "post": { "tags": [ "ProductTypeLspServiceType" ], "summary": "Product Type LSP Service Type", "description": "delete an existing `ProductTypeLspServiceType` object.", "operationId": "deleteProductTypeLspServiceTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ProductTypeLspServiceType to be deleted", "required": true, "schema": { "$ref": "#/definitions/ProductTypeLspServiceTypeDeleteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/ProductTypeLspServiceType/getProductTypeLspServiceType": { "get": { "tags": [ "ProductTypeLspServiceType" ], "summary": "Product Type LSP Service Type", "description": "Gets all `ProductTypeLspServiceType`objects.", "operationId": "getProductTypeLspServiceTypeUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductTypeLspServiceTypeListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/ProductTypeLspServiceType/getProductTypeLspServiceTypeByCriteria": { "post": { "tags": [ "ProductTypeLspServiceType" ], "summary": "Product Type LSP Service Type", "description": "Gets all `ProductTypeLspServiceType` objects within the criteria", "operationId": "getProductTypeLspServiceTypeByCriteriaUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ProductTypeLspServiceType to Search by", "required": true, "schema": { "$ref": "#/definitions/ProductTypeLSPServiceTypeSearchRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductTypeLspServiceTypeListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/ProductTypeLspServiceType/insert": { "post": { "tags": [ "ProductTypeLspServiceType" ], "summary": "Product Type LSP Service Type", "description": "Create a new `ProductTypeLspServiceType` object.", "operationId": "insertProductTypeLspServiceTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ProductTypeLspServiceType to insert", "required": true, "schema": { "$ref": "#/definitions/ProductTypeLspServiceTypeInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/ProductTypeLspServiceType/update": { "post": { "tags": [ "ProductTypeLspServiceType" ], "summary": "Product Type LSP Service Type", "description": "update an existing `ProductTypeLspServiceType` object.", "operationId": "updateProductTypeLspServiceTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ProductTypeLspServiceType to update", "required": true, "schema": { "$ref": "#/definitions/ProductTypeLspServiceTypeUpdateRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/bookingRejectReason/delete": { "post": { "tags": [ "BookingRejectReason" ], "summary": "Delete Booking Reject Reason", "description": "Delete an existing `BookingRejectReason` record.", "operationId": "deleteBookingRejectReasonUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "The booking reject reason to delete", "required": true, "schema": { "$ref": "#/definitions/BookingRejectReasonDeleteRequest" } } ], "responses": { "200": { "description": "Booking reject reason successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/bookingRejectReason/getBookingRejectReason": { "post": { "tags": [ "BookingRejectReason" ], "summary": "Booking Reject Reason", "description": "Gets the `BookingRejectReason` object for a specific Booking Reject Reason.", "operationId": "getBookingRejectReasonUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "The booking reject reason to search for", "required": true, "schema": { "$ref": "#/definitions/BookingRejectReasonRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetBookingRejectReasonResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/bookingRejectReason/getBookingRejectReasons": { "get": { "tags": [ "BookingRejectReason" ], "summary": "Get all booking reject reasons", "description": "Gets all `BookingRejectReason` objects.", "operationId": "getAllBookingRejectReasonsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetBookingRejectReasonsResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/bookingRejectReason/insert": { "post": { "tags": [ "BookingRejectReason" ], "summary": "Insert Booking Reject Reason", "description": "Insert a new `BookingRejectReason` record.", "operationId": "insertBookingRejectReasonUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Booking Reject Reason object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/BookingRejectReasonInsertRequest" } } ], "responses": { "200": { "description": "Booking reject reason successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "BookingRejectReasonDesc and userIdNo must be populated" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/bookingRejectReason/update": { "post": { "tags": [ "BookingRejectReason" ], "summary": "Update Booking Reject Reason", "description": "Update an existing `BookingRejectReason` record.", "operationId": "updateBookingRejectReasonUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Booking Reject Reason object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/BookingRejectReasonUpdateRequest" } } ], "responses": { "200": { "description": "Booking Reject Reason successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "BookingRejectReasonIdNo and userIdNo must be populated" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/bookingStatus/delete": { "post": { "tags": [ "BookingStatus" ], "summary": "Delete Booking Status", "description": "Delete an existing `BookingStatus` record.", "operationId": "deleteBookingStatusUsingPOST", "consumes": [ "application/json" ], "produces": [