Skip to main content

Lookup

The "Lookup" endpoint is used to perform a data lookup request for use in an API session. This endpoint requires bearer authentication, which means the client must provide a valid authentication token in the request headers to access this endpoint.

Request​

To use the "Lookup" endpoint, the client needs to make a POST request to Link
The request body should include the following required parameters:

  • trackid: The unique identifier for the API request.
  • additionalProperties: Additional properties or data that may be required for the lookup request.

Response​

When the "Lookup" endpoint is called with valid authentication and request parameters, the MPSMS API will respond with a JSON payload containing the following fields:

  • success: A boolean value indicating whether the request was successful or not.
  • code: An integer value representing the HTTP status code of the response.
  • message: A string message providing additional information about the response.
  • data: An object containing the data returned from the lookup request.
  • trackid: The unique identifier for the current request, which can be used for logging and troubleshooting purposes.
  • stamp: An integer timestamp representing the current time when the response was generated.

By using the "Lookup" endpoint, clients can retrieve additional data or information required for their API service integrations with the MPSMS platform.