Jump to

• Request
• Response
• Examples

Retrieve a Campaign's Proof List

get

/rest/api/v1.3/campaigns/{campaignName}/attributes/proofList

Retrieves the Campaign Proof List associated with a specified Campaign.

Request

Path Parameters

• campaignName: string
  Name of the Campaign

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Campaign Proof List Response

Type: object

Title: Campaign Proof List Response

Show Source

• attributeData: object Proof List
  Title: Proof List
• attributeName: string
  Allowed Values: [ "proofList" ]

  The attribute of the campaign. "ProofList" in this scenario

{
    "title":"Campaign Proof List Response",
    "type":"object",
    "properties":{
        "attributeName":{
            "description":"The attribute of the campaign. \"ProofList\" in this scenario",
            "type":"string",
            "enum":[
                "proofList"
            ]
        },
        "attributeData":{
            "$ref":"#/definitions/proofList"
        }
    },
    "required":[
        "attributeName",
        "attributeData"
    ]
}

Nested Schema : Proof List

Type: object

Title: Proof List

Show Source

• createdBy: string
  User who created the Proof List
• createdDate: string(date)
  Proof List creation date
• description: string
  Proof List description
• folderName: string
  Folder containing the Proof List
• listName: string
  Profile list name for which the Proof List is associated
• modifiedBy: string
  User who modified the Proof List
• modifiedDate: string(date)
  Proof List modification date
• name: string
  Proof List Name

{
    "title":"Proof List",
    "type":"object",
    "properties":{
        "name":{
            "description":"Proof List Name",
            "type":"string"
        },
        "description":{
            "description":"Proof List description",
            "type":"string"
        },
        "listName":{
            "description":"Profile list name for which the Proof List is associated",
            "type":"string"
        },
        "folderName":{
            "description":"Folder containing the Proof List",
            "type":"string"
        },
        "createdBy":{
            "description":"User who created the Proof List",
            "type":"string"
        },
        "createdDate":{
            "description":"Proof List creation date",
            "type":"string",
            "format":"date"
        },
        "modifiedBy":{
            "description":"User who modified the Proof List",
            "type":"string"
        },
        "modifiedDate":{
            "description":"Proof List modification date",
            "type":"string",
            "format":"date"
        }
    },
    "required":[
        "name",
        "description",
        "listName",
        "folderName",
        "createdBy",
        "createdDate",
        "modifiedBy",
        "modifiedDate"
    ]
}

Back to Top

Examples

Use this interface to get the proof list associated with the specified campaign. The response returns the proof list object, which includes the proof list name and the list's other properties. The links array contains the proof list's object's related API operations, specific to the campaign name.

Required request headers:

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>
Content-Type	application/json

Response Notes:

Sample Response Body

{
  "attributeName": "proofList",
  "attributeData": {
    "name": "Proof_List_Name",
    "description": null,
    "listName": "Profile_List_Name",
    "folderName": "folderName",
    "createdBy": "api.user",
    "createdDate": "2020-06-29",
    "modifiedBy": "api.user",
    "modifiedDate": "2020-06-29"
  },
  "links": [
    {
      "rel": "self",
      "href": "/rest/api/v1.3/campaigns/example_campaign/attributes/proofList",
      "method": "GET"
    },
    {
      "rel": "updateCampaignAttribute",
      "href": "/rest/api/v1.3/campaigns/example_campaign/attributes/proofList",
      "method": "PUT"
    }
  ]
}
	

Troubleshooting Failures

The system returns error responses in the following situations.

There is no proof list associated with the campaign: A 404 not found error is returned with the following error response body:

{
  "type": "",
  "title": "Proof list not found",
  "errorCode": "PROOF_LIST_NOT_FOUND",
  "detail": "No ProofList Found for Campaign Example_Campaign",
  "errorDetails": []
}
	

Invalid character specified for campaign name: A 400 bad request error is returned with the following error response body (where the table name sent is returned in the square brackets):

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER",
  "detail": "Invalid characters in the Campaign name: Example.Campaign",
  "errorDetails": []
}
	

Campaign does not exist: A 404 not found error is returned with the following error response body (where the campaign name sent is returned in the square brackets):

{
  "type": "",
  "title": "Campaign not found",
  "errorCode": "CAMPAIGN_NOT_FOUND",
  "detail": "[ Example.Campaign ] Campaign Not Found",
  "errorDetails": []
}
	

Invalid attribute name: A 400 bad request error is returned with the following error response body:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER",
  "detail": "Invalid attribute name :filter",
  "errorDetails": []
}
	

Back to Top