Extension / Attribute / List Item

(API Version v3)

This entity represents the list of items for a Custom Field defined as a pick list.

What can you do with ExtensionAttributeListItem?

GET api/v3/Extension/Attribute/ListItem/
Retrieve all of the ExtensionAttributeListItem objects.
GET api/v3/Extension/Attribute/ListItem/Paged
Retrieve all of the ExtensionAttributeListItem objects in a paged fashion.
GET api/v3/Extension/Attribute/ListItem/{id}
Retrieve an instance of the ExtensionAttributeListItem object by its ID.

Properties

Property Details

identity READ-ONLY	"identity": 25 Type: Number This is the unique numeric identifier for the ExtensionAttributeListItem
extensionAttributeId	"extensionAttributeId": 7 Type: Number Unique identifier for the associated ExtensionAttribute object.
extensionAttributeName	"extensionAttributeName": "Sample Name" Type: String The name of the object associated with the extensionAttributeId property.
value	"value": "My List Item 1" Type: String The user defined text to be displayed in the list.
sortOrder	"sortOrder": 22 Type: Number Unused

Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

extensionAttributeId
value
sortOrder

End Points

Retrieve all of the ExtensionAttributeListItem objects.

GET api/v3/Extension/Attribute/ListItem/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "extensionAttributeId": 26,
            "extensionAttributeName": "Sample Text Data",
            "value": "My List Item 1",
            "sortOrder": 26
        }
    ]
}

GET	api/v3/Extension/Attribute/ListItem/Paged
Retrieve all of the ExtensionAttributeListItem objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the ExtensionAttributeListItem objects in a paged fashion. GET api/v3/Extension/Attribute/ListItem/Paged View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "pagination": { "pageNumber": 1, "pageSize": 20, "excludeTotalCount": false }, "pagedResults": { "totalCount": 1, "items": [ { "identity": 1, "extensionAttributeId": 18, "extensionAttributeName": "Sample Text Data", "value": "My List Item 1", "sortOrder": 15 } ] } }

GET	api/v3/Extension/Attribute/ListItem/{id}
Retrieve an instance of the ExtensionAttributeListItem object by its ID.
{id}	Unique identifier for the ExtensionAttributeListItem object.
Retrieve an instance of the ExtensionAttributeListItem object by its ID. GET api/v3/Extension/Attribute/ListItem/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "extensionAttributeId": 7, "extensionAttributeName": "Sample Text Data", "value": "My List Item 1", "sortOrder": 0 } }