POST api/Tags/Search

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Credentials	ApiCredentials	None.
Api	string	None.
FolderId	integer	None.
FolderHookupId	string	None.
GalleryId	integer	None.
GalleryHookupId	string	None.
Value	string	None.
Untagged	boolean	None.
TextOnly	boolean	None.
NumericOnly	boolean	None.
ExcludeTypes	Collection of TagType	None.
SortFilter	SortFilter	None.

Request Formats

application/json, text/json

Sample:

{
  "Credentials": {
    "AccountId": 1,
    "UserId": "sample string 2",
    "Pwd": "sample string 3",
    "PublicKey": "sample string 4",
    "ApiKey": "sample string 5"
  },
  "Api": "sample string 1",
  "FolderId": 1,
  "FolderHookupId": "sample string 2",
  "GalleryId": 1,
  "GalleryHookupId": "sample string 3",
  "Value": "sample string 4",
  "Untagged": true,
  "TextOnly": true,
  "NumericOnly": true,
  "ExcludeTypes": [
    0,
    0
  ],
  "SortFilter": {
    "Id": 1,
    "TagTypes": [
      {
        "Id": 1,
        "TagType": 0,
        "SortFilterId": 2
      },
      {
        "Id": 1,
        "TagType": 0,
        "SortFilterId": 2
      }
    ],
    "TextOnly": true,
    "NumericOnly": true,
    "Confidence": 2.1,
    "MinLength": 3,
    "MaxLength": 4,
    "StartsWith": "sample string 5",
    "EndsWith": "sample string 6",
    "Matches": "sample string 7",
    "Exclude": "sample string 8",
    "OrderBy": "sample string 9",
    "OutputFormat": "sample string 10",
    "GalleryId": 11,
    "Gallery": {
      "Id": 1,
      "AccountId": 2,
      "FolderId": 3,
      "FolderName": "sample string 4",
      "Api": "sample string 5",
      "HookupId": "sample string 6",
      "Name": "sample string 7",
      "Status": 0,
      "Snippet": "sample string 8",
      "Location": "sample string 9",
      "Latitude": 1.1,
      "Longitude": 1.1,
      "StartDateTime": "2025-07-18T11:59:07.6392486+00:00",
      "EndDateTime": "2025-07-18T11:59:07.6392486+00:00",
      "AuthToken": "sample string 10",
      "Siblings": [
        {
          "GalleryId": "sample string 1",
          "Name": "sample string 2",
          "Api": "sample string 3",
          "FolderId": "sample string 4"
        },
        {
          "GalleryId": "sample string 1",
          "Name": "sample string 2",
          "Api": "sample string 3",
          "FolderId": "sample string 4"
        }
      ],
      "FacialIndexes": [
        {
          "GalleryId": "sample string 1",
          "Name": "sample string 2",
          "Api": "sample string 3",
          "FolderId": "sample string 4"
        },
        {
          "GalleryId": "sample string 1",
          "Name": "sample string 2",
          "Api": "sample string 3",
          "FolderId": "sample string 4"
        }
      ],
      "Photos": [
        {
          "Id": 1,
          "GalleryId": 2,
          "UserId": "sample string 3",
          "Bucket": "sample string 4",
          "Folder": "sample string 5",
          "FileName": "sample string 6",
          "Height": 7,
          "Width": 8,
          "Orientation": 9,
          "Latitude": 1.1,
          "Longitude": 1.1,
          "TimeTaken": "2025-07-18T11:59:07.6392486+00:00",
          "CreateDateTime": "2025-07-18T11:59:07.6392486+00:00",
          "Sorts": [
            {
              "Id": 1,
              "PhotoId": 2,
              "SortType": 0,
              "HookupId": "sample string 3",
              "CreateDate": "2025-07-18T11:59:07.6392486+00:00",
              "Status": 0
            },
            {
              "Id": 1,
              "PhotoId": 2,
              "SortType": 0,
              "HookupId": "sample string 3",
              "CreateDate": "2025-07-18T11:59:07.6392486+00:00",
              "Status": 0
            }
          ],
          "Url": "sample string 10",
          "OriginalUrl": "sample string 11",
          "HookupId": "sample string 12",
          "Status": 0
        },
        {
          "Id": 1,
          "GalleryId": 2,
          "UserId": "sample string 3",
          "Bucket": "sample string 4",
          "Folder": "sample string 5",
          "FileName": "sample string 6",
          "Height": 7,
          "Width": 8,
          "Orientation": 9,
          "Latitude": 1.1,
          "Longitude": 1.1,
          "TimeTaken": "2025-07-18T11:59:07.6392486+00:00",
          "CreateDateTime": "2025-07-18T11:59:07.6392486+00:00",
          "Sorts": [
            {
              "Id": 1,
              "PhotoId": 2,
              "SortType": 0,
              "HookupId": "sample string 3",
              "CreateDate": "2025-07-18T11:59:07.6392486+00:00",
              "Status": 0
            },
            {
              "Id": 1,
              "PhotoId": 2,
              "SortType": 0,
              "HookupId": "sample string 3",
              "CreateDate": "2025-07-18T11:59:07.6392486+00:00",
              "Status": 0
            }
          ],
          "Url": "sample string 10",
          "OriginalUrl": "sample string 11",
          "HookupId": "sample string 12",
          "Status": 0
        }
      ],
      "Sorts": [
        {
          "HookupId": "sample string 1",
          "SortName": "sample string 2",
          "SortType": 0,
          "SortStatus": 0,
          "Count": 3
        },
        {
          "HookupId": "sample string 1",
          "SortName": "sample string 2",
          "SortType": 0,
          "SortStatus": 0,
          "Count": 3
        }
      ],
      "SortFilters": [],
      "Documents": [
        {
          "Id": 1,
          "GalleryId": 1,
          "UserId": "sample string 2",
          "Bucket": "sample string 3",
          "Folder": "sample string 4",
          "FileName": "sample string 5",
          "Status": "sample string 6",
          "CreateDate": "2025-07-18T11:59:07.6392486+00:00",
          "FolderId": 1,
          "DocumentType": 0
        },
        {
          "Id": 1,
          "GalleryId": 1,
          "UserId": "sample string 2",
          "Bucket": "sample string 3",
          "Folder": "sample string 4",
          "FileName": "sample string 5",
          "Status": "sample string 6",
          "CreateDate": "2025-07-18T11:59:07.6392486+00:00",
          "FolderId": 1,
          "DocumentType": 0
        }
      ]
    }
  }
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of PhotoDTO

Name	Type	Additional information
Id	integer	None.
GalleryId	integer	None.
UserId	string	None.
Bucket	string	None.
Folder	string	None.
GalleryName	string	None.
FileName	string	None.
Height	integer	None.
Width	integer	None.
Orientation	integer	None.
Latitude	decimal number	None.
Longitude	decimal number	None.
TimeTaken	date	None.
CreateDateTime	date	None.
TakenOn	date	None.
Tags	Collection of TagDTO	None.
Sorts	Collection of SortDTO	None.
Url	string	None.
UrlHost	string	None.
UrlCore	string	None.
Sequence	string	None.
UrlToken	string	None.
OriginalUrl	string	None.
HookupId	string	None.
Status	PhotoStatus	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "GalleryId": 2,
    "UserId": "sample string 3",
    "Bucket": "sample string 4",
    "Folder": "sample string 5",
    "GalleryName": "sample string 6",
    "FileName": "sample string 7",
    "Height": 8,
    "Width": 9,
    "Orientation": 10,
    "Latitude": 1.1,
    "Longitude": 1.1,
    "TimeTaken": "2025-07-18T11:59:07.7329464+00:00",
    "CreateDateTime": "2025-07-18T11:59:07.7329464+00:00",
    "TakenOn": "2025-07-18T11:59:07.7329464+00:00",
    "Tags": [
      {
        "Id": 1,
        "PhotoId": 2,
        "Value": "sample string 3",
        "TagType": 0,
        "Source": "sample string 4",
        "Confidence": 5.1
      },
      {
        "Id": 1,
        "PhotoId": 2,
        "Value": "sample string 3",
        "TagType": 0,
        "Source": "sample string 4",
        "Confidence": 5.1
      }
    ],
    "Sorts": [
      {
        "Id": 1,
        "PhotoId": 2,
        "SortType": 0,
        "HookupId": "sample string 3",
        "CreateDate": "2025-07-18T11:59:07.7329464+00:00",
        "Status": 0
      },
      {
        "Id": 1,
        "PhotoId": 2,
        "SortType": 0,
        "HookupId": "sample string 3",
        "CreateDate": "2025-07-18T11:59:07.7329464+00:00",
        "Status": 0
      }
    ],
    "Url": "sample string 11",
    "UrlHost": "sample string 12",
    "UrlCore": "sample string 13",
    "Sequence": "sample string 14",
    "UrlToken": "sample string 15",
    "OriginalUrl": "sample string 16",
    "HookupId": "sample string 17",
    "Status": 0
  },
  {
    "Id": 1,
    "GalleryId": 2,
    "UserId": "sample string 3",
    "Bucket": "sample string 4",
    "Folder": "sample string 5",
    "GalleryName": "sample string 6",
    "FileName": "sample string 7",
    "Height": 8,
    "Width": 9,
    "Orientation": 10,
    "Latitude": 1.1,
    "Longitude": 1.1,
    "TimeTaken": "2025-07-18T11:59:07.7329464+00:00",
    "CreateDateTime": "2025-07-18T11:59:07.7329464+00:00",
    "TakenOn": "2025-07-18T11:59:07.7329464+00:00",
    "Tags": [
      {
        "Id": 1,
        "PhotoId": 2,
        "Value": "sample string 3",
        "TagType": 0,
        "Source": "sample string 4",
        "Confidence": 5.1
      },
      {
        "Id": 1,
        "PhotoId": 2,
        "Value": "sample string 3",
        "TagType": 0,
        "Source": "sample string 4",
        "Confidence": 5.1
      }
    ],
    "Sorts": [
      {
        "Id": 1,
        "PhotoId": 2,
        "SortType": 0,
        "HookupId": "sample string 3",
        "CreateDate": "2025-07-18T11:59:07.7329464+00:00",
        "Status": 0
      },
      {
        "Id": 1,
        "PhotoId": 2,
        "SortType": 0,
        "HookupId": "sample string 3",
        "CreateDate": "2025-07-18T11:59:07.7329464+00:00",
        "Status": 0
      }
    ],
    "Url": "sample string 11",
    "UrlHost": "sample string 12",
    "UrlCore": "sample string 13",
    "Sequence": "sample string 14",
    "UrlToken": "sample string 15",
    "OriginalUrl": "sample string 16",
    "HookupId": "sample string 17",
    "Status": 0
  }
]

application/xml, text/xml

Sample:

<ArrayOfPhotoDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PixelEntities.Photos">
  <PhotoDTO>
    <Bucket>sample string 4</Bucket>
    <CreateDateTime>2025-07-18T11:59:07.7329464+00:00</CreateDateTime>
    <FileName>sample string 7</FileName>
    <Folder>sample string 5</Folder>
    <GalleryId>2</GalleryId>
    <GalleryName>sample string 6</GalleryName>
    <Height>8</Height>
    <HookupId>sample string 17</HookupId>
    <Id>1</Id>
    <Latitude>1.1</Latitude>
    <Longitude>1.1</Longitude>
    <Orientation>10</Orientation>
    <OriginalUrl>sample string 16</OriginalUrl>
    <Sequence>sample string 14</Sequence>
    <Sorts xmlns:d3p1="http://schemas.datacontract.org/2004/07/PixelEntities.Sorts">
      <d3p1:SortDTO>
        <d3p1:CreateDate>2025-07-18T11:59:07.7329464+00:00</d3p1:CreateDate>
        <d3p1:HookupId>sample string 3</d3p1:HookupId>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:PhotoId>2</d3p1:PhotoId>
        <d3p1:SortType>Manual</d3p1:SortType>
        <d3p1:Status>Queued</d3p1:Status>
      </d3p1:SortDTO>
      <d3p1:SortDTO>
        <d3p1:CreateDate>2025-07-18T11:59:07.7329464+00:00</d3p1:CreateDate>
        <d3p1:HookupId>sample string 3</d3p1:HookupId>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:PhotoId>2</d3p1:PhotoId>
        <d3p1:SortType>Manual</d3p1:SortType>
        <d3p1:Status>Queued</d3p1:Status>
      </d3p1:SortDTO>
    </Sorts>
    <Status>Hidden</Status>
    <Tags xmlns:d3p1="http://schemas.datacontract.org/2004/07/PixelEntities.Tags">
      <d3p1:TagDTO>
        <d3p1:Confidence>5.1</d3p1:Confidence>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:PhotoId>2</d3p1:PhotoId>
        <d3p1:Source>sample string 4</d3p1:Source>
        <d3p1:TagType>Text</d3p1:TagType>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:TagDTO>
      <d3p1:TagDTO>
        <d3p1:Confidence>5.1</d3p1:Confidence>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:PhotoId>2</d3p1:PhotoId>
        <d3p1:Source>sample string 4</d3p1:Source>
        <d3p1:TagType>Text</d3p1:TagType>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:TagDTO>
    </Tags>
    <TakenOn>2025-07-18T11:59:07.7329464+00:00</TakenOn>
    <TimeTaken>2025-07-18T11:59:07.7329464+00:00</TimeTaken>
    <Url>sample string 11</Url>
    <UrlCore>sample string 13</UrlCore>
    <UrlHost>sample string 12</UrlHost>
    <UrlToken>sample string 15</UrlToken>
    <UserId>sample string 3</UserId>
    <Width>9</Width>
  </PhotoDTO>
  <PhotoDTO>
    <Bucket>sample string 4</Bucket>
    <CreateDateTime>2025-07-18T11:59:07.7329464+00:00</CreateDateTime>
    <FileName>sample string 7</FileName>
    <Folder>sample string 5</Folder>
    <GalleryId>2</GalleryId>
    <GalleryName>sample string 6</GalleryName>
    <Height>8</Height>
    <HookupId>sample string 17</HookupId>
    <Id>1</Id>
    <Latitude>1.1</Latitude>
    <Longitude>1.1</Longitude>
    <Orientation>10</Orientation>
    <OriginalUrl>sample string 16</OriginalUrl>
    <Sequence>sample string 14</Sequence>
    <Sorts xmlns:d3p1="http://schemas.datacontract.org/2004/07/PixelEntities.Sorts">
      <d3p1:SortDTO>
        <d3p1:CreateDate>2025-07-18T11:59:07.7329464+00:00</d3p1:CreateDate>
        <d3p1:HookupId>sample string 3</d3p1:HookupId>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:PhotoId>2</d3p1:PhotoId>
        <d3p1:SortType>Manual</d3p1:SortType>
        <d3p1:Status>Queued</d3p1:Status>
      </d3p1:SortDTO>
      <d3p1:SortDTO>
        <d3p1:CreateDate>2025-07-18T11:59:07.7329464+00:00</d3p1:CreateDate>
        <d3p1:HookupId>sample string 3</d3p1:HookupId>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:PhotoId>2</d3p1:PhotoId>
        <d3p1:SortType>Manual</d3p1:SortType>
        <d3p1:Status>Queued</d3p1:Status>
      </d3p1:SortDTO>
    </Sorts>
    <Status>Hidden</Status>
    <Tags xmlns:d3p1="http://schemas.datacontract.org/2004/07/PixelEntities.Tags">
      <d3p1:TagDTO>
        <d3p1:Confidence>5.1</d3p1:Confidence>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:PhotoId>2</d3p1:PhotoId>
        <d3p1:Source>sample string 4</d3p1:Source>
        <d3p1:TagType>Text</d3p1:TagType>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:TagDTO>
      <d3p1:TagDTO>
        <d3p1:Confidence>5.1</d3p1:Confidence>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:PhotoId>2</d3p1:PhotoId>
        <d3p1:Source>sample string 4</d3p1:Source>
        <d3p1:TagType>Text</d3p1:TagType>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:TagDTO>
    </Tags>
    <TakenOn>2025-07-18T11:59:07.7329464+00:00</TakenOn>
    <TimeTaken>2025-07-18T11:59:07.7329464+00:00</TimeTaken>
    <Url>sample string 11</Url>
    <UrlCore>sample string 13</UrlCore>
    <UrlHost>sample string 12</UrlHost>
    <UrlToken>sample string 15</UrlToken>
    <UserId>sample string 3</UserId>
    <Width>9</Width>
  </PhotoDTO>
</ArrayOfPhotoDTO>