Agent

Agent

  • Descriptions

    Working with Agent

  • Action Allowed (Demo)
    /app/Agents/Folder/{folderCode}
    Method : GET
    Summary : Get all Agent in specific folder
    Parameters :
    NameDescriptionData TypeParameterTypeRequired
    folderCodefolder Code to accessStringpath
    pagepage numberInt32query
    pageSizenumber of record in one pageInt32query
    maxLevellevel data will be returnedInt32query
    isShowIdresult will contain Id info or notBooleanquery
    statestate of object, this parameter is only effected if client using ApisResultStatequery
    ContinuePathparameter for chunking datastringheader
    /app/Agent/{id}/Folder/{folderCode}
    Method : GET
    Summary : Get Agent by Id
    Parameters :
    NameDescriptionData TypeParameterTypeRequired
    idid of AgentGuidpath
    folderCodefolder to accessStringpath
    maxLevellevel for getting dataInt32query
    isShowIddata return include id or notBooleanquery
    statestate of object, this parameter only effect when client using Winbooks.DALResultStatequery
    ContinuePathparameter for chunking datastringheader
    /app/Agent/{code}/Folder/{folderCode}
    Method : GET
    Summary : Get Agent by code
    Parameters :
    NameDescriptionData TypeParameterTypeRequired
    codeStringpath
    folderCodefolder to accessStringpath
    maxLevellevel for getting dataInt32query
    isShowIddata return include id or notBooleanquery
    statestate of object, this parameter only effect when client using Winbooks.DALResultStatequery
    ContinuePathparameter for chunking datastringheader
    /app/Agent/{code}/Folder/{FolderCode}
    Method : POST
    Summary : Insert single Agent in json format
    Parameters :
    NameDescriptionData TypeParameterTypeRequired
    agentAgent object in json stringAgentbody
    codecode or id of addressStringpath
    FolderCodefolder to access dataStringpath
    ContinuePathparameter for chunking datastringheader
    /app/Agent/{code}/Folder/{folderCode}
    Method : PUT
    Summary : Update an existing agent with code or id
    Parameters :
    NameDescriptionData TypeParameterTypeRequired
    agentagent will be updatedAgentbody
    codecode or id of address will be updatedStringpath
    folderCodefolder to access dataStringpath
    ContinuePathparameter for chunking datastringheader
    /app/Agents/Folder/{folderCode}
    Method : PUT
    Summary : update a list agent
    Parameters :
    NameDescriptionData TypeParameterTypeRequired
    lstagentList agent will be updatedList`1body
    folderCodefolder to access dataStringpath
    ContinuePathparameter for chunking datastringheader
    /app/Agents/Folder/{folderCode}
    Method : POST
    Summary : Insert a list agent
    Parameters :
    NameDescriptionData TypeParameterTypeRequired
    lstagentlist address will be insertedList`1body
    folderCodefolder to access dataStringpath
    ContinuePathparameter for chunking datastringheader
    /app/Agents/Folder/{FolderCode}
    Method : DELETE
    Summary : Delete list agent
    Parameters :
    NameDescriptionData TypeParameterTypeRequired
    FolderCodefolder to access dataStringpath
    codelist code or id of address to deleteStringpath
    ContinuePathparameter for chunking datastringheader
    /app/Agents/Folder/{folderCode}/ExecuteCriteria
    Method : POST
    Summary : Getting a list agent which match given criteria
    Parameters :
    NameDescriptionData TypeParameterTypeRequired
    criteriaStringcriteria for matching conditionCustomCriteriaExecute`1body
    folderCodefolder to access dataStringpath
    pagepage numberInt32query
    pageSizenumber of record in one pageInt32query
    maxLevellevel for getting dataInt32query
    isShowIddata return should include id or notBooleanquery
    statestate of object, this parameter only effect when client using Winbooks.DALResultStatequery
    ContinuePathparameter for chunking datastringheader
    /app/Agents/Folder/{folderCode}/DeleteByCriteria
    Method : POST
    Summary : Delete a list agent which match given criteria
    Parameters :
    NameDescriptionData TypeParameterTypeRequired
    criteriaStringcriteria conditionCustomCriteriaExecute`1body
    folderCodefolder to access dataStringpath
    ContinuePathparameter for chunking datastringheader
  • Fields
    Agent
    Version : Int32
    Modified : DateTime
    ModifiedBy : Guid
    Created : DateTime
    CreatedBy : Guid
    Folder_Id : Guid
    Contact_Id : Guid (Required)
    Code : String (Required)
    ComissionRate : Decimal
    IsLocked : Boolean
    IsHidden : Boolean
    MemoType : MemoType
    Memo : String
    Folder : Folder
    Contact : Contact
    Id : Guid
    Localized : Dictionary[String, Dictionary[String, String]]
    Custom : Dictionary[String, Object]
    UpdatedProperties : String[]
    UpdatedValues : Object[]
    Enum :MemoType
    None
    Green
    Yellow
    Red
  • Example : read (Demo)
    {
      "$type": "Winbooks.TORM.OM.Logistics.Agent, Winbooks.TORM.OM",
      "TotalLevel": 1,
      "Version": 0,
      "Modified": null,
      "ModifiedBy": "00000000-0000-0000-0000-000000000000",
      "Created": null,
      "CreatedBy": "00000000-0000-0000-0000-000000000000",
      "Folder_Id": "00000000-0000-0000-0000-000000000000",
      "Contact_Id": "00000000-0000-0000-0000-000000000000",
      "Code": null,
      "ComissionRate": 0.0,
      "IsLocked": false,
      "IsHidden": false,
      "MemoType": 0,
      "Memo": null,
      "Id": "00000000-0000-0000-0000-000000000000",
      "ResultState": 0,
      "ActionState": 0,
      "CachedCollection": {},
      "IsBinding": false,
      "IsSpecifiedId": false,
      "IsDirty": false,
      "UpdatedEntities": {},
      "Localized": {},
      "CustomId": "00000000-0000-0000-0000-000000000000",
      "Custom": {},
      "UpdatedProperties": [],
      "UpdatedValues": []
    }
Top