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": "084fa93b-172e-4f39-a3f4-2cce6e407721",
"TelephoneNumber": "sample string 2",
"ProductId": "11854a3c-041c-4a13-a914-8fa292571e25",
"Reference": "sample string 4",
"ClientName": "sample string 5",
"Medium": "sample string 6",
"MediumType": "sample string 7",
"Description": "sample string 8",
"TenantId": "7ead54cb-8ad7-4e42-96d6-9aa2f1387410",
"OrderId": "63ee44e7-7a4c-4634-aa61-21ff380007ac",
"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>63ee44e7-7a4c-4634-aa61-21ff380007ac</OrderId> <ProductId>11854a3c-041c-4a13-a914-8fa292571e25</ProductId> <Reference>sample string 4</Reference> <TelephoneNumber>sample string 2</TelephoneNumber> <TenantId>7ead54cb-8ad7-4e42-96d6-9aa2f1387410</TenantId> <UserId>084fa93b-172e-4f39-a3f4-2cce6e407721</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.