POST api/trackingnumbers
Creates a new tracking number using the model provided.
Request Information
URI Parameters
None.
Body Parameters
The tracking number model.
TrackingNumberRequestDto| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId | globally unique identifier |
Required |
|
| TelephoneNumber | string |
Required |
|
| ProductId | globally unique identifier |
Required |
|
| Reference | string |
Required |
|
| ClientName | string |
Required |
|
| Medium | string |
Required |
|
| MediumType | string |
Required |
|
| Description | string |
Required |
|
| TenantId | globally unique identifier |
Required |
|
| OrderId | globally unique identifier |
Required |
|
| AreaCode | string |
None. |
|
| CampaignName | string |
Required |
|
| ChannelName | string |
Required |
Request Formats
application/json, text/json
Sample:
{
"UserId": "b0d1a1c3-0736-4396-9f08-6b52abcf3bea",
"TelephoneNumber": "sample string 2",
"ProductId": "00b1dab7-6298-4381-9bad-43e48f94016f",
"Reference": "sample string 4",
"ClientName": "sample string 5",
"Medium": "sample string 6",
"MediumType": "sample string 7",
"Description": "sample string 8",
"TenantId": "ecb2c437-a616-4fd2-9be1-65e697723707",
"OrderId": "1e05f1e7-5e73-4313-905d-d284ad4f618e",
"AreaCode": "sample",
"CampaignName": "sample string 11",
"ChannelName": "sample string 12"
}
application/xml, text/xml
Sample:
<TrackingNumberRequestDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.CommsTracking.Models"> <CampaignName>sample string 11</CampaignName> <ChannelName>sample string 12</ChannelName> <ClientName>sample string 5</ClientName> <Description>sample string 8</Description> <Medium>sample string 6</Medium> <MediumType>sample string 7</MediumType> <OrderId>1e05f1e7-5e73-4313-905d-d284ad4f618e</OrderId> <ProductId>00b1dab7-6298-4381-9bad-43e48f94016f</ProductId> <Reference>sample string 4</Reference> <TelephoneNumber>sample string 2</TelephoneNumber> <TenantId>ecb2c437-a616-4fd2-9be1-65e697723707</TenantId> <UserId>b0d1a1c3-0736-4396-9f08-6b52abcf3bea</UserId> </TrackingNumberRequestDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.