tvpl.api

<back to all web services

GetHeadTTPC

Requires Authentication
The following routes are available for this service:
GET/users/head-of-ttpc
import Foundation
import ServiceStack

public class GetHeadTTPC : Codable
{
    required public init(){}
}

public class AllUserResponse : Codable
{
    public var users:[UserProfile] = []
    public var code:Int
    public var message:String
    public var totalCount:Int

    required public init(){}
}

public class UserProfile : UserLogin
{
    public var id:Int
    public var fullName:String
    public var email:String
    public var departmentId:Int?
    public var partyGroupId:Int?
    public var avatar:String
    public var telephone:String
    public var birthday:Date?
    public var createdAt:Date?
    public var updatedAt:Date?
    public var failedLoginCount:Int
    // @Ignore()
    public var roles:[Int] = []

    public var lastLoginDate:Date?

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

    private enum CodingKeys : String, CodingKey {
        case id
        case fullName
        case email
        case departmentId
        case partyGroupId
        case avatar
        case telephone
        case birthday
        case createdAt
        case updatedAt
        case failedLoginCount
        case roles
        case lastLoginDate
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        fullName = try container.decodeIfPresent(String.self, forKey: .fullName)
        email = try container.decodeIfPresent(String.self, forKey: .email)
        departmentId = try container.decodeIfPresent(Int.self, forKey: .departmentId)
        partyGroupId = try container.decodeIfPresent(Int.self, forKey: .partyGroupId)
        avatar = try container.decodeIfPresent(String.self, forKey: .avatar)
        telephone = try container.decodeIfPresent(String.self, forKey: .telephone)
        birthday = try container.decodeIfPresent(Date.self, forKey: .birthday)
        createdAt = try container.decodeIfPresent(Date.self, forKey: .createdAt)
        updatedAt = try container.decodeIfPresent(Date.self, forKey: .updatedAt)
        failedLoginCount = try container.decodeIfPresent(Int.self, forKey: .failedLoginCount)
        roles = try container.decodeIfPresent([Int].self, forKey: .roles) ?? []
        lastLoginDate = try container.decodeIfPresent(Date.self, forKey: .lastLoginDate)
    }

    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 fullName != nil { try container.encode(fullName, forKey: .fullName) }
        if email != nil { try container.encode(email, forKey: .email) }
        if departmentId != nil { try container.encode(departmentId, forKey: .departmentId) }
        if partyGroupId != nil { try container.encode(partyGroupId, forKey: .partyGroupId) }
        if avatar != nil { try container.encode(avatar, forKey: .avatar) }
        if telephone != nil { try container.encode(telephone, forKey: .telephone) }
        if birthday != nil { try container.encode(birthday, forKey: .birthday) }
        if createdAt != nil { try container.encode(createdAt, forKey: .createdAt) }
        if updatedAt != nil { try container.encode(updatedAt, forKey: .updatedAt) }
        if failedLoginCount != nil { try container.encode(failedLoginCount, forKey: .failedLoginCount) }
        if roles.count > 0 { try container.encode(roles, forKey: .roles) }
        if lastLoginDate != nil { try container.encode(lastLoginDate, forKey: .lastLoginDate) }
    }
}

public class UserLogin : Codable
{
    // @Required()
    public var name:String?

    required public init(){}
}


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

GET /users/head-of-ttpc HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AllUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <Message>String</Message>
  <TotalCount>0</TotalCount>
  <Users xmlns:d2p1="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:UserProfile>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Password>String</d2p1:Password>
      <d2p1:Avatar>String</d2p1:Avatar>
      <d2p1:Birthday>0001-01-01T00:00:00</d2p1:Birthday>
      <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
      <d2p1:CreatedBy>String</d2p1:CreatedBy>
      <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
      <d2p1:DeletedBy>String</d2p1:DeletedBy>
      <d2p1:DepartmentId>0</d2p1:DepartmentId>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:FailedLoginCount>0</d2p1:FailedLoginCount>
      <d2p1:FullName>String</d2p1:FullName>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsDeleted>false</d2p1:IsDeleted>
      <d2p1:LastLoginDate>0001-01-01T00:00:00</d2p1:LastLoginDate>
      <d2p1:PartyGroupId>0</d2p1:PartyGroupId>
      <d2p1:Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d2p1:Roles>
      <d2p1:Telephone>String</d2p1:Telephone>
      <d2p1:UpdatedAt>0001-01-01T00:00:00</d2p1:UpdatedAt>
      <d2p1:UpdatedBy>String</d2p1:UpdatedBy>
    </d2p1:UserProfile>
  </Users>
</AllUserResponse>