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

From BBSWiki

[edit] Login, logout and account creation

[edit] LoginRequest

<LoginRequest>
  <User>
    <Username>..</Username>
    <Password>..</Password>
  </User>
</LoginRequest>

[edit] LogoutRequest

<LogoutRequest></LogoutRequest>

[edit] NewUserCheckRequest

<NewUserCheckRequest>
  <User>
    <Username>..</Username>
  </User>
</NewUserCheckRequest>

[edit] NewUserPasswordCheckRequest

Checks the password in case account creation is passworded.

<NewUserPasswordCheckRequest>
  <AccountCreationPassword>..</AccountCreationPassword>
</NewUserPasswordCheckRequest>

[edit] NewUserCreateRequest

Any of the profile info fields may be omitted except the mandatory ones as specified by the server in NewUserCheckResponse.

<NewUserCreateRequest>
  <User>
    <Username>...</Username>
    <Password>...</Password>
    <RealName>...</RealName>
    <Address>...</Address>
    <City>...</City>
    <StateProvince>...</StateProvince>
    <PostCode>...</PostCode>
    <Phone>...</Phone>
    <Email>...</Email>
  </User>
</NewUserCreateRequest>

[edit] User functions

[edit] UserHideProfileFieldsRequest

Hide any of RealName, Address, City, StateProvince, PostCode, Phone, Email.

<UserHideProfileFieldsRequest>
  <HideField>...</HideField>
  <HideField>...</HideField>
</UserHideProfileFieldsRequest>

[edit] UserChangeProfileTextRequest

<UserChangeProfileTextRequest>
  <User>
    <ProfileText>
    ...
    </ProfileText>
  </User>
</UserChangeProfileTextRequest>

[edit] UserProfileRequest

Either by name or by number.

<UserProfileRequest>
  <User>
    <Username>...</Username>
    <UserNumber>...</UserNumber>
  </User>
</UserProfileRequest>

[edit] UserStatusRequest

Request online/offline status and status flags, either by name or by number.

<UserStatusRequest>
  <User>
    <Username>...</Username>
    <UserNumber>...</UserNumber>
  </User>
</UserStatusRequest>

[edit] Room functions

[edit] RoomDetailsRequest

Gets everything but roominfo.

<RoomDetailsRequest>
  <Room>
    <RoomNumber>...</RoomNumber>
  </Room>
</RoomDetailsRequest>

[edit] Message functions

[edit] MessageHeadersInRangeRequest

Download all message headers in a range in a particular room. No delivery order guaranteed. Client should sort.

<MessageHeadersInRangeRequest>
  <Room>
    <RoomNumber>...</RoomNumber>
  </Room>
  <RoomMessageNumberRequestRange>
    <Start>...</Start>
    <End>...</End>
  </RoomMessageNumberRequestRange>
</MessageHeadersInRangeRequest>

[edit] MessageBodyByGlobalRequest

<MessageBodyByGlobalRequest>
  <GlobalMessageNumber>...</GlobalMessageNumber>
</MessageBodyByGlobalRequest>

[edit] PostMessageRequest

<PostMessageRequest>
  <Room>
    <RoomNumber>...</RoomNumber>
  </Room>
  <MessageBody>
  ...
  </MessageBody>
</PostMessageRequest>

[edit] eXpress and Wholist functions

[edit] WholistRequest

Data not returned in any order. Client should sort.

<WholistRequest></WholistRequest>

[edit] SendeXpressRequest

By user name or number.

<SendeXpressRequest>
  <User>
  ...
  </User>
  <eXpressText>
  ...
  </eXpressText>
</SendeXpressRequest>