POST api/Photos/Delete

Request Information

URI Parameters

None.

Body Parameters

PhotoDeleteRequest
NameDescriptionTypeAdditional information
Credentials

ApiCredentials

None.

Gallery

Gallery

None.

Photo

Photo

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"
  },
  "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-18T12:37:33.7122136+00:00",
    "EndDateTime": "2025-07-18T12:37:33.7122136+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-18T12:37:33.7122136+00:00",
        "CreateDateTime": "2025-07-18T12:37:33.7122136+00:00",
        "Sorts": [
          {
            "Id": 1,
            "PhotoId": 2,
            "SortType": 0,
            "HookupId": "sample string 3",
            "CreateDate": "2025-07-18T12:37:33.7122136+00:00",
            "Status": 0
          },
          {
            "Id": 1,
            "PhotoId": 2,
            "SortType": 0,
            "HookupId": "sample string 3",
            "CreateDate": "2025-07-18T12:37:33.7122136+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-18T12:37:33.7122136+00:00",
        "CreateDateTime": "2025-07-18T12:37:33.7122136+00:00",
        "Sorts": [
          {
            "Id": 1,
            "PhotoId": 2,
            "SortType": 0,
            "HookupId": "sample string 3",
            "CreateDate": "2025-07-18T12:37:33.7122136+00:00",
            "Status": 0
          },
          {
            "Id": 1,
            "PhotoId": 2,
            "SortType": 0,
            "HookupId": "sample string 3",
            "CreateDate": "2025-07-18T12:37:33.7122136+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": [
      {
        "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
      },
      {
        "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
      }
    ],
    "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-18T12:37:33.7122136+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-18T12:37:33.7122136+00:00",
        "FolderId": 1,
        "DocumentType": 0
      }
    ]
  },
  "Photo": {
    "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-18T12:37:33.7122136+00:00",
    "CreateDateTime": "2025-07-18T12:37:33.7122136+00:00",
    "Sorts": [
      {
        "Id": 1,
        "PhotoId": 2,
        "SortType": 0,
        "HookupId": "sample string 3",
        "CreateDate": "2025-07-18T12:37:33.7122136+00:00",
        "Status": 0
      },
      {
        "Id": 1,
        "PhotoId": 2,
        "SortType": 0,
        "HookupId": "sample string 3",
        "CreateDate": "2025-07-18T12:37:33.7122136+00:00",
        "Status": 0
      }
    ],
    "Url": "sample string 10",
    "OriginalUrl": "sample string 11",
    "HookupId": "sample string 12",
    "Status": 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

Photo
NameDescriptionTypeAdditional information
Id

integer

None.

GalleryId

integer

None.

UserId

string

None.

Bucket

string

None.

Folder

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.

Sorts

Collection of Sort

None.

Url

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",
  "FileName": "sample string 6",
  "Height": 7,
  "Width": 8,
  "Orientation": 9,
  "Latitude": 1.1,
  "Longitude": 1.1,
  "TimeTaken": "2025-07-18T12:37:33.7902965+00:00",
  "CreateDateTime": "2025-07-18T12:37:33.7902965+00:00",
  "Sorts": [
    {
      "Id": 1,
      "PhotoId": 2,
      "SortType": 0,
      "HookupId": "sample string 3",
      "CreateDate": "2025-07-18T12:37:33.7902965+00:00",
      "Status": 0
    },
    {
      "Id": 1,
      "PhotoId": 2,
      "SortType": 0,
      "HookupId": "sample string 3",
      "CreateDate": "2025-07-18T12:37:33.7902965+00:00",
      "Status": 0
    }
  ],
  "Url": "sample string 10",
  "OriginalUrl": "sample string 11",
  "HookupId": "sample string 12",
  "Status": 0
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.