We've recently moved hosts! Please report any weirdness with the wiki (or spam) on Utopia.

NuDOC Protocol RFC/Complex data types

From BBSWiki

Jump to: navigation, search

Contents

[edit] Control

This data type comes at the beginning of every server response. ControlMessage is one of RDY (ready), ACK (acknowledged), NAK (not acknowledged), PSH (broadcast). ControlCode is a (currently optional) numeric code which full-featured i18n clients may use to look up a corresponding human-readable message. 

<ControlSegment>
  <ControlMessage>...</ControlMessage>
  <ControlCode>...</ControlCode>
</ControlSegment>

[edit] User

Every field in this data type is optional except Username. (?) 

<User>
  <UserNumber>...</UserNumber>
  <Username>...</Username>
  <Password>...</Password>
  <RealName>...</RealName>
  <Address>...</Address>
  <City>...</City>
  <StateProvince>...</StateProvince>
  <PostCode>...</PostCode>
  <Phone>...</Phone>
  <Email>...</Email>
  <WebSite>...</WebSite>
  <NumCalls>...</NumCalls>
  <NumPosts>...</NumPosts>
  <NumXes>...</NumXes>
  <CreateDate>...</CreateDate>
  <ConnectStatus>...</ConnectStatus>
  <ConnectFrom>...</ConnectFrom>
  <LastLogin>...</LastLogin>
  <LastLogout>...</LastLogout>
  <DoingField>...</DoingField>
  <ProfileText>
  ...
  </ProfileText>
  <VanityFlag>...</VanityFlag>
  <Flag>...</Flag>
  <Flag>...</Flag>
  <StatusFlag>...</StatusFlag>
  <StatusFlag>...</StatusFlag>
</User>

[edit] Room

The RoomAides are user numbers as is the RoomInfoUpdatedBy. All fields are optional except RoomNumber. 

<Room>
  <RoomNumber>...</RoomNumber>
  <RoomName>...</RoomName>
  <LastMessage>...</LastMessage>
  <FirstMessageUnread>...</FirstMessageUnread>
  <RoomAide>...</RoomAide>
  <RoomAide>...</RoomAide>
  <RoomInfo>
  ...
  </RoomInfo>
  <RoomInfoUpdatedBy>...</RoomInfoUpdatedBy>
  <RoomInfoLastUpdated>...</RoomInfoLastUpdated>
</Room>

[edit] Message

[edit] Header

<MessageHeader>
  <User>
    <UserNumber>...</UserNumber>
    <Username>...</Username>
  </User>
  <Room>
    <RoomNumber>...</RoomNumber>
  </Room>
  <MessageHeaderData>
    <Subject>...</Subject>
    <DatePosted>...</DatePosted>
    <RoomMessageNumber>...</RoomMessageNumber>
    <GlobalMessageNumber>...</GlobalMessageNumber>
    <GlobalParentNumber>...</GlobalParentNumber>
  </MessageHeaderData>
</MessageHeader>

[edit] Body

<MessageBody>
  <GlobalMessageNumber>...</GlobalMessageNumber>
  <MessageBodyText>
  ...
  </MessageBodyText>
</MessageBody>

[edit] eXpress Message

Retrieved from "http://bbswiki.evernex.com/wiki/NuDOC_Protocol_RFC/Complex_data_types"
Personal tools