Billiecart API

<back to all web services

GetPersonRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
GET/persons/{Id}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Infrastructure.Api.Interfaces.ServiceOperations.Persons
Imports Infrastructure.Api.Interfaces.ServiceOperations
Imports Application.Interfaces.Resources

Namespace Global

    Namespace Application.Interfaces.Resources

        Public Partial Class Person
            Implements IIdentifiableResource
            Public Overridable Property Name As UserAccountName
            Public Overridable Property DisplayName As String
            Public Overridable Property Email As String
            Public Overridable Property PhoneNumber As String
            Public Overridable Property Timezone As String
            Public Overridable Property DefaultOrganisationId As String
            Public Overridable Property Id As String
        End Class

        Public Partial Class UserAccountName
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations

        Public Partial Class GetOperationUnTenanted(Of TResponse)
            Implements IHasGetOptions
            Implements IGet
            Public Overridable Property Embed As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations.Persons

        Public Partial Class GetPersonRequest
            Inherits GetOperationUnTenanted(Of GetPersonResponse)
            Public Overridable Property Id As String
        End Class

        Public Partial Class GetPersonResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Person As Person
        End Class
    End Namespace
End Namespace

VB.NET GetPersonRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /persons/{Id} HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"person":{"name":{"firstName":"String","lastName":"String"},"displayName":"String","email":"String","phoneNumber":"String","timezone":"String","defaultOrganisationId":"String","id":"String"}}