Platform API

<back to all web services

AddUserProfile

Add a Users Profile information'

Requires Authentication
The following routes are available for this service:
POST/api/profiles
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel

Namespace Global

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Add a Users Profile information'
        '''</Summary>
        <Api(Description:="Add a Users Profile information'")>
        Public Partial Class AddUserProfile
            Public Overridable Property UserIds As List(Of Guid)
            Public Overridable Property ContactIds As List(Of Guid)
            Public Overridable Property ProfileToShareId As Guid
        End Class

        Public Partial Class AddUserProfileResponse
            Public Overridable Property Errors As List(Of ResponseError)
            '''<Summary>
            '''Guid representing the object that is the User Profile Id in Eros.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Guid representing the object that is the User Profile Id in Eros.", Name:="UserProfileId", ParameterType:="query")>
            Public Overridable Property ProfileToShareId As Guid

            '''<Summary>
            '''Service Stack Response Status.
            '''</Summary>
            <ApiMember(DataType:="ResponseStatus", Description:="Service Stack Response Status.", Name:="ResponseStatus", ParameterType:="query")>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET AddUserProfile DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"UserIds":["00000000-0000-0000-0000-000000000000"],"ContactIds":["00000000-0000-0000-0000-000000000000"],"ProfileToShareId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"ProfileToShareId":"00000000-0000-0000-0000-000000000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}