StarterTemplate ASP.NET Host

<back to all web services

Users

The following routes are available for this service:
All Verbs/api/users/{UserIds}
Users Parameters:
NameParameterData TypeRequiredDescription
UserIdspathint[]No
UsersResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<UserInfo>No
ResponseStatusformResponseStatusNo
UserInfo Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UserNameformstringNo
DisplayNameformstringNo
TwitterUserIdformstringNo
TwitterScreenNameformstringNo
FacebookUserIdformstringNo
ProfileImageUrl64formstringNo

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 /xml/reply/Users HTTP/1.1 
Host: bootstrapapi.servicestack.net 
Content-Type: application/xml
Content-Length: length

<Users xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SocialBootstrapApi.ServiceInterface">
  <UserIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </UserIds>
</Users>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UsersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SocialBootstrapApi.ServiceInterface">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Results>
    <UserInfo>
      <DisplayName>String</DisplayName>
      <FacebookUserId>String</FacebookUserId>
      <Id>0</Id>
      <ProfileImageUrl64>String</ProfileImageUrl64>
      <TwitterScreenName>String</TwitterScreenName>
      <TwitterUserId>String</TwitterUserId>
      <UserName>String</UserName>
    </UserInfo>
  </Results>
</UsersResponse>