Foundry API

<back to all web services

UpdateProfileRequest

import Foundation
import ServiceStack

public class UpdateProfileRequest : PutPatchOperationUnTenanted<UpdateProfileResponse>
{
    public var id:String?
    public var firstName:String?
    public var lastName:String?
    public var displayName:String?
    public var phoneNumber:String?
    public var timezone:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case id
        case firstName
        case lastName
        case displayName
        case phoneNumber
        case timezone
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(String.self, forKey: .id)
        firstName = try container.decodeIfPresent(String.self, forKey: .firstName)
        lastName = try container.decodeIfPresent(String.self, forKey: .lastName)
        displayName = try container.decodeIfPresent(String.self, forKey: .displayName)
        phoneNumber = try container.decodeIfPresent(String.self, forKey: .phoneNumber)
        timezone = try container.decodeIfPresent(String.self, forKey: .timezone)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if firstName != nil { try container.encode(firstName, forKey: .firstName) }
        if lastName != nil { try container.encode(lastName, forKey: .lastName) }
        if displayName != nil { try container.encode(displayName, forKey: .displayName) }
        if phoneNumber != nil { try container.encode(phoneNumber, forKey: .phoneNumber) }
        if timezone != nil { try container.encode(timezone, forKey: .timezone) }
    }
}

public class PutPatchOperationUnTenanted<TResponse : Codable> : IPatch, IPut, Codable
{
    required public init(){}
}

public class UpdateProfileResponse : Codable
{
    public var responseStatus:ResponseStatus?
    public var profile:Profile?

    required public init(){}
}

public class Profile : ProfileBasic
{
    public var defaultOrganisationId:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case defaultOrganisationId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        defaultOrganisationId = try container.decodeIfPresent(String.self, forKey: .defaultOrganisationId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if defaultOrganisationId != nil { try container.encode(defaultOrganisationId, forKey: .defaultOrganisationId) }
    }
}

public class ProfileBasic : IIdentifiableResource, Codable
{
    public var name:PersonName?
    public var displayName:String?
    public var emailAddress:String?
    public var phoneNumber:String?
    public var timezone:String?
    public var id:String?

    required public init(){}
}

public class PersonName : Codable
{
    public var firstName:String?
    public var lastName:String?

    required public init(){}
}

Swift UpdateProfileRequest DTOs

PUT /profile/{Id} HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateProfileRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Profile">
  <DisplayName>String</DisplayName>
  <FirstName>String</FirstName>
  <Id>String</Id>
  <LastName>String</LastName>
  <PhoneNumber>String</PhoneNumber>
  <Timezone>String</Timezone>
</UpdateProfileRequest>

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

<UpdateProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Profile">
  <Profile xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:DisplayName>String</d2p1:DisplayName>
    <d2p1:EmailAddress>String</d2p1:EmailAddress>
    <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>
    <d2p1:DefaultOrganisationId>String</d2p1:DefaultOrganisationId>
  </Profile>
  <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>
</UpdateProfileResponse>