Skip to main content

Retrieve Security Environments

This API is responsible for retrieving all Security environments that are connected to a unique itemId and taxId.

[GET]/api/v1/{itemId}/intermediary/{taxId}/security-environment

Response: List of Security Environments with an active status.

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  Security Environments requested. Mandatory for personal or technical users .(required) taxId: Unique fiscal code of the item associated with  Security Environments requested. (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",
    "siteCode": "string",
    "entratelCode": "string",
    "description": "string",
    "startDate": "2022-05-06T08:48:50.675Z",
    "expirationDate": "2022-05-06T08:48:50.675Z",
    "createdAt": "2022-05-06T08:48:50.675Z",
    "createdBy": "string",
    "updatedAt": "2022-05-06T08:48:50.675Z",
    "updatedBy": "string"
    }
 ]
      id: Unique identifier. siteCode:  entratelCode:  startDate: Start date of the Security Environment. expirationDate: Expiration date of Security Environment. createdAt: Date of Security Environment creation. createdBy: Item which created requested Security Environment. updatedAt: Date of the last update for the requested Security Environment. updatedBy: Item which updated requested Security Environment.
      Back to top