AlbaApi

<back to all web services

UserConsentPostReq

The following routes are available for this service:
POST/userconsent
import Foundation
import ServiceStack

public class UserConsentPostReq : Codable
{
    public var userId:String?
    public var consent:Consent?

    required public init(){}
}

public class Consent : Entity
{
    public var consentDefinitionId:String?
    public var consents:[String:Bool] = [:]
    public var consentedDate:Date?
    public var lang:String?
    public var consented:Bool?
    public var expired:Bool?

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

    private enum CodingKeys : String, CodingKey {
        case consentDefinitionId
        case consents
        case consentedDate
        case lang
        case consented
        case expired
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        consentDefinitionId = try container.decodeIfPresent(String.self, forKey: .consentDefinitionId)
        consents = try container.decodeIfPresent([String:Bool].self, forKey: .consents) ?? [:]
        consentedDate = try container.decodeIfPresent(Date.self, forKey: .consentedDate)
        lang = try container.decodeIfPresent(String.self, forKey: .lang)
        consented = try container.decodeIfPresent(Bool.self, forKey: .consented)
        expired = try container.decodeIfPresent(Bool.self, forKey: .expired)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if consentDefinitionId != nil { try container.encode(consentDefinitionId, forKey: .consentDefinitionId) }
        if consents.count > 0 { try container.encode(consents, forKey: .consents) }
        if consentedDate != nil { try container.encode(consentedDate, forKey: .consentedDate) }
        if lang != nil { try container.encode(lang, forKey: .lang) }
        if consented != nil { try container.encode(consented, forKey: .consented) }
        if expired != nil { try container.encode(expired, forKey: .expired) }
    }
}

public class Entity : IEntity, Codable
{
    public var id:String?

    required public init(){}
}


Swift UserConsentPostReq 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.

POST /userconsent HTTP/1.1 
Host: hcbtas-q-albamfs-api.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UserConsentPostReq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.ServiceModel">
  <Consent xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlbaApi.Model">
    <Id xmlns="http://schemas.datacontract.org/2004/07/TasSyd.Model.Base">String</Id>
    <d2p1:ConsentDefinitionId>String</d2p1:ConsentDefinitionId>
    <d2p1:ConsentedDate>0001-01-01T00:00:00</d2p1:ConsentedDate>
    <d2p1:Consents xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringboolean>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>false</d3p1:Value>
      </d3p1:KeyValueOfstringboolean>
    </d2p1:Consents>
    <d2p1:Lang>String</d2p1:Lang>
  </Consent>
  <UserId>String</UserId>
</UserConsentPostReq>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Consent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.Model">
  <Id xmlns="http://schemas.datacontract.org/2004/07/TasSyd.Model.Base">String</Id>
  <ConsentDefinitionId>String</ConsentDefinitionId>
  <ConsentedDate>0001-01-01T00:00:00</ConsentedDate>
  <Consents xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringboolean>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>false</d2p1:Value>
    </d2p1:KeyValueOfstringboolean>
  </Consents>
  <Lang>String</Lang>
</Consent>