GET projects/{status}/name/{name}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
status

string

None.

name

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Project
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Name

string

None.

CreatedDate

date

None.

ModifiedDate

date

None.

Status

integer

None.

Product

Product

None.

Background

Background

None.

Stamps

Collection of Stamp

None.

Assets

Collection of ProjectAsset

None.

ARAsset

ARAsset

None.

BackgroundId

globally unique identifier

None.

BackgroundColor

string

None.

LayoutMaskId

globally unique identifier

None.

ProductId

globally unique identifier

None.

UserID

globally unique identifier

None.

GuestUserId

globally unique identifier

None.

PreviewImageDetails

string

None.

FormTemplate

string

None.

s7ImageVersion

string

None.

FinalVingetteImageLocation

string

None.

FinalFlatImageLocation

string

None.

FinalFlatImageBlobLocation

string

None.

PreviewFlatImageLocation

string

None.

FinalFlatFilename

string

None.

IsDefaultProjectName

boolean

None.

ProjectImageSource

string

None.

FinalImageSource

integer

None.

ArtboardFlatImage

Collection of byte

None.

ArtboardFlatImageLocation

string

None.

SiteCode

string

None.

SiteCodeID

integer

None.

ShowS7NoBackgroundExistsWarning

boolean

None.

EditRequestDateUTC

date

None.

IsCSREditing

boolean

None.

FinalFlatImage

Collection of byte

None.

FinalFlatImageNoMask

Collection of byte

None.

isThemeProject

boolean

None.

SourceProjectId

globally unique identifier

None.

LicenseId

globally unique identifier

None.

ThemeProjectId

globally unique identifier

None.

PDPFG

string

None.

PurchaseFG

string

None.

IsSourceThemeProject

boolean

None.

SMSOptIn

boolean

None.

TemplateBackgroundId

globally unique identifier

None.

TemplateBackgroundColor

string

None.

S7DecorationPositionHorizontal

integer

None.

ApplyBGColorToBottomOnly

boolean

None.

IsLocked

boolean

None.

IsCopyThemeUnlockedProject

boolean

None.

ExpiryDate

date

None.

IsOrderProjectExpired

boolean

None.

Response Formats

application/json, text/json, text/html

Sample:
[
  {
    "Id": "facc499d-d69d-4ede-aee8-d437a9b2a460",
    "Name": "sample string 2",
    "CreatedDate": "2025-08-30T18:04:55.1085513+00:00",
    "ModifiedDate": "2025-08-30T18:04:55.1085513+00:00",
    "Status": 5,
    "Product": {
      "Id": "accc1f9b-bb65-4871-ab4e-b25286c82dda",
      "Name": "sample string 2",
      "Size": 3,
      "Category": "sample string 4",
      "Price": 5.1,
      "WrapHeight": 6.1,
      "WrapWidth": 7.1,
      "Backgrounds": [
        {
          "Id": "1cbbf01e-f7d4-4c13-b82d-d1a082a49981",
          "Name": "sample string 2",
          "CategoryNames": "sample string 3",
          "Url": "sample string 4",
          "IsDefault": true,
          "LicenseID": "0b3b9a64-86ae-4798-be67-ea919b2507a1",
          "IsLicensed": true,
          "PDPFG": "sample string 7",
          "PurchaseFG": "sample string 8",
          "PurchasePrice": 1.1,
          "LayoutRulesCompareResult": "sample string 9",
          "IsSameLayoutAvailable": true,
          "IsSameRulesAvailable": true,
          "AddedBy": "sample string 12",
          "IsMonogram": true,
          "IsAR": true,
          "IsActive": true,
          "IsForAdmin": true,
          "IsDeleted": true
        },
        {
          "Id": "1cbbf01e-f7d4-4c13-b82d-d1a082a49981",
          "Name": "sample string 2",
          "CategoryNames": "sample string 3",
          "Url": "sample string 4",
          "IsDefault": true,
          "LicenseID": "0b3b9a64-86ae-4798-be67-ea919b2507a1",
          "IsLicensed": true,
          "PDPFG": "sample string 7",
          "PurchaseFG": "sample string 8",
          "PurchasePrice": 1.1,
          "LayoutRulesCompareResult": "sample string 9",
          "IsSameLayoutAvailable": true,
          "IsSameRulesAvailable": true,
          "AddedBy": "sample string 12",
          "IsMonogram": true,
          "IsAR": true,
          "IsActive": true,
          "IsForAdmin": true,
          "IsDeleted": true
        }
      ],
      "Guideline": {
        "Id": "81710968-f294-4e16-9587-01f51f3a87af",
        "LicenseID": "9c8d7074-3bd9-4cf5-bbc2-9a5722443c99",
        "Name": "sample string 3",
        "Description": "sample string 4",
        "IconURL": "sample string 5",
        "DesignRules": "sample string 6",
        "IsActive": true
      },
      "Form": null,
      "FGCode": "sample string 8",
      "IsActive": true,
      "SiteCodeID": 10,
      "IsProjectCopiedFromTemplate": true
    },
    "Background": {
      "Id": "1cbbf01e-f7d4-4c13-b82d-d1a082a49981",
      "Name": "sample string 2",
      "CategoryNames": "sample string 3",
      "Url": "sample string 4",
      "IsDefault": true,
      "LicenseID": "0b3b9a64-86ae-4798-be67-ea919b2507a1",
      "IsLicensed": true,
      "PDPFG": "sample string 7",
      "PurchaseFG": "sample string 8",
      "PurchasePrice": 1.1,
      "LayoutRulesCompareResult": "sample string 9",
      "IsSameLayoutAvailable": true,
      "IsSameRulesAvailable": true,
      "AddedBy": "sample string 12",
      "IsMonogram": true,
      "IsAR": true,
      "IsActive": true,
      "IsForAdmin": true,
      "IsDeleted": true
    },
    "Stamps": [
      {
        "Id": "321f4924-0a07-4f46-89a3-6bd51e89d0e0",
        "Name": "sample string 2",
        "CategoryNames": "sample string 3",
        "Top": 4.1,
        "Left": 5.1,
        "Height": 6.1,
        "Width": 7.1,
        "CanChangeColor": true,
        "DefaultColor": "sample string 9",
        "Layer": 10,
        "Rotation": 11,
        "Url": "sample string 12",
        "AssetId": "f478f8cc-53bd-4c97-b871-66c5ac3b9ca0",
        "BackgroundColor": "sample string 14"
      },
      {
        "Id": "321f4924-0a07-4f46-89a3-6bd51e89d0e0",
        "Name": "sample string 2",
        "CategoryNames": "sample string 3",
        "Top": 4.1,
        "Left": 5.1,
        "Height": 6.1,
        "Width": 7.1,
        "CanChangeColor": true,
        "DefaultColor": "sample string 9",
        "Layer": 10,
        "Rotation": 11,
        "Url": "sample string 12",
        "AssetId": "f478f8cc-53bd-4c97-b871-66c5ac3b9ca0",
        "BackgroundColor": "sample string 14"
      }
    ],
    "Assets": [
      {
        "ProjectAssetId": "fb2ff2b2-7b64-4752-8291-37f85e5ceb19",
        "Height": 2.1,
        "Width": 3.1,
        "AssetHeight": 4.1,
        "AssetWidth": 5.1,
        "Left": 6.1,
        "Top": 7.1,
        "AssetId": "92e1a245-f8f2-4a68-b821-95e0beb9b8f3",
        "FlipX": true,
        "FlipY": true,
        "Rotation": 11.1,
        "zIndex": 12,
        "AssetType": 13,
        "DesignerPayload": "sample string 14",
        "LayoutMaskItemId": "ddc65852-3348-463e-813e-fdd36e2c3e34",
        "ImageUrl": "sample string 15",
        "CropPayload": "sample string 16",
        "PicsartPayload": "sample string 17",
        "Brightness": 18.1,
        "Saturation": 19.1,
        "ImageFilterType": "sample string 20",
        "ThemeProjectDetail": "sample string 21",
        "GalleryAssetID": "e5df3049-8bf0-40da-bf2c-87cb607e3008",
        "IsLocked": true,
        "StampColor": "sample string 24",
        "IsThemeImage": true
      },
      {
        "ProjectAssetId": "fb2ff2b2-7b64-4752-8291-37f85e5ceb19",
        "Height": 2.1,
        "Width": 3.1,
        "AssetHeight": 4.1,
        "AssetWidth": 5.1,
        "Left": 6.1,
        "Top": 7.1,
        "AssetId": "92e1a245-f8f2-4a68-b821-95e0beb9b8f3",
        "FlipX": true,
        "FlipY": true,
        "Rotation": 11.1,
        "zIndex": 12,
        "AssetType": 13,
        "DesignerPayload": "sample string 14",
        "LayoutMaskItemId": "ddc65852-3348-463e-813e-fdd36e2c3e34",
        "ImageUrl": "sample string 15",
        "CropPayload": "sample string 16",
        "PicsartPayload": "sample string 17",
        "Brightness": 18.1,
        "Saturation": 19.1,
        "ImageFilterType": "sample string 20",
        "ThemeProjectDetail": "sample string 21",
        "GalleryAssetID": "e5df3049-8bf0-40da-bf2c-87cb607e3008",
        "IsLocked": true,
        "StampColor": "sample string 24",
        "IsThemeImage": true
      }
    ],
    "ARAsset": {
      "Id": "397a8cee-9b68-41f3-b0b6-88e656e3c26b",
      "IsVideoEncoded": true,
      "IsVideoTrimmed": true,
      "IsPortraitVideo": true,
      "IsKeepLowResolutionVideo": true,
      "PublishedVideoURL": "sample string 6",
      "OriginalAssetURL": "sample string 7",
      "VideoThumbnailURL": "sample string 8",
      "CreatedDateUTC": "2025-08-30T18:04:55.1085513+00:00",
      "ModifiedDateUTC": "2025-08-30T18:04:55.1085513+00:00",
      "VideoStatus": 11,
      "IsTemp": true,
      "ErrorText": "sample string 13",
      "ARVideoUploadStatus": 0
    },
    "BackgroundId": "cd38e3ce-8c1c-461d-8a92-e2151a30621a",
    "BackgroundColor": "sample string 7",
    "LayoutMaskId": "480a951d-d1f1-46c2-a10d-1a00b6adb664",
    "ProductId": "3d0f154c-34c3-4b94-9a91-9a95a2c4d033",
    "UserID": "7ac0e173-1ddc-41cf-8043-43698e0ca4bc",
    "GuestUserId": "74e655cc-6647-47b3-a3d0-a9adce40c488",
    "PreviewImageDetails": "sample string 11",
    "FormTemplate": "sample string 12",
    "s7ImageVersion": "sample string 13",
    "FinalVingetteImageLocation": "sample string 14",
    "FinalFlatImageLocation": "sample string 15",
    "FinalFlatImageBlobLocation": "sample string 16",
    "PreviewFlatImageLocation": "sample string 17",
    "FinalFlatFilename": "sample string 18",
    "IsDefaultProjectName": true,
    "ProjectImageSource": "sample string 20",
    "FinalImageSource": 21,
    "ArtboardFlatImage": "QEA=",
    "ArtboardFlatImageLocation": "sample string 22",
    "SiteCode": "sample string 23",
    "SiteCodeID": 24,
    "ShowS7NoBackgroundExistsWarning": true,
    "EditRequestDateUTC": "2025-08-30T18:04:55.1085513+00:00",
    "IsCSREditing": true,
    "FinalFlatImage": "QEA=",
    "FinalFlatImageNoMask": "QEA=",
    "isThemeProject": true,
    "SourceProjectId": "53d61516-2b92-456c-a5ad-b8e6406d660c",
    "LicenseId": "038586ce-6574-459e-be04-4ed2729aeb9b",
    "ThemeProjectId": "1bd7db5f-260f-45d5-94d4-dd5b47a05573",
    "PDPFG": "sample string 28",
    "PurchaseFG": "sample string 29",
    "IsSourceThemeProject": true,
    "SMSOptIn": true,
    "TemplateBackgroundId": "b63235ac-9c22-457d-9ff7-fe4f9bff114a",
    "TemplateBackgroundColor": "sample string 31",
    "S7DecorationPositionHorizontal": 1,
    "ApplyBGColorToBottomOnly": true,
    "IsLocked": true,
    "IsCopyThemeUnlockedProject": true,
    "ExpiryDate": "2025-09-29T18:04:55.1085513+00:00",
    "IsOrderProjectExpired": false
  },
  {
    "Id": "facc499d-d69d-4ede-aee8-d437a9b2a460",
    "Name": "sample string 2",
    "CreatedDate": "2025-08-30T18:04:55.1085513+00:00",
    "ModifiedDate": "2025-08-30T18:04:55.1085513+00:00",
    "Status": 5,
    "Product": {
      "Id": "accc1f9b-bb65-4871-ab4e-b25286c82dda",
      "Name": "sample string 2",
      "Size": 3,
      "Category": "sample string 4",
      "Price": 5.1,
      "WrapHeight": 6.1,
      "WrapWidth": 7.1,
      "Backgrounds": [
        {
          "Id": "1cbbf01e-f7d4-4c13-b82d-d1a082a49981",
          "Name": "sample string 2",
          "CategoryNames": "sample string 3",
          "Url": "sample string 4",
          "IsDefault": true,
          "LicenseID": "0b3b9a64-86ae-4798-be67-ea919b2507a1",
          "IsLicensed": true,
          "PDPFG": "sample string 7",
          "PurchaseFG": "sample string 8",
          "PurchasePrice": 1.1,
          "LayoutRulesCompareResult": "sample string 9",
          "IsSameLayoutAvailable": true,
          "IsSameRulesAvailable": true,
          "AddedBy": "sample string 12",
          "IsMonogram": true,
          "IsAR": true,
          "IsActive": true,
          "IsForAdmin": true,
          "IsDeleted": true
        },
        {
          "Id": "1cbbf01e-f7d4-4c13-b82d-d1a082a49981",
          "Name": "sample string 2",
          "CategoryNames": "sample string 3",
          "Url": "sample string 4",
          "IsDefault": true,
          "LicenseID": "0b3b9a64-86ae-4798-be67-ea919b2507a1",
          "IsLicensed": true,
          "PDPFG": "sample string 7",
          "PurchaseFG": "sample string 8",
          "PurchasePrice": 1.1,
          "LayoutRulesCompareResult": "sample string 9",
          "IsSameLayoutAvailable": true,
          "IsSameRulesAvailable": true,
          "AddedBy": "sample string 12",
          "IsMonogram": true,
          "IsAR": true,
          "IsActive": true,
          "IsForAdmin": true,
          "IsDeleted": true
        }
      ],
      "Guideline": {
        "Id": "81710968-f294-4e16-9587-01f51f3a87af",
        "LicenseID": "9c8d7074-3bd9-4cf5-bbc2-9a5722443c99",
        "Name": "sample string 3",
        "Description": "sample string 4",
        "IconURL": "sample string 5",
        "DesignRules": "sample string 6",
        "IsActive": true
      },
      "Form": null,
      "FGCode": "sample string 8",
      "IsActive": true,
      "SiteCodeID": 10,
      "IsProjectCopiedFromTemplate": true
    },
    "Background": {
      "Id": "1cbbf01e-f7d4-4c13-b82d-d1a082a49981",
      "Name": "sample string 2",
      "CategoryNames": "sample string 3",
      "Url": "sample string 4",
      "IsDefault": true,
      "LicenseID": "0b3b9a64-86ae-4798-be67-ea919b2507a1",
      "IsLicensed": true,
      "PDPFG": "sample string 7",
      "PurchaseFG": "sample string 8",
      "PurchasePrice": 1.1,
      "LayoutRulesCompareResult": "sample string 9",
      "IsSameLayoutAvailable": true,
      "IsSameRulesAvailable": true,
      "AddedBy": "sample string 12",
      "IsMonogram": true,
      "IsAR": true,
      "IsActive": true,
      "IsForAdmin": true,
      "IsDeleted": true
    },
    "Stamps": [
      {
        "Id": "321f4924-0a07-4f46-89a3-6bd51e89d0e0",
        "Name": "sample string 2",
        "CategoryNames": "sample string 3",
        "Top": 4.1,
        "Left": 5.1,
        "Height": 6.1,
        "Width": 7.1,
        "CanChangeColor": true,
        "DefaultColor": "sample string 9",
        "Layer": 10,
        "Rotation": 11,
        "Url": "sample string 12",
        "AssetId": "f478f8cc-53bd-4c97-b871-66c5ac3b9ca0",
        "BackgroundColor": "sample string 14"
      },
      {
        "Id": "321f4924-0a07-4f46-89a3-6bd51e89d0e0",
        "Name": "sample string 2",
        "CategoryNames": "sample string 3",
        "Top": 4.1,
        "Left": 5.1,
        "Height": 6.1,
        "Width": 7.1,
        "CanChangeColor": true,
        "DefaultColor": "sample string 9",
        "Layer": 10,
        "Rotation": 11,
        "Url": "sample string 12",
        "AssetId": "f478f8cc-53bd-4c97-b871-66c5ac3b9ca0",
        "BackgroundColor": "sample string 14"
      }
    ],
    "Assets": [
      {
        "ProjectAssetId": "fb2ff2b2-7b64-4752-8291-37f85e5ceb19",
        "Height": 2.1,
        "Width": 3.1,
        "AssetHeight": 4.1,
        "AssetWidth": 5.1,
        "Left": 6.1,
        "Top": 7.1,
        "AssetId": "92e1a245-f8f2-4a68-b821-95e0beb9b8f3",
        "FlipX": true,
        "FlipY": true,
        "Rotation": 11.1,
        "zIndex": 12,
        "AssetType": 13,
        "DesignerPayload": "sample string 14",
        "LayoutMaskItemId": "ddc65852-3348-463e-813e-fdd36e2c3e34",
        "ImageUrl": "sample string 15",
        "CropPayload": "sample string 16",
        "PicsartPayload": "sample string 17",
        "Brightness": 18.1,
        "Saturation": 19.1,
        "ImageFilterType": "sample string 20",
        "ThemeProjectDetail": "sample string 21",
        "GalleryAssetID": "e5df3049-8bf0-40da-bf2c-87cb607e3008",
        "IsLocked": true,
        "StampColor": "sample string 24",
        "IsThemeImage": true
      },
      {
        "ProjectAssetId": "fb2ff2b2-7b64-4752-8291-37f85e5ceb19",
        "Height": 2.1,
        "Width": 3.1,
        "AssetHeight": 4.1,
        "AssetWidth": 5.1,
        "Left": 6.1,
        "Top": 7.1,
        "AssetId": "92e1a245-f8f2-4a68-b821-95e0beb9b8f3",
        "FlipX": true,
        "FlipY": true,
        "Rotation": 11.1,
        "zIndex": 12,
        "AssetType": 13,
        "DesignerPayload": "sample string 14",
        "LayoutMaskItemId": "ddc65852-3348-463e-813e-fdd36e2c3e34",
        "ImageUrl": "sample string 15",
        "CropPayload": "sample string 16",
        "PicsartPayload": "sample string 17",
        "Brightness": 18.1,
        "Saturation": 19.1,
        "ImageFilterType": "sample string 20",
        "ThemeProjectDetail": "sample string 21",
        "GalleryAssetID": "e5df3049-8bf0-40da-bf2c-87cb607e3008",
        "IsLocked": true,
        "StampColor": "sample string 24",
        "IsThemeImage": true
      }
    ],
    "ARAsset": {
      "Id": "397a8cee-9b68-41f3-b0b6-88e656e3c26b",
      "IsVideoEncoded": true,
      "IsVideoTrimmed": true,
      "IsPortraitVideo": true,
      "IsKeepLowResolutionVideo": true,
      "PublishedVideoURL": "sample string 6",
      "OriginalAssetURL": "sample string 7",
      "VideoThumbnailURL": "sample string 8",
      "CreatedDateUTC": "2025-08-30T18:04:55.1085513+00:00",
      "ModifiedDateUTC": "2025-08-30T18:04:55.1085513+00:00",
      "VideoStatus": 11,
      "IsTemp": true,
      "ErrorText": "sample string 13",
      "ARVideoUploadStatus": 0
    },
    "BackgroundId": "cd38e3ce-8c1c-461d-8a92-e2151a30621a",
    "BackgroundColor": "sample string 7",
    "LayoutMaskId": "480a951d-d1f1-46c2-a10d-1a00b6adb664",
    "ProductId": "3d0f154c-34c3-4b94-9a91-9a95a2c4d033",
    "UserID": "7ac0e173-1ddc-41cf-8043-43698e0ca4bc",
    "GuestUserId": "74e655cc-6647-47b3-a3d0-a9adce40c488",
    "PreviewImageDetails": "sample string 11",
    "FormTemplate": "sample string 12",
    "s7ImageVersion": "sample string 13",
    "FinalVingetteImageLocation": "sample string 14",
    "FinalFlatImageLocation": "sample string 15",
    "FinalFlatImageBlobLocation": "sample string 16",
    "PreviewFlatImageLocation": "sample string 17",
    "FinalFlatFilename": "sample string 18",
    "IsDefaultProjectName": true,
    "ProjectImageSource": "sample string 20",
    "FinalImageSource": 21,
    "ArtboardFlatImage": "QEA=",
    "ArtboardFlatImageLocation": "sample string 22",
    "SiteCode": "sample string 23",
    "SiteCodeID": 24,
    "ShowS7NoBackgroundExistsWarning": true,
    "EditRequestDateUTC": "2025-08-30T18:04:55.1085513+00:00",
    "IsCSREditing": true,
    "FinalFlatImage": "QEA=",
    "FinalFlatImageNoMask": "QEA=",
    "isThemeProject": true,
    "SourceProjectId": "53d61516-2b92-456c-a5ad-b8e6406d660c",
    "LicenseId": "038586ce-6574-459e-be04-4ed2729aeb9b",
    "ThemeProjectId": "1bd7db5f-260f-45d5-94d4-dd5b47a05573",
    "PDPFG": "sample string 28",
    "PurchaseFG": "sample string 29",
    "IsSourceThemeProject": true,
    "SMSOptIn": true,
    "TemplateBackgroundId": "b63235ac-9c22-457d-9ff7-fe4f9bff114a",
    "TemplateBackgroundColor": "sample string 31",
    "S7DecorationPositionHorizontal": 1,
    "ApplyBGColorToBottomOnly": true,
    "IsLocked": true,
    "IsCopyThemeUnlockedProject": true,
    "ExpiryDate": "2025-09-29T18:04:55.1085513+00:00",
    "IsOrderProjectExpired": false
  }
]

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'Tervis.Customyzer.Services.Web.API.Models.Form' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'Tervis.Customyzer.Services.Web.API.Models.Form' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.