TBS Apps API

<back to all web services

SocialBlackbooksRequest

Requires Authentication
The following routes are available for this service:
GET,POST/SocialBlackbooksGets Blackbooks that belong to yourself or your social connections.Gets Social Blackbooks. Blackbooks of Connections that are marked as 'DoNotFollow' are excluded
SocialBlackbooksResponse Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<SocialBlackbook>No
SocialBlackbook Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
EventTypeformintNo
BlackbookHighlightsformList<BlackbookHighlight>No
CommentsformList<BlackBook>No
BlackbookHighlight Parameters:
NameParameterData TypeRequiredDescription
EventIdformintNo
EventTypeIdformintNo
EventNameformstringNo
AdvertisedStartTimeUtcformDateTimeNo
AdvertisedStartTimeformstringNo
TimeToJumpformintNo
VenueformstringNo
RaceNumberformintNo
EventClassCodeformstringNo
MasterEventIdformintNo
MasterCategoryNameformstringNo
BlackBook Parameters:
NameParameterData TypeRequiredDescription
BlackbookIdformintNo
ClientIdformintNo
BlackbookTypeformintNo
NameformstringNo
CommentformstringNo
UsernameformstringNo
CreationDateformDateTimeNo
LastUpdateUtcformDateTimeNo
LastUpdateformstringNo
BlackbookHighlightsformList<BlackbookHighlight>No
EmailformstringNo
EmailHashformstringNo
IsMineformboolNo
EventTypeformintNo
FullNameformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /SocialBlackbooks HTTP/1.1 
Host: tstextweb20.np.bluebet.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SocialBlackbooksRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TBS.Frontend.RequestLayer.RequestFunctions" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SocialBlackbooksResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TBS.Frontend.RequestLayer.RequestFunctions">
  <Items>
    <SocialBlackbook>
      <BlackbookHighlights xmlns:d4p1="http://schemas.datacontract.org/2004/07/TBS.Frontend.Messaging.DataContracts">
        <d4p1:BlackbookHighlight>
          <d4p1:AdvertisedStartTimeUtc>0001-01-01T00:00:00</d4p1:AdvertisedStartTimeUtc>
          <d4p1:EventClassCode>String</d4p1:EventClassCode>
          <d4p1:EventId>0</d4p1:EventId>
          <d4p1:EventName>String</d4p1:EventName>
          <d4p1:EventTypeId>0</d4p1:EventTypeId>
          <d4p1:MasterCategoryName>String</d4p1:MasterCategoryName>
          <d4p1:MasterEventId>0</d4p1:MasterEventId>
          <d4p1:RaceNumber>0</d4p1:RaceNumber>
          <d4p1:Venue>String</d4p1:Venue>
        </d4p1:BlackbookHighlight>
      </BlackbookHighlights>
      <Comments xmlns:d4p1="http://schemas.datacontract.org/2004/07/TBS.Frontend.Messaging.DataContracts">
        <d4p1:BlackBook>
          <d4p1:BlackbookHighlights>
            <d4p1:BlackbookHighlight>
              <d4p1:AdvertisedStartTimeUtc>0001-01-01T00:00:00</d4p1:AdvertisedStartTimeUtc>
              <d4p1:EventClassCode>String</d4p1:EventClassCode>
              <d4p1:EventId>0</d4p1:EventId>
              <d4p1:EventName>String</d4p1:EventName>
              <d4p1:EventTypeId>0</d4p1:EventTypeId>
              <d4p1:MasterCategoryName>String</d4p1:MasterCategoryName>
              <d4p1:MasterEventId>0</d4p1:MasterEventId>
              <d4p1:RaceNumber>0</d4p1:RaceNumber>
              <d4p1:Venue>String</d4p1:Venue>
            </d4p1:BlackbookHighlight>
          </d4p1:BlackbookHighlights>
          <d4p1:BlackbookId>0</d4p1:BlackbookId>
          <d4p1:BlackbookType>0</d4p1:BlackbookType>
          <d4p1:ClientId>0</d4p1:ClientId>
          <d4p1:Comment>String</d4p1:Comment>
          <d4p1:CreationDate>0001-01-01T00:00:00</d4p1:CreationDate>
          <d4p1:Email>String</d4p1:Email>
          <d4p1:EventType>0</d4p1:EventType>
          <d4p1:FullName>String</d4p1:FullName>
          <d4p1:IsMine>false</d4p1:IsMine>
          <d4p1:LastUpdateUtc>0001-01-01T00:00:00</d4p1:LastUpdateUtc>
          <d4p1:Name>String</d4p1:Name>
          <d4p1:Username>String</d4p1:Username>
        </d4p1:BlackBook>
      </Comments>
      <EventType>0</EventType>
      <Name>String</Name>
    </SocialBlackbook>
  </Items>
</SocialBlackbooksResponse>