Cochrane+ App API

<back to all web services

GetUsersRatings

import Foundation
import ServiceStack

public class GetUsersRatings : ApiServiceRequest
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo, Codable
{
    /**
    * The API Key required for authentication
    */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public var apiKey:String

    /**
    * Latitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    public var latitude:Double

    /**
    * Longitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public var longitude:Double

    required public init(){}
}

public class GetRatingSubmissionsResponse : ApiServiceResponse
{
    public var ratingSubmissions:[RatingSubmissionListItem] = []

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

    private enum CodingKeys : String, CodingKey {
        case ratingSubmissions
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        ratingSubmissions = try container.decodeIfPresent([RatingSubmissionListItem].self, forKey: .ratingSubmissions) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if ratingSubmissions.count > 0 { try container.encode(ratingSubmissions, forKey: .ratingSubmissions) }
    }
}

public class ApiServiceResponse : IServiceResponse, Codable
{
    public var Description:String
    public var heading:String
    public var wasSuccessful:Bool
    //modelState:Object ignored. Type could not be extended in Swift

    required public init(){}
}

public class RatingSubmissionListItem : Codable
{
    public var id:Int
    public var profileImage:String
    public var templateName:String
    public var username:String
    public var value:Int
    public var comments:String
    public var dateRated:Date

    required public init(){}
}

Swift GetUsersRatings DTOs

GET /internalrating/getusersratings HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/xml

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

<GetRatingSubmissionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
  <ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
  <RatingSubmissions>
    <RatingSubmissionListItem>
      <Comments>String</Comments>
      <DateRated>0001-01-01T00:00:00</DateRated>
      <Id>0</Id>
      <ProfileImage>String</ProfileImage>
      <TemplateName>String</TemplateName>
      <Username>String</Username>
      <Value>0</Value>
    </RatingSubmissionListItem>
  </RatingSubmissions>
</GetRatingSubmissionsResponse>