Address

Address

  • Descriptions

    Working with Address

  • Action Allowed (Demo)
    /app/Addresss/Folder/{folderCode}
    Method : GET
    Summary : Documentation for 'GetAllAddress'.
    Parameters :
    NameDescriptionData TypeParameterTypeRequired
    folderCodeDocumentation for 'folderCode'.Stringpath
    pageDocumentation for 'page'.Int32query
    pageSizeDocumentation for 'pageSize'.Int32query
    maxLevelDocumentation for 'maxLevel'.Int32query
    isShowIdDocumentation for 'isShowId'.Booleanquery
    stateDocumentation for 'state'.ResultStatequery
    ContinuePathparameter for chunking datastringheader
    /app/Address/{id}/Folder/{folderCode}
    Method : GET
    Summary : Documentation for 'GetAddressById'.
    Parameters :
    NameDescriptionData TypeParameterTypeRequired
    idDocumentation for 'id'.Guidpath
    folderCodeDocumentation for 'folderCode'.Stringpath
    maxLevelDocumentation for 'maxLevel'.Int32query
    isShowIdDocumentation for 'isShowId'.Booleanquery
    stateDocumentation for 'state'.ResultStatequery
    ContinuePathparameter for chunking datastringheader
    /app/Address/Folder/{FolderCode}
    Method : POST
    Summary : Documentation for 'Insert'.
    Parameters :
    NameDescriptionData TypeParameterTypeRequired
    addressDocumentation for 'address'.Addressbody
    FolderCodeDocumentation for 'FolderCode'.Stringpath
    ContinuePathparameter for chunking datastringheader
    /app/Address/Folder/{FolderCode}
    Method : PUT
    Summary : Documentation for 'Update'.
    Parameters :
    NameDescriptionData TypeParameterTypeRequired
    addressDocumentation for 'address'.Addressbody
    FolderCodeDocumentation for 'FolderCode'.Stringpath
    ContinuePathparameter for chunking datastringheader
    /app/Addresss/Folder/{FolderCode}
    Method : PUT
    Summary : Documentation for 'UpdateList'.
    Parameters :
    NameDescriptionData TypeParameterTypeRequired
    lstaddressDocumentation for 'lstaddress'.List`1body
    FolderCodeDocumentation for 'FolderCode'.Stringpath
    ContinuePathparameter for chunking datastringheader
    /app/Addresss/Folder/{folderCode}
    Method : POST
    Summary : Documentation for 'InsertList'.
    Parameters :
    NameDescriptionData TypeParameterTypeRequired
    lstaddressDocumentation for 'lstaddress'.List`1body
    folderCodeDocumentation for 'folderCode'.Stringpath
    ContinuePathparameter for chunking datastringheader
    /app/Addresss/Folder/{FolderCode}
    Method : DELETE
    Summary : Documentation for 'DeleteList'.
    Parameters :
    NameDescriptionData TypeParameterTypeRequired
    FolderCodeDocumentation for 'FolderCode'.Stringpath
    codeDocumentation for 'code'.Stringpath
    ContinuePathparameter for chunking datastringheader
    /app/Addresss/Folder/{folderCode}/ExecuteCriteria
    Method : POST
    Summary : Documentation for 'GetByCriteria'.
    Parameters :
    NameDescriptionData TypeParameterTypeRequired
    criteriaStringDocumentation for 'criteriaString'.CustomCriteriaExecute`1body
    folderCodeDocumentation for 'folderCode'.Stringpath
    pageDocumentation for 'page'.Int32query
    pageSizeDocumentation for 'pageSize'.Int32query
    maxLevelDocumentation for 'maxLevel'.Int32query
    isShowIdDocumentation for 'isShowId'.Booleanquery
    stateDocumentation for 'state'.ResultStatequery
    ContinuePathparameter for chunking datastringheader
    /app/Addresss/Folder/{folderCode}/DeleteByCriteria
    Method : POST
    Summary : Documentation for 'DeleteByCriteria'.
    Parameters :
    NameDescriptionData TypeParameterTypeRequired
    criteriaStringDocumentation for 'criteriaString'.CustomCriteriaExecute`1body
    folderCodeDocumentation for 'folderCode'.Stringpath
    ContinuePathparameter for chunking datastringheader
  • Fields
    Address
    Version : Int32
    Modified : DateTime
    ModifiedBy : Guid
    Created : DateTime
    CreatedBy : Guid
    Folder_Id : Guid
    Third_Id : Guid
    Country_Id : Guid
    Index : Int32
    Address1 : String
    Address2 : String
    Town : String
    Zip : String
    Name : String
    Number : String
    Box : String
    PhoneNo : String
    FaxNo : String
    MemoType : MemoType
    Memo : String
    IsDelivering : Boolean
    IsDeliveringDefault : Boolean
    IsPosting : Boolean
    IsPostingDefault : Boolean
    IsInvoicing : Boolean
    IsInvoicingDefault : Boolean
    Folder : Folder
    Third : Third
    Country : Country
    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.Address, Winbooks.TORM.OM",
      "TotalLevel": 1,
      "Version": 2,
      "Modified": null,
      "ModifiedBy": "00000000-0000-0000-0000-000000000000",
      "Created": null,
      "CreatedBy": "00000000-0000-0000-0000-000000000000",
      "Folder_Id": "cf830c71-e8a5-4281-964a-a48001428ab5",
      "Third_Id": "9c890a28-45c5-4914-b1bb-9f9400b4c553",
      "Country_Id": "8f8a337e-b483-4c30-b6ed-9f9400b4c553",
      "Index": 0,
      "Address1": "Fond Jean-Pâques 6 C",
      "Address2": "",
      "Town": "Louvain-la-Neuve",
      "Zip": "1348",
      "Name": "",
      "Number": "",
      "Box": "",
      "PhoneNo": "+32 10451244",
      "FaxNo": "+32 10459101",
      "MemoType": 0,
      "Memo": "",
      "IsDelivering": false,
      "IsDeliveringDefault": false,
      "IsPosting": false,
      "IsPostingDefault": false,
      "IsInvoicing": false,
      "IsInvoicingDefault": false,
      "Id": "f4bfd9f1-aa4d-4471-916c-9f9400b4d286",
      "ResultState": 0,
      "ActionState": 0,
      "CachedCollection": {},
      "IsBinding": false,
      "IsSpecifiedId": false,
      "IsDirty": false,
      "UpdatedEntities": {},
      "CustomId": "00000000-0000-0000-0000-000000000000",
      "Custom_ListValueTypes": [
        "System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089",
        "System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089",
        "System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089",
        "System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089",
        "System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089",
        "System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"
      ],
      "Custom": {
        "Telephone3": "",
        "AddressNumber": "",
        "Composite": "",
        "Line3": "",
        "Latitude": "",
        "ExchangeRate": ""
      },
      "UpdatedProperties": [],
      "UpdatedValues": [],
      "FolderCode": "PARFIWEB_DEMO",
      "ThirdCode": "",
      "CountryCode": "BE"
    }
Top