API / SocialMediaLink

Entity Description:

SocialMediaLink is a tracked link that can be used in Social Media to track results (e.g. Twitter, Facebook, Google+, etc…).

Properties

NameDescriptionTypeAdditional
Information
ID
Int32
ActiveState
Int16
Name
String
Description
String
URL
String
OwnerID
Int32
GUID
String
Shared
Boolean
CreationDate
DateTime
BusinessID
Int32
RegionID
Int32

Entity Statement

if you are using versions earlier than 5.0, substitute "ssv3" for "api" for each Request listed below.

Creating a SocialMediaLink

Request

POST /api/odata/SocialMediaLinks

Content-Type 

application/json

Request body

{
"ID":"0","ActiveState":"1","Name":"New Social Media Link","Description":"Example Description","URL":"Example URL","OwnerID":"0","GUID":"0","Shared":false,
"CreationDate":"2014-12-10T17:48:26.155Z","BusinessID":"0","RegionID":"0"
}

Response body

{
"ID":1,"ActiveState":1,"Name":"New Social Media Link","Description":"Example Description","URL":"Example URL","OwnerID":0,"GUID":"0",
"Shared":false,"CreationDate":"2014-12-10T17:59:39.155Z",
"BusinessID":0,"RegionID":0
}
Deleting a SocialMediaLink
 Request
 DELETE /api/odata/SocialMediaLinks(1)
 Response Headers
 HTTP/1.1 204 No Content
Getting a SocialMediaLink
 Request
 GET /api/odata/SocialMediaLinks(1)
 Content-Type 
 application/json
 Response body
 {
"ID":1,"ActiveState":1,"Name":"New Social Media Link","Description":"Example Description","URL":"Example URL","OwnerID":0,"GUID":"0",
"Shared":false,"CreationDate":"2014-12-10T17:59:39.155Z",
"BusinessID":0,"RegionID":0
}
Updating a SocialMediaLink
 Request
 PUT /api/odata/SocialMediaLinks(1)
 Content-Type 
 application/json
 Request body
 {
"ID":"0","ActiveState":"1","Name":"New Social Media Link","Description":"Example Description","URL":"Example URL","OwnerID":"0","GUID":"0",
"Shared":false,"CreationDate":"2014-12-10T17:48:26.155Z",
"BusinessID":"0","RegionID":"0"
}
 Response Headers
 HTTP/1.1 204 No Content
Getting all SocialMediaLinks
 Request
 GET /api/odata/SocialMediaLinks
 Content-Type
 application/json
 Response body
 "value":[{
"ID":0,"ActiveState":1,"Name":"New Social Media Link","Description":"Example Description","URL":"Example URL","OwnerID":0,"GUID":"0","Shared":false,
"CreationDate":"2014-12-10T17:48:26.155Z","BusinessID":0,"RegionID":0
},{
"ID":1,"ActiveState":1,"Name":"New Social Media Link","Description":"Example Description","URL":"Example URL","OwnerID":0,"GUID":"0","Shared":false,
"CreationDate":"2014-12-10T17:59:39.155Z","BusinessID":0,"RegionID":0
}]