The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
Result:
{
Id: 0,
UserId: 0,
BranchId: 0,
CRTime: 0001-01-01,
Spend: False,
DriverId: 0,
CarId: 0,
RouteDays:
[
0
],
User:
{
Id: 0,
UserName: String,
SupervisorId: 0,
PresalerId: 0,
VanId: 0,
PN: String,
CarId: 0,
NameU: String,
Phone: String,
EMail: String,
CanPay: False,
PayAcc: String,
IsDelivered: False,
BranchId: 0,
Car:
{
ID: 0,
Number: String,
Description: String,
DriverId: 0,
CarType: 0
},
Presaler:
{
Id: 0,
Code: String,
FullName: String,
Spend: False,
DisCban: False,
VisorId: 0
},
Supervisor:
{
Id: 0,
Name: String,
PersonalNumber: String,
ChannelId: 0,
Channel:
{
ChannelId: 0,
Name: String,
Spend: False
},
Spend: False
},
Van:
{
Id: 0,
Name: String,
CarId: 0,
DriverId: 0,
BranchId: 0,
Car:
{
ID: 0,
Number: String,
Description: String,
DriverId: 0,
CarType: 0
},
Driver:
{
ID: 0,
Name: String,
PerNum: String,
DrivingLicense: String
},
Branch:
{
Id: 0,
CompanyId: 0,
ParentId: 0,
Name: String,
NameEn: String,
AddressId: 0,
Spend: False,
Address:
{
Id: 0,
CityId: String,
BlockId: 0,
PostalCode: String,
FullAddress: String,
Location:
{
Latitude: 0,
Longitude: 0
}
},
Code: String,
BranchNum: 0,
GroupId: 0,
Phone: String,
Note: String,
Company:
{
Id: 0,
Code: String,
Name: String,
NameEn: String,
IsOwn: False,
IsPartner: False,
IsCustomer: False,
IsSupplier: False,
AddressId: 0,
Phone: String,
Fax: String,
Email: String,
Web: String,
Note: String,
Spend: False,
Address:
{
Id: 0,
CityId: String,
BlockId: 0,
PostalCode: String,
FullAddress: String,
Location:
{
Latitude: 0,
Longitude: 0
}
},
VatType: 0
},
CustomerParameters:
{
BranchId: 0,
CustomerType: 0,
ProductType: 0,
CustomerCategory: 0,
CreditDays: 0,
CreditLimit: 0,
OverdueLimit: 0
},
BranchProdSpendListType: 0,
SupplierParams:
{
BranchId: 0,
ProdSupplyDays: 0,
MinOrderAmmount: 0,
OrderGenIntervalDays: 0,
Importer: False,
MinOrderQuantity: 0,
AutoOrder: False
},
BankAccounts:
[
{
Id: 0,
BranchId: 0,
BankId: String,
Account: String,
Note: String,
IsDefault: False,
IntermediaryBankId: String,
IntermediaryAccount: String,
CurrencyId: String
}
],
BranchAccounts:
[
{
Id: 0,
BranchId: 0,
AccType: 0,
Account: String
}
]
},
AllowRetailSale: False,
RetailAcc: String,
RetailAccInfo:
{
Acc: String,
Name: String,
SN: String,
WarehouseAddress: String,
Address: String,
Phone: String,
AccWithName: String - String,
VatType: 0,
BranchId: 0
}
},
Branch:
{
Id: 0,
CompanyId: 0,
ParentId: 0,
Name: String,
NameEn: String,
AddressId: 0,
Spend: False,
Address:
{
Id: 0,
CityId: String,
BlockId: 0,
PostalCode: String,
FullAddress: String,
Location:
{
Latitude: 0,
Longitude: 0
}
},
Code: String,
BranchNum: 0,
GroupId: 0,
Phone: String,
Note: String,
Company:
{
Id: 0,
Code: String,
Name: String,
NameEn: String,
IsOwn: False,
IsPartner: False,
IsCustomer: False,
IsSupplier: False,
AddressId: 0,
Phone: String,
Fax: String,
Email: String,
Web: String,
Note: String,
Spend: False,
Address:
{
Id: 0,
CityId: String,
BlockId: 0,
PostalCode: String,
FullAddress: String,
Location:
{
Latitude: 0,
Longitude: 0
}
},
VatType: 0
},
CustomerParameters:
{
BranchId: 0,
CustomerType: 0,
ProductType: 0,
CustomerCategory: 0,
CreditDays: 0,
CreditLimit: 0,
OverdueLimit: 0
},
BranchProdSpendListType: 0,
SupplierParams:
{
BranchId: 0,
ProdSupplyDays: 0,
MinOrderAmmount: 0,
OrderGenIntervalDays: 0,
Importer: False,
MinOrderQuantity: 0,
AutoOrder: False
},
BankAccounts:
[
{
Id: 0,
BranchId: 0,
BankId: String,
Account: String,
Note: String,
IsDefault: False,
IntermediaryBankId: String,
IntermediaryAccount: String,
CurrencyId: String
}
],
BranchAccounts:
[
{
Id: 0,
BranchId: 0,
AccType: 0,
Account: String
}
]
},
Settings:
{
UseCategoryRestrictions: False,
UseProducerRestrictions: False,
ShowNoRemProd: False,
WeekWorkDays:
[
0
],
WorkDayEndMinutes: 0,
ForceGPSLocationForVisit: False,
RemCheck: False,
CanReturnProducts: False,
CanEditClientGPSLocation: False,
CanEditPrice: False,
AllowVisitSaleWithoutDocumentUpload: False,
AllowVisitSaleWithoutWaybillUpload: False,
AllowVisitReturnWithoutDocumentUpload: False,
AllowVisitReturnWithoutWaybillUpload: False,
SplitReturnBySales: False,
AllowGiftOrders: False,
ShowProdCatalog: False,
DisallowOrders: False,
UseMerchandising: False,
AllowProdInventoryChecking: False,
AllowFaAssetInventoryChecking: False,
AllowImageFileCapture: False,
AllowVideoFileCapture: False,
AllowAudioFileCapture: False
}
},
Customer:
{
Id: 0,
CompanyId: 0,
ParentId: 0,
Name: String,
NameEn: String,
AddressId: 0,
Spend: False,
Address:
{
Id: 0,
CityId: String,
BlockId: 0,
PostalCode: String,
FullAddress: String,
Location:
{
Latitude: 0,
Longitude: 0
}
},
Code: String,
BranchNum: 0,
GroupId: 0,
Phone: String,
Note: String,
Company:
{
Id: 0,
Code: String,
Name: String,
NameEn: String,
IsOwn: False,
IsPartner: False,
IsCustomer: False,
IsSupplier: False,
AddressId: 0,
Phone: String,
Fax: String,
Email: String,
Web: String,
Note: String,
Spend: False,
Address:
{
Id: 0,
CityId: String,
BlockId: 0,
PostalCode: String,
FullAddress: String,
Location:
{
Latitude: 0,
Longitude: 0
}
},
VatType: 0
},
CustomerParameters:
{
BranchId: 0,
CustomerType: 0,
ProductType: 0,
CustomerCategory: 0,
CreditDays: 0,
CreditLimit: 0,
OverdueLimit: 0
},
BranchProdSpendListType: 0,
SupplierParams:
{
BranchId: 0,
ProdSupplyDays: 0,
MinOrderAmmount: 0,
OrderGenIntervalDays: 0,
Importer: False,
MinOrderQuantity: 0,
AutoOrder: False
},
BankAccounts:
[
{
Id: 0,
BranchId: 0,
BankId: String,
Account: String,
Note: String,
IsDefault: False,
IntermediaryBankId: String,
IntermediaryAccount: String,
CurrencyId: String
}
],
BranchAccounts:
[
{
Id: 0,
BranchId: 0,
AccType: 0,
Account: String
}
]
},
Car:
{
ID: 0,
Number: String,
Description: String,
DriverId: 0,
CarType: 0
},
Driver:
{
ID: 0,
Name: String,
PerNum: String,
DrivingLicense: String
},
ForwarderUserId: 0,
ForwarderUser:
{
Id: 0,
UserName: String,
SupervisorId: 0,
PresalerId: 0,
VanId: 0,
PN: String,
CarId: 0,
NameU: String,
Phone: String,
EMail: String,
CanPay: False,
PayAcc: String,
IsDelivered: False,
BranchId: 0,
Car:
{
ID: 0,
Number: String,
Description: String,
DriverId: 0,
CarType: 0
},
Presaler:
{
Id: 0,
Code: String,
FullName: String,
Spend: False,
DisCban: False,
VisorId: 0
},
Supervisor:
{
Id: 0,
Name: String,
PersonalNumber: String,
ChannelId: 0,
Channel:
{
ChannelId: 0,
Name: String,
Spend: False
},
Spend: False
},
Van:
{
Id: 0,
Name: String,
CarId: 0,
DriverId: 0,
BranchId: 0,
Car:
{
ID: 0,
Number: String,
Description: String,
DriverId: 0,
CarType: 0
},
Driver:
{
ID: 0,
Name: String,
PerNum: String,
DrivingLicense: String
},
Branch:
{
Id: 0,
CompanyId: 0,
ParentId: 0,
Name: String,
NameEn: String,
AddressId: 0,
Spend: False,
Address:
{
Id: 0,
CityId: String,
BlockId: 0,
PostalCode: String,
FullAddress: String,
Location:
{
Latitude: 0,
Longitude: 0
}
},
Code: String,
BranchNum: 0,
GroupId: 0,
Phone: String,
Note: String,
Company:
{
Id: 0,
Code: String,
Name: String,
NameEn: String,
IsOwn: False,
IsPartner: False,
IsCustomer: False,
IsSupplier: False,
AddressId: 0,
Phone: String,
Fax: String,
Email: String,
Web: String,
Note: String,
Spend: False,
Address:
{
Id: 0,
CityId: String,
BlockId: 0,
PostalCode: String,
FullAddress: String,
Location:
{
Latitude: 0,
Longitude: 0
}
},
VatType: 0
},
CustomerParameters:
{
BranchId: 0,
CustomerType: 0,
ProductType: 0,
CustomerCategory: 0,
CreditDays: 0,
CreditLimit: 0,
OverdueLimit: 0
},
BranchProdSpendListType: 0,
SupplierParams:
{
BranchId: 0,
ProdSupplyDays: 0,
MinOrderAmmount: 0,
OrderGenIntervalDays: 0,
Importer: False,
MinOrderQuantity: 0,
AutoOrder: False
},
BankAccounts:
[
{
Id: 0,
BranchId: 0,
BankId: String,
Account: String,
Note: String,
IsDefault: False,
IntermediaryBankId: String,
IntermediaryAccount: String,
CurrencyId: String
}
],
BranchAccounts:
[
{
Id: 0,
BranchId: 0,
AccType: 0,
Account: String
}
]
},
AllowRetailSale: False,
RetailAcc: String,
RetailAccInfo:
{
Acc: String,
Name: String,
SN: String,
WarehouseAddress: String,
Address: String,
Phone: String,
AccWithName: String - String,
VatType: 0,
BranchId: 0
}
},
Branch:
{
Id: 0,
CompanyId: 0,
ParentId: 0,
Name: String,
NameEn: String,
AddressId: 0,
Spend: False,
Address:
{
Id: 0,
CityId: String,
BlockId: 0,
PostalCode: String,
FullAddress: String,
Location:
{
Latitude: 0,
Longitude: 0
}
},
Code: String,
BranchNum: 0,
GroupId: 0,
Phone: String,
Note: String,
Company:
{
Id: 0,
Code: String,
Name: String,
NameEn: String,
IsOwn: False,
IsPartner: False,
IsCustomer: False,
IsSupplier: False,
AddressId: 0,
Phone: String,
Fax: String,
Email: String,
Web: String,
Note: String,
Spend: False,
Address:
{
Id: 0,
CityId: String,
BlockId: 0,
PostalCode: String,
FullAddress: String,
Location:
{
Latitude: 0,
Longitude: 0
}
},
VatType: 0
},
CustomerParameters:
{
BranchId: 0,
CustomerType: 0,
ProductType: 0,
CustomerCategory: 0,
CreditDays: 0,
CreditLimit: 0,
OverdueLimit: 0
},
BranchProdSpendListType: 0,
SupplierParams:
{
BranchId: 0,
ProdSupplyDays: 0,
MinOrderAmmount: 0,
OrderGenIntervalDays: 0,
Importer: False,
MinOrderQuantity: 0,
AutoOrder: False
},
BankAccounts:
[
{
Id: 0,
BranchId: 0,
BankId: String,
Account: String,
Note: String,
IsDefault: False,
IntermediaryBankId: String,
IntermediaryAccount: String,
CurrencyId: String
}
],
BranchAccounts:
[
{
Id: 0,
BranchId: 0,
AccType: 0,
Account: String
}
]
},
Settings:
{
UseCategoryRestrictions: False,
UseProducerRestrictions: False,
ShowNoRemProd: False,
WeekWorkDays:
[
0
],
WorkDayEndMinutes: 0,
ForceGPSLocationForVisit: False,
RemCheck: False,
CanReturnProducts: False,
CanEditClientGPSLocation: False,
CanEditPrice: False,
AllowVisitSaleWithoutDocumentUpload: False,
AllowVisitSaleWithoutWaybillUpload: False,
AllowVisitReturnWithoutDocumentUpload: False,
AllowVisitReturnWithoutWaybillUpload: False,
SplitReturnBySales: False,
AllowGiftOrders: False,
ShowProdCatalog: False,
DisallowOrders: False,
UseMerchandising: False,
AllowProdInventoryChecking: False,
AllowFaAssetInventoryChecking: False,
AllowImageFileCapture: False,
AllowVideoFileCapture: False,
AllowAudioFileCapture: False
}
}
}
}