Platform API

<back to all web services

UpdateRoleStatus

Archives or Restores a Role record.

Requires Authentication
The following routes are available for this service:
PUT/api/role/{ContactRoleId}/archive
PUT/api/role/{ContactRoleId}/restore
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>
        '''Archives or Restores a Role record.
        '''</Summary>
        <Api(Description:="Archives or Restores a Role record.")>
        Public Partial Class UpdateRoleStatus
            '''<Summary>
            '''Id of the Contact Role record to be Archived or Restored.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Id of the Contact Role record to be Archived or Restored.", IsRequired:=true, Name:="ContactRoleId", ParameterType:="query")>
            Public Overridable Property ContactRoleId As Guid
        End Class
    End Namespace
End Namespace

VB.NET UpdateRoleStatus 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.

PUT /api/role/{ContactRoleId}/archive HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateRoleStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactRoleId>00000000-0000-0000-0000-000000000000</ContactRoleId>
</UpdateRoleStatus>

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

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <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>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>