GET api/tags?name={name}&nameContains={nameContains}&tagTypeId={tagTypeId}&inactive={inactive}&offset={offset}&limit={limit}&returnTotal={returnTotal}

Get all Tags optionally filtered by any of the arguments specified in the query string.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
name

Optional case-insensitive filter on Tags with a name that matches the provided value.

 string

None.
nameContains

Optional case-insensitive filter on Tags with a name containing the provided value.

 string

None.
tagTypeId

Optional filter on Tags with a TagTypeId that matches the provided value.

 integer

None.
inactive

Filter indicating whether to retrieve active or inactive records.

 boolean

Default value is False
offset

The position in the collection of Tags from which to start returning data from.

 integer

Default value is 0
limit

The maximum amount of Tags that can be returned in any one call. Maximum allowed is 250.

 integer

Default value is 50
returnTotal

Whether to include the total amount of Tags in the database that match the filter specified.

 boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

TagDto
NameDescriptionTypeAdditional information
Id

The primary key of the record in the Hobsons database.

 integer

None.
Name

string

Required

String length: inclusive between 0 and 100
TagTypeId

The identifier of the TagType associated with the given record.

 integer

Range: inclusive between 1 and 99999999
TagTypeName

The name of the TagType associated with the given record.

 string

None.
Inactive

boolean

Required

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "Name": "sample string 2",
  "TagTypeId": 1,
  "TagTypeName": "sample string 3",
  "Inactive": true
}