Needio.Services

<back to all web services

CreateBBCargoTrackingKeyRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/ServiceMan/CreateBBCargoTrackingKey
CreateBBCargoTrackingKeyRequest Parameters:
NameParameterData TypeRequiredDescription
RelatedIdqueryintNo
ServiceTypequeryServiceTypeNo
TransReturnTypequeryTransReturnTypesNo
SenderAddressqueryUserAddressDTONo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
isAdminformboolNo
CmdformstringNo
CreateBBCargoTrackingKeyResponse Parameters:
NameParameterData TypeRequiredDescription
DeliveryKeyformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
ServiceType Enum:
NameValue
Shared0
Offer1
Service2
Hangfire3
TransReturnTypes Enum:
NameValue
Transaction1
Return2
CustomerToAydem3
AydemToCustomer4
UserAddressDTO Parameters:
NameParameterData TypeRequiredDescription
UserAddressIdformintNo
AddressAliasformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
CountryformstringNo
ZipCodeformstringNo
DistrictIdformint?No
CityIdformint?No
StateIdformint?No
CountryIdformint?No
DistrictformstringNo
StreetformstringNo
BuildingNoformstringNo
DoorNoformstringNo
AddressRecipeformstringNo
GeoAddressformstringNo
LocationformGeoLocationNo
InvoiceYnformboolNo
DeliveryYnformboolNo
ActiveYnformboolNo
DefaultYnformboolNo
PhoneNumberformstringNo
EmailformstringNo
InvoiceAddressTypeformInvoiceAddressTypes?No
InvoiceNameformstringNo
TaxOfficeformstringNo
TaxNoformstringNo
Registerformbool?No
DeliveryNameformstringNo
DeliverySurnameformstringNo
EInvoiceYnformbool?No
ExtensionDataformstringNo
IsHasOrderYnformboolNo
GeoLocation Parameters:
NameParameterData TypeRequiredDescription
LonformstringNo
LatformstringNo
GeoAddressformstringNo
IsDeletedformboolNo
InvoiceAddressTypes Enum:
NameValue
Personel1
Company2
CreateBBCargoTrackingKeyResponse Parameters:
NameParameterData TypeRequiredDescription
DeliveryKeyformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /ServiceMan/CreateBBCargoTrackingKey HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"RelatedId":0,"ServiceType":0,"TransReturnType":1,"SenderAddress":{"UserAddressId":0,"AddressAlias":"String","Address1":"String","Address2":"String","City":"String","State":"String","Country":"String","ZipCode":"String","DistrictId":0,"CityId":0,"StateId":0,"CountryId":0,"District":"String","Street":"String","BuildingNo":"String","DoorNo":"String","AddressRecipe":"String","GeoAddress":"String","Location":{"Lon":"String","Lat":"String","GeoAddress":"String","IsDeleted":false},"InvoiceYn":false,"DeliveryYn":false,"ActiveYn":false,"DefaultYn":false,"PhoneNumber":"String","Email":"String","InvoiceAddressType":0,"InvoiceName":"String","TaxOffice":"String","TaxNo":"String","Register":false,"DeliveryName":"String","DeliverySurname":"String","EInvoiceYn":false,"ExtensionData":"String","IsHasOrderYn":false},"start":"\/Date(-62135596800000-0000)\/","DeviceUUID":"String","APIKey":"String","isAdmin":false,"Cmd":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"DeliveryKey":"String","Result":false,"ResMessage":"String","Error":{"ErrorYn":false,"ErrorCode":"String","ErrorDescription":"String"},"PageInfo":{"TotalRecordCount":0,"TotalPageCount":0,"CurrentPage":0}}