Requires the role: | manager |
PUT,PATCH | /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 PutPatchOperationUnTenanted(Of TResponse)
Implements IPatch
Implements IPut
End Class
End Namespace
Namespace Infrastructure.Api.Interfaces.ServiceOperations.Persons
Public Partial Class UpdatePersonRequest
Inherits PutPatchOperationUnTenanted(Of UpdatePersonResponse)
Public Overridable Property Id As String
Public Overridable Property PhoneNumber As String
Public Overridable Property Timezone As String
End Class
Public Partial Class UpdatePersonResponse
Public Overridable Property ResponseStatus As ResponseStatus
Public Overridable Property Person As Person
End Class
End Namespace
End Namespace
VB.NET UpdatePersonRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /persons/{Id} HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdatePersonRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Persons">
<Id>String</Id>
<PhoneNumber>String</PhoneNumber>
<Timezone>String</Timezone>
</UpdatePersonRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <UpdatePersonResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Persons"> <Person xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources"> <d2p1:DefaultOrganisationId>String</d2p1:DefaultOrganisationId> <d2p1:DisplayName>String</d2p1:DisplayName> <d2p1:Email>String</d2p1:Email> <d2p1:Id>String</d2p1:Id> <d2p1:Name> <d2p1:FirstName>String</d2p1:FirstName> <d2p1:LastName>String</d2p1:LastName> </d2p1:Name> <d2p1:PhoneNumber>String</d2p1:PhoneNumber> <d2p1:Timezone>String</d2p1:Timezone> </Person> <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> </UpdatePersonResponse>