TBS Apps API

<back to all web services

InsertBlackbookRequest

Requires Authentication
The following routes are available for this service:
GET,POST/InsertBlackbookInserts a blackbook entryInserts an entry in to the currently authenticated user's blackbook
InsertBlackbookRequest Parameters:
NameParameterData TypeRequiredDescription
BlackbookTypebodybyteNoBlackbook Type
EventTypebodyintNoEvent Type
NamebodystringNoName of the runner
CommentbodystringNoComment
EventIdbodyintNoEvent Id of the blackbook
SocialGroupIDsbodyList<int>NoSocial Group IDs
OutcomeIdbodyintNoOutcomeId
BlackbookInsertResult Parameters:
NameParameterData TypeRequiredDescription
ErrorNoformintNo
MessageformstringNo
BlackbookIDformintNo
UsernameformstringNo
CreationDateformDateTime?No
HighlightedEventsformList<BlackbookInsertHighlightedEvents>No
SocialGroupsformList<BlackbookSocialGroup>No
BlackbookInsertHighlightedEvents Parameters:
NameParameterData TypeRequiredDescription
BlackbookHighlightIDformlongNo
EventIDformintNo
BlackbookSocialGroup Parameters:
NameParameterData TypeRequiredDescription
GroupIdformintNo
GroupNameformstringNo

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 /InsertBlackbook HTTP/1.1 
Host: tstextweb20.np.bluebet.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InsertBlackbookRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TBS.Frontend.RequestLayer.RequestFunctions">
  <BlackbookType>0</BlackbookType>
  <Comment>String</Comment>
  <EventId>0</EventId>
  <EventType>0</EventType>
  <Name>String</Name>
  <OutcomeId>0</OutcomeId>
  <SocialGroupIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </SocialGroupIDs>
</InsertBlackbookRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BlackbookInsertResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TBS.Frontend.Messaging.DataContracts">
  <_x003C_BlackbookID_x003E_k__BackingField>0</_x003C_BlackbookID_x003E_k__BackingField>
  <_x003C_CreationDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_CreationDate_x003E_k__BackingField>
  <_x003C_ErrorNo_x003E_k__BackingField>0</_x003C_ErrorNo_x003E_k__BackingField>
  <_x003C_HighlightedEvents_x003E_k__BackingField>
    <BlackbookInsertHighlightedEvents>
      <_x003C_BlackbookHighlightID_x003E_k__BackingField>0</_x003C_BlackbookHighlightID_x003E_k__BackingField>
      <_x003C_EventID_x003E_k__BackingField>0</_x003C_EventID_x003E_k__BackingField>
    </BlackbookInsertHighlightedEvents>
  </_x003C_HighlightedEvents_x003E_k__BackingField>
  <_x003C_Message_x003E_k__BackingField>String</_x003C_Message_x003E_k__BackingField>
  <_x003C_SocialGroups_x003E_k__BackingField>
    <BlackbookSocialGroup>
      <_x003C_GroupId_x003E_k__BackingField>0</_x003C_GroupId_x003E_k__BackingField>
      <_x003C_GroupName_x003E_k__BackingField>String</_x003C_GroupName_x003E_k__BackingField>
    </BlackbookSocialGroup>
  </_x003C_SocialGroups_x003E_k__BackingField>
  <_x003C_Username_x003E_k__BackingField>String</_x003C_Username_x003E_k__BackingField>
</BlackbookInsertResult>