Skip to main content

Retrieve Delegates

Retrieves the delegates linked with an intermediary based on itemId , intermediaryTaxId, delegatedTaxId.

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

[GET]/api/v1/{itemId}/intermediary/{intermediaryTaxId}/delegated/{delegatedTaxId}

delegatedTaxId parameter is optional.

Response: List of delegates.

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 an Intermediary. Mandatory for personal or technical users. (required) intermediaryTaxId: Unique fiscal code associated with with an intermediary . (required) delegatedTaxId: Unique fiscal code associated with with an delegated. (optional)

    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",
    "firstName": "string",
    "lastName": "string",
    "description": "string",
    "deleted": true,
    "deletedAt": "2022-05-06T12:21:24.675Z",
    "deletedBy": "string",
    "intermediaryId": "string",
    "createdAt": "2022-05-06T12:21:24.675Z",
    "createdBy": "string",
    "updatedAt": "2022-05-06T12:21:24.675Z",
    "updatedBy": "string"
  }
 ]
      id: Unique identifier. taxId: Fiscal code associated with the Intermediary requested. firstName: First name of the item associated with requested delegated. lastName: First name of the item associated with requested delegated. description: Description of the Intermediary requested. deleted: Boolean value , describes if Delegated requested is deleted or not.  deletedAt: Date of Delegated, if it's deleted. deletedBy: Item which deleted requested Delegated. createdAt: Date of Delegated creation. createdBy: Item which created requested Delegated. updatedAt: Date of the last update for the requested Delegated. updatedBy: Item which updated requested Delegated.
      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.

           

          Back to top