Platform API

AddUserProfile

Add a Users Profile information'

The following routes are available for this service:
POST	/api/profiles

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Add a Users Profile information'
    */
    @Api(Description="Add a Users Profile information'")
    public static class AddUserProfile
    {
        public ArrayList<UUID> UserIds = null;
        public ArrayList<UUID> ContactIds = null;
        public UUID ProfileToShareId = null;
        
        public ArrayList<UUID> getUserIds() { return UserIds; }
        public AddUserProfile setUserIds(ArrayList<UUID> value) { this.UserIds = value; return this; }
        public ArrayList<UUID> getContactIds() { return ContactIds; }
        public AddUserProfile setContactIds(ArrayList<UUID> value) { this.ContactIds = value; return this; }
        public UUID getProfileToShareId() { return ProfileToShareId; }
        public AddUserProfile setProfileToShareId(UUID value) { this.ProfileToShareId = value; return this; }
    }

    public static class AddUserProfileResponse
    {
        public ArrayList<ResponseError> Errors = null;
        /**
        * Guid representing the object that is the User Profile Id in Eros.
        */
        @ApiMember(DataType="Guid", Description="Guid representing the object that is the User Profile Id in Eros.", Name="UserProfileId", ParameterType="query")
        public UUID ProfileToShareId = null;

        /**
        * Service Stack Response Status.
        */
        @ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<ResponseError> getErrors() { return Errors; }
        public AddUserProfileResponse setErrors(ArrayList<ResponseError> value) { this.Errors = value; return this; }
        public UUID getProfileToShareId() { return ProfileToShareId; }
        public AddUserProfileResponse setProfileToShareId(UUID value) { this.ProfileToShareId = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public AddUserProfileResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java AddUserProfile DTOs

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 /api/profiles HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddUserProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </ContactIds>
  <ProfileToShareId>00000000-0000-0000-0000-000000000000</ProfileToShareId>
  <UserIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </UserIds>
</AddUserProfile>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddUserProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Errors xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ResponseError>
      <d2p1:ErrorCode>String</d2p1:ErrorCode>
      <d2p1:FieldName>String</d2p1:FieldName>
      <d2p1:Message>String</d2p1:Message>
      <d2p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d2p1:Meta>
    </d2p1:ResponseError>
  </Errors>
  <ProfileToShareId>00000000-0000-0000-0000-000000000000</ProfileToShareId>
  <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>
</AddUserProfileResponse>