Jump to

• Request
• Response
• Examples

Get a contact marketing roster

get

/services/rest/connect/v1.4/contactMarketingRosters/{id}

Request

Path Parameters

• id: integer
  The unique identifier of the contact marketing roster.

Back to Top

Response

Default Response

Body ()

Root Schema : contactMarketingRosters

Type: object

The information about the contact lists used in audiences in Oracle B2C Service Outreach Cloud Service.

Show Source

• comment(optional): [ "string", "null" ]
  Maximum Length: 1333

  The description associated with the contact marketing roster.
• createdByAccount(optional): [ "object", "null" ]
  The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
• createdTime(optional): string
  The date and time when the contact marketing roster was created. This attribute is read-only.
• id(optional): integer
  Minimum Value: 1

  Maximum Value: 9.223372036854776E18

  The unique identifier of the contact marketing roster.
• interface(optional): object interface
  The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name. It is the reference to a resource in 'siteInterfaces' collection. Only ID or lookupName can be provided to specify the resource.
• isProofList(optional): boolean
  Indicates whether the contact marketing roster is a proof list.
• lastCountStatistics(optional): object contactMarketingRosters-lastCountStatistics
  The last count-related information of the contact marketing roster.
• lookupName(optional): string
  Maximum Length: 255

  The name used to look up the contact marketing roster.
• name(optional): string
  Maximum Length: 80

  Pattern: ^[^ ]*$

  The name of the contact marketing roster.
• purgeData(optional): boolean
  Indicates whether the contact marketing roster should be cleared periodically. The default value is false.
• updatedByAccount(optional): [ "object", "null" ]
  The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
• updatedTime(optional): string
  The date and time when the contact marketing roster was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The information about the contact lists used in audiences in Oracle B2C Service Outreach Cloud Service.",
    "properties":{
        "comment":{
            "type":[
                "string",
                "null"
            ],
            "description":"The description associated with the contact marketing roster.",
            "maxLength":1333
        },
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the contact marketing roster was last updated. This attribute is read-only."
        },
        "purgeData":{
            "type":"boolean",
            "description":"Indicates whether the contact marketing roster should be cleared periodically. The default value is false."
        },
        "name":{
            "pattern":"^[^\t\n]*$",
            "type":"string",
            "description":"The name of the contact marketing roster.",
            "maxLength":80
        },
        "lastCountStatistics":{
            "type":"object",
            "description":"The last count-related information of the contact marketing roster.",
            "$ref":"#/definitions/contactMarketingRosters-lastCountStatistics"
        },
        "updatedByAccount":{
            "type":[
                "object",
                "null"
            ],
            "description":"The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "isProofList":{
            "type":"boolean",
            "description":"Indicates whether the contact marketing roster is a proof list."
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the contact marketing roster.",
            "maxLength":255
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the contact marketing roster was created. This attribute is read-only."
        },
        "interface":{
            "type":"object",
            "description":"The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name. It is the reference to a resource in 'siteInterfaces' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "createdByAccount":{
            "type":[
                "object",
                "null"
            ],
            "description":"The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the contact marketing roster.",
            "maximum":9.223372036854776E18
        }
    }
}

Nested Schema : interface

Type: object

The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name. It is the reference to a resource in 'siteInterfaces' collection. Only ID or lookupName can be provided to specify the resource.

Nested Schema : contactMarketingRosters-lastCountStatistics

Type: object

The last count-related information of the contact marketing roster.

Show Source

• lastCount(optional): integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of contacts in the contact marketing roster when the count was last calculated.
• lastCountedTime(optional): string
  The date and time when the contact marketing roster was last counted.

{
    "type":"object",
    "description":"The last count-related information of the contact marketing roster.",
    "properties":{
        "lastCountedTime":{
            "type":"string",
            "description":"The date and time when the contact marketing roster was last counted."
        },
        "lastCount":{
            "minimum":0,
            "type":"integer",
            "description":"The number of contacts in the contact marketing roster when the count was last calculated.",
            "maximum":2147483647
        }
    }
}

Back to Top

Examples

Use GET with the following syntax to retrieve data for a contact marketing roster:

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

Request URI example

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

Response body example

{
    "id": 13,
    "lookupName": "Outreach Contacts",
    "createdTime": "2018-04-17T10:03:16.000Z",
    "updatedTime": "2018-04-17T10:03:16.000Z",
    "comment": null,
    "createdByAccount": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/2"
            },
            {
                "rel": "canonical",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/2"
            },
            {
                "rel": "describedby",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accounts",
                "mediaType": "application/schema+json"
            }
        ]
    },
    "interface": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/siteInterfaces/1"
            },
            {
                "rel": "canonical",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/siteInterfaces/1"
            },
            {
                "rel": "describedby",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/siteInterfaces",
                "mediaType": "application/schema+json"
            }
        ]
    },
    "isProofList": false,
    "lastCountStatistics": {},
    "name": "Outreach Contacts",
    "purgeData": false,
    "updatedByAccount": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/2"
            },
            {
                "rel": "canonical",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/2"
            },
            {
                "rel": "describedby",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accounts",
                "mediaType": "application/schema+json"
            }
        ]
    },
    "links": [
        {
            "rel": "self",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/contactMarketingRosters/13"
        },
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/contactMarketingRosters/13"
        },
        {
            "rel": "describedby",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/contactMarketingRosters",
            "mediaType": "application/schema+json"
        }
    ]
}

Back to Top