Retrieve Intermediaries

This API is responsible for retrieving all intermediaries that are connected to a unique itemId.

[GET]/api/v1/{itemId}/intermediary

Response: List of Intermediaries.

Header

Header used on this API are those taken from header standards of TS Digital.

Content-type is accepted in application/json

Query Parameters

Parameters used to make a successful request.

• itemId: Unique personal identification of the item associated with the Intermediary requested. Mandatory for personal or technical users. (required)

Body

No body is needed to make this request.

Response

On successful response

If successful, the API responds with HTTP code 200(OK) with the following body:

{
  "id": "string",
  "taxId": "string",
  "vatNumber": "string",
  "description": "string",
  "type": "string",
  "itemUuid": "string",
  "deleted": true,
  "deletedAt": "2022-05-05T12:46:42.013Z",
  "deletedBy": "string",
  "createdAt": "2022-05-05T12:46:42.013Z",
  "createdBy": "string",
  "updatedAt": "2022-05-05T12:46:42.013Z",
  "updatedBy": "string"
}

• id: Unique identifier.
• taxId: Fiscal code associated with the Intermediary requested.
• vatNumber: Number of IVA registration associated with the Intermediary requested (11 characters).
• description: Description of the Intermediary requested.
• type:
• deleted: Boolean value , describes if Intermediary requested is deleted or not. 
• deletedAt: Date of Intermediary if it's deleted.
• deletedBy: Item which deleted requested Intermediary.
• createdAt: Date of Intermediary creation.
• createdBy: Item which created requested Intermediary.
• updatedAt: Date of the last update for the requested Intermediary.
• updatedBy: Item which updated requested Intermediary.

On error response

In the event of an error, the API responds with a body JSON with the following format:

{
  "code": "string",
  "timestamp": "2022-05-05T12:46:42.016Z",
  "message": "string",
  "subErrors": [
    {}
  ]
}

• code: A string representation of the HTTP error code, linked with the returned http error
• timestamp: Date and time of the answer, expressed as a string.
• message: Message expressing error.

Possible errors are:

• 400: The request is malformed (parameters with incorrect format, invalid or inconsistent parameters).
• 401: An authorization token has not been provided or the authorization token provided is invalid (eg: it has expired).
• 403: The provided token is valid, but the user is not authorized to perform the operation.
• 500: An unexpected error occurred.