Jump to

• Request
• Response

Create a campaign respondent

post

/hcmRestApi/resources/11.13.18.05/communicateUICampaignRespondents

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : communicateUICampaignRespondents-item-response

Type: object

Show Source

• AssignmentType: string
  Read Only: true

  Maximum Length: 30

  Assignment type of a campaign respondent.
• BusinessId: integer (int64)
  Read Only: true

  Unique identifier of a business.
• BusinessUnit: string
  Read Only: true

  Maximum Length: 240

  Business unit of the campaign respondent.
• CampaignCode: string
  Read Only: true

  Maximum Length: 30

  Campaign code of the campaign.
• CampaignId: integer (int64)
  Read Only: true

  Unique identifier of the campaign.
• EmailAddress: string
  Read Only: true

  Maximum Length: 255

  Email address of the campaign respondent.
• EmployeeName: string
  Read Only: true

  Maximum Length: 240

  Employee name of the campaign respondent.
• LastRespondDate: string (date-time)
  Read Only: true

  Date when the campaign respondent last responded.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationId: integer (int64)
  Read Only: true

  Unique identifier of the location of the campaign respondent.
• PersonId: integer (int64)
  Read Only: true

  Unique identifier of the person.
• QuestionsAndResponses: string
  Read Only: true

  Maximum Length: 255

  Questions and responses of the respondent.
• RESPONDED: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the respondent submitted a response to the campaign questionnaire.
• WorkLocation: string
  Read Only: true

  Maximum Length: 240

  Work location of the respondent.

{
    "type":"object",
    "properties":{
        "AssignmentType":{
            "maxLength":30,
            "type":"string",
            "description":"Assignment type of a campaign respondent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessId":{
            "type":"integer",
            "description":"Unique identifier of a business.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessUnit":{
            "maxLength":240,
            "type":"string",
            "description":"Business unit of the campaign respondent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignCode":{
            "maxLength":30,
            "type":"string",
            "description":"Campaign code of the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignId":{
            "type":"integer",
            "description":"Unique identifier of the campaign.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":255,
            "type":"string",
            "description":"Email address of the campaign respondent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmployeeName":{
            "maxLength":240,
            "type":"string",
            "description":"Employee name of the campaign respondent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastRespondDate":{
            "type":"string",
            "description":"Date when the campaign respondent last responded.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Unique identifier of the location of the campaign respondent.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique identifier of the person.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuestionsAndResponses":{
            "maxLength":255,
            "type":"string",
            "description":"Questions and responses of the respondent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RESPONDED":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the respondent submitted a response to the campaign questionnaire.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkLocation":{
            "maxLength":240,
            "type":"string",
            "description":"Work location of the respondent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top