Documentation Center

Get quote requests

Get a list of the quotes requested on your system. You can also filter them by their status or by the client who requested them.

For security reasons, you need to perform a Login action before making any other public calls to the WorldServer API. The sessionId in the response is your session token. Use this token in all the other calls that you make.

Also, make sure that you have the appropriate user type permissions to perform this API call. To view or update your permissions, in WorldServer, go to Management > User Setup > User Types, and then select your user type.

API call

<protocol>://<ws-host>:<ws-port>/ws-api/v2/rfqs?token=<sessionId>

Details

  • GET method
  • Content-Type in the header: application/json
  • Mandatory parameter: the session token (as a query string parameter or as a key-value pair in the header)

Available filters

You can add the filters as query string parameters or as key-value pairs in the header:
FilterDescription
fields=<fieldName1,fieldName2,…,fieldNameN>The names of the fields to be included in the JSON response, separated by commas. Do not use in conjunction with the excludedFields filter.
excludedFields=<fieldName1,fieldName2,…,fieldNameN>The names of the fields to be excluded from the JSON response, separated by commas. Do not use in conjunction with the fields filter.
clientId=<clientId>The ID of the client for which you want to get quotes.
state=<state>The status of the quotes that you want to retrieve; one of REQUESTED, IN_REVIEW, APPROVED, or ABANDONED.
Examples:
  • <protocol>://<ws-host>:<ws-port>/ws-api/v2/rfqs?token=<sessionId>&clientId=7689
  • <protocol>://<ws-host>:<ws-port>/ws-api/v2/rfqs?token=<sessionId>&fields=id,name&state=REQUESTED

Response

A screen shot that shows a typical response to this call.

Error messages

MessageStatus code
Optional filter state is invalid (If the status you entered is not REQUESTED, IN_REVIEW, APPROVED, or ABANDONED.)400 Bad Request
Optional filter clientId is invalid (If the ID you entered is not a valid number.)400 Bad Request
No session token provided or invalid token401 Unauthorized