Jump to

• Request
• Response
• Examples

Get multiple contact marketing rosters

get

/services/rest/connect/v1.4/contactMarketingRosters

Request

Supported Media Types

• application/x-www-form-urlencoded

Query Parameters

• fields: string
  The list of attributes that should be returned in the response. The syntax contains a comma delimited string of attributes.
  For example: ?fields=attribute1,attribute2
• limit: integer
  The requested page size, which limits the number of records returned in the response.
  For example: ?limit=100
• offset: integer
  The starting position of the record. For example, if you set an offset of 8, the request will skip the first eight records, and include the records from the ninth record in the response. The default value is 0, which means that the records will be returned from the first record.
  For example: ?offset=8
• orderBy: string
  The list of attributes used to determine the order in which the records are returned. The syntax contains a comma delimited string of attributes, with each attribute optionally followed by 'asc' or 'desc'. Specify 'asc' for ascending order and 'desc' for descending order. The default value is 'asc'.
  For example: ?orderBy=field1:asc,field2:desc
• q: string
  The query parameter that allows searching by providing ROQL 'where' clause filtering.
  For example: ?q=id>2 and id<10< div>
• totalResults: boolean
  Indicates whether the count for the total number of records returned should be shown. The default value is false.
  If you set the value of totalResults as true, the response will include the count of records retrieved by the request.
  Example response:"totalResults": 27

Back to Top

Response

Supported Media Types

• application/json;type=collection

Default Response

Body ()

Root Schema : contactMarketingRosters-collection

Type: object

Collection of contactMarketingRosters

Show Source

• createdTime: string
  The date and time when the contact marketing roster was created. This attribute is read-only.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the contact marketing roster.
• lookupName: string
  Maximum Length: 255

  The name used to look up the contact marketing roster.
• updatedTime: string
  The date and time when the contact marketing roster was last updated. This attribute is read-only.

{
    "type":"object",
    "properties":{
        "createdTime":{
            "$ref":"#/definitions/contactMarketingRosters/properties/createdTime"
        },
        "updatedTime":{
            "$ref":"#/definitions/contactMarketingRosters/properties/updatedTime"
        },
        "id":{
            "$ref":"#/definitions/contactMarketingRosters/properties/id"
        },
        "lookupName":{
            "$ref":"#/definitions/contactMarketingRosters/properties/lookupName"
        }
    },
    "description":"Collection of contactMarketingRosters"
}

Back to Top

Examples

Use GET with the following syntax to list all contact marketing rosters:

https://your_site_interface/services/rest/connect/version/contactMarketingRosters

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/contactMarketingRosters

Response body example

{
    "items": [
        {
            "id": 1,
            "lookupName": "Sample Contacts",
            "createdTime": "2009-01-14T15:17:39.000Z",
            "updatedTime": "2018-04-17T07:32:19.000Z",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/contactMarketingRosters/1"
                }
            ]
        },
        {
            "id": 2,
            "lookupName": "Service Contacts",
            "createdTime": "2013-12-09T05:10:08.000Z",
            "updatedTime": "2013-12-09T05:10:08.000Z",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/contactMarketingRosters/3"
                }
            ]
        },
        ...
        {
            "id": 13,
            "lookupName": "Outreach Contacts",
            "createdTime": "2018-04-17T10:03:16.000Z",
            "updatedTime": "2018-04-17T10:03:16.000Z",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/contactMarketingRosters/13"
                }
            ]
        }
    ],
    "hasMore": false,
    "links": [
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/contactMarketingRosters"
        },
        {
            "rel": "describedby",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/contactMarketingRosters",
            "mediaType": "application/schema+json"
        },
        {
            "rel": "search-form",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/contactMarketingRosters-search-form"
        },
        {
            "rel": "self",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/contactMarketingRosters"
        }
    ]
}

Back to Top