Portal

<back to all web services

BrowseAllUser

Requires Authentication
Required role:VeoliaAdmin
The following routes are available for this service:
POST/user
import Foundation
import ServiceStack

public class BrowseAllUser : PaginationRequestBase, IPost
{
    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 PaginationRequestBase : IGridView, Codable
{
    public var gridViewState:GridViewState

    required public init(){}
}

public class GridViewState : Codable
{
    public var columnState:GridViewColumnState
    public var columnFilters:[GridViewColumnFilter] = []
    public var pagerState:GridViewPagerState
    public var isReturnCount:Bool

    required public init(){}
}

public class GridViewColumnState : Codable
{
    public var fieldName:String
    public var sortDirection:GridSortDirection

    required public init(){}
}

public enum GridSortDirection : Int, Codable
{
    case None = 0
    case Asc = 1
    case Desc = 2
}

public class GridViewColumnFilter : Codable
{
    public var fieldName:String
    public var filterValue:String
    public var `operator`:FilterOperator

    required public init(){}
}

public enum FilterOperator : Int, Codable
{
    case NotSet = 0
    case Equal = 1
    case Greater = 2
    case Less = 3
    case GreaterOrEqual = 4
    case LessOrEqual = 5
    case NotEqual = 6
    case IsNull = 7
    case IsNotNull = 8
    case Like = 9
    case NotLike = 10
    case Begins = 11
    case Ends = 12
    case In = 13
    case Between = 14
}

public class GridViewPagerState : Codable
{
    public var skipRowCount:Int
    public var pageRowCount:Int

    required public init(){}
}

public class PaginationResponse<TenderSimple : Codable> : ResponseBase
{
    public var result:PaginationResult<TenderSimple>

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

    private enum CodingKeys : String, CodingKey {
        case result
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        result = try container.decodeIfPresent(PaginationResult<TenderSimple>.self, forKey: .result)
    }

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

public class ResponseBase : Codable
{
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class PaginationResult<TModel : Codable> : Codable
{
    public var totalRowCount:Int
    public var items:[TModel] = []

    required public init(){}
}

public class TenderSimple : Codable
{
    public var tenderId:Int
    public var tenderIdentifier:String
    public var procedureType:ProcedureType
    public var subject:String
    public var tenderRoundName:String
    public var sectionName:String
    public var deadline:Date?
    public var tenderType:TenderType
    public var tenderStatus:TenderStatus
    public var isUnderPublish:Bool
    public var publishStartDateTime:Date?
    public var publishEndDateTime:Date?
    public var publishedById:Int?
    public var isProcurementEnabled:Bool
    public var isComplianceEnabled:Bool

    required public init(){}
}

public enum ProcedureType : Int, Codable
{
    case Competition = 0
    case Simplified = 1
}

public enum TenderType : Int, Codable
{
    case Private = 0
    case Public = 1
}

public enum TenderStatus : Int, Codable
{
    case FirstRound = 0
    case SecondRound = 1
    case ThirdRound = 2
    case Successful = 3
    case UnSuccessful = 4
    case Revoked = 5
}


Swift BrowseAllUser 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 /user HTTP/1.1 
Host: szallitoiportal-be.veolia.hu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BrowseAllUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Portal.ServiceDto">
  <GridViewState xmlns:d2p1="http://schemas.datacontract.org/2004/07/Portal.Common">
    <d2p1:ColumnFilters>
      <d2p1:GridViewColumnFilter>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:FilterValue>String</d2p1:FilterValue>
        <d2p1:Operator>NotSet</d2p1:Operator>
      </d2p1:GridViewColumnFilter>
    </d2p1:ColumnFilters>
    <d2p1:ColumnState>
      <d2p1:FieldName>String</d2p1:FieldName>
      <d2p1:SortDirection>None</d2p1:SortDirection>
    </d2p1:ColumnState>
    <d2p1:IsReturnCount>false</d2p1:IsReturnCount>
    <d2p1:PagerState>
      <d2p1:PageRowCount>0</d2p1:PageRowCount>
      <d2p1:SkipRowCount>0</d2p1:SkipRowCount>
    </d2p1:PagerState>
  </GridViewState>
</BrowseAllUser>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaginationResponseOfUserSimpleSupplierSimplesQn7QJ6w xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Portal.ServiceDto">
  <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>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/Portal.Common">
    <d2p1:Items>
      <UserSimpleSupplierSimple>
        <DisplayName>String</DisplayName>
        <Email>String</Email>
        <Id>0</Id>
        <MobilePhoneNumber>String</MobilePhoneNumber>
        <MobilePhoneNumberCountryCode>String</MobilePhoneNumberCountryCode>
        <OrganizationUnit>String</OrganizationUnit>
        <PhoneNumber>String</PhoneNumber>
        <PhoneNumberCountryCode>String</PhoneNumberCountryCode>
        <PhoneNumberExtension>String</PhoneNumberExtension>
        <Position>String</Position>
        <Role>String</Role>
        <Status>Registered</Status>
        <SupplierName>String</SupplierName>
        <SupplierShortName>String</SupplierShortName>
        <VatNumber>String</VatNumber>
      </UserSimpleSupplierSimple>
    </d2p1:Items>
    <d2p1:TotalRowCount>0</d2p1:TotalRowCount>
  </Result>
</PaginationResponseOfUserSimpleSupplierSimplesQn7QJ6w>