Search for a Party

Use the following details to search for a Party using REST interface:

HTTP Method

POST

Endpoint URL

See the REST Service Endpoint topic for more details.

Resource

/partysearch

Request Parameters

Provide values for the following parameters:

Parameter Name Data Type Mandatory
nbInstances No
startIndex No
queryName string No
op string No
parameters No

Request Model

Media Type: application/json 

{
  "pagination": {
    "nbInstances": 0,
    "startIndex": 0
  },
  "queryName": "string",
  "search": {
    "op": "string",
    "parameters": [
      {}
    ]
  }
}

Response Model

{
  "data": {
    "matches": [
      {}
    ],
    "nbResponses": 0,
    "startIndex": 0
  },
  "duration": 0,
  "result": {
    "code": "string",
    "message": "string",
    "params": [
      "string"
    ]
  },
  "startTimestampMS": 0
}

Response Codes and Descriptions

Response Code Description
201 Created
401 Unauthorized
403 Forbidden
404 Not Found