Filter communication codes

This Java function filters communication codes based on a request and returns the response.

application/json

Request Body required

The request parameter in the filterCommunicationCode method is of type FilterCommunicationCodeRequest. It is annotated with @RequestBody, indicating that the data for this parameter will be obtained from the request body of the HTTP POST request. This parameter contains the information needed to filter communication codes

requesterUserUUID string
searchToken string

Responses

• 200
• 400
• 401
• 403
• 500

---

The method is returning a ResponseEntity object containing a GetCommuniationCodeReponse object, which represents the response of filtering communication codes.

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorName string
errorMessage string
errorCode int32
]
warnings object[]
Array [
warningCode string
warningTitle string
warningMessage string
]
statusCode int32
apiRequestId string
communicationCodeDTOs object[]
Array [
code string
description string
name string
note string
]

{
  "errors": [
    {
      "errorName": "string",
      "errorMessage": "string",
      "errorCode": 0
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "statusCode": 0,
  "apiRequestId": "string",
  "communicationCodeDTOs": [
    {
      "code": "string",
      "description": "string",
      "name": "string",
      "note": "string"
    }
  ]
}

Bad Request

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorName string
errorMessage string
errorCode int32
]
warnings object[]
Array [
warningCode string
warningTitle string
warningMessage string
]
statusCode int32
apiRequestId string

{
  "errors": [
    {
      "errorName": "string",
      "errorMessage": "string",
      "errorCode": 0
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "statusCode": 0,
  "apiRequestId": "string"
}

Unauthorized

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorName string
errorMessage string
errorCode int32
]
warnings object[]
Array [
warningCode string
warningTitle string
warningMessage string
]
statusCode int32
apiRequestId string

{
  "errors": [
    {
      "errorName": "string",
      "errorMessage": "string",
      "errorCode": 0
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "statusCode": 0,
  "apiRequestId": "string"
}

Forbidden

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorName string
errorMessage string
errorCode int32
]
warnings object[]
Array [
warningCode string
warningTitle string
warningMessage string
]
statusCode int32
apiRequestId string

{
  "errors": [
    {
      "errorName": "string",
      "errorMessage": "string",
      "errorCode": 0
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "statusCode": 0,
  "apiRequestId": "string"
}

Internal Server Error

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorName string
errorMessage string
errorCode int32
]
warnings object[]
Array [
warningCode string
warningTitle string
warningMessage string
]
statusCode int32
apiRequestId string

{
  "errors": [
    {
      "errorName": "string",
      "errorMessage": "string",
      "errorCode": 0
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "statusCode": 0,
  "apiRequestId": "string"
}

POST /v1/communication-codes/searches

Authorization

name: basicAuthtype: httpin: headerscheme: basic

Request

Base URL

/opcodes

Username

Password

Body required

{
  "requesterUserUUID": "string",
  "searchToken": "string"
}

curl / cURL

curl -L -X POST '/opcodes/v1/communication-codes/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "requesterUserUUID": "string",
  "searchToken": "string"
}'

python / requests

curl -L -X POST '/opcodes/v1/communication-codes/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "requesterUserUUID": "string",
  "searchToken": "string"
}'

go / native

curl -L -X POST '/opcodes/v1/communication-codes/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "requesterUserUUID": "string",
  "searchToken": "string"
}'

nodejs / axios

curl -L -X POST '/opcodes/v1/communication-codes/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "requesterUserUUID": "string",
  "searchToken": "string"
}'

ruby / Net::HTTP

curl -L -X POST '/opcodes/v1/communication-codes/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "requesterUserUUID": "string",
  "searchToken": "string"
}'

csharp / RestSharp

curl -L -X POST '/opcodes/v1/communication-codes/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "requesterUserUUID": "string",
  "searchToken": "string"
}'

php / cURL

curl -L -X POST '/opcodes/v1/communication-codes/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "requesterUserUUID": "string",
  "searchToken": "string"
}'

java / OkHttp

curl -L -X POST '/opcodes/v1/communication-codes/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "requesterUserUUID": "string",
  "searchToken": "string"
}'

powershell / RestMethod

curl -L -X POST '/opcodes/v1/communication-codes/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "requesterUserUUID": "string",
  "searchToken": "string"
}'