POST api/v1/Agents/{AgentID}/Jobs/{JobMasterNo}/CustomerVisibility
Create Customer Visibility
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| AgentID | No documentation available. |
Define this parameter in the request URI. |
| JobMasterNo | No documentation available. |
Define this parameter in the request URI. |
| customerVisibilities |
Define this parameter in the request body. |
Request body formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
[
{
"TransactionID": "sample string 1",
"HouseNos": [
{
"HouseNo": "sample string 1"
},
{
"HouseNo": "sample string 1"
},
{
"HouseNo": "sample string 1"
}
],
"AddressBookID": 2,
"TransactionType": "sample string 3",
"IsMasterShared": true
},
{
"TransactionID": "sample string 1",
"HouseNos": [
{
"HouseNo": "sample string 1"
},
{
"HouseNo": "sample string 1"
},
{
"HouseNo": "sample string 1"
}
],
"AddressBookID": 2,
"TransactionType": "sample string 3",
"IsMasterShared": true
},
{
"TransactionID": "sample string 1",
"HouseNos": [
{
"HouseNo": "sample string 1"
},
{
"HouseNo": "sample string 1"
},
{
"HouseNo": "sample string 1"
}
],
"AddressBookID": 2,
"TransactionType": "sample string 3",
"IsMasterShared": true
}
]
application/xml, text/xml
Sample:
<ArrayOfJobCustomerVisibilityDTO>
<JobCustomerVisibilityDTO>
<AddressBookID>2</AddressBookID>
<TransactionType>sample string 3</TransactionType>
<IsMasterShared>true</IsMasterShared>
<TransactionID>sample string 1</TransactionID>
<HouseNos>
<HouseNo>sample string 1</HouseNo>
</HouseNos>
<HouseNos>
<HouseNo>sample string 1</HouseNo>
</HouseNos>
<HouseNos>
<HouseNo>sample string 1</HouseNo>
</HouseNos>
</JobCustomerVisibilityDTO>
<JobCustomerVisibilityDTO>
<AddressBookID>2</AddressBookID>
<TransactionType>sample string 3</TransactionType>
<IsMasterShared>true</IsMasterShared>
<TransactionID>sample string 1</TransactionID>
<HouseNos>
<HouseNo>sample string 1</HouseNo>
</HouseNos>
<HouseNos>
<HouseNo>sample string 1</HouseNo>
</HouseNos>
<HouseNos>
<HouseNo>sample string 1</HouseNo>
</HouseNos>
</JobCustomerVisibilityDTO>
<JobCustomerVisibilityDTO>
<AddressBookID>2</AddressBookID>
<TransactionType>sample string 3</TransactionType>
<IsMasterShared>true</IsMasterShared>
<TransactionID>sample string 1</TransactionID>
<HouseNos>
<HouseNo>sample string 1</HouseNo>
</HouseNos>
<HouseNos>
<HouseNo>sample string 1</HouseNo>
</HouseNos>
<HouseNos>
<HouseNo>sample string 1</HouseNo>
</HouseNos>
</JobCustomerVisibilityDTO>
</ArrayOfJobCustomerVisibilityDTO>
Response Information
Response body formats
application/json, text/json
Sample:
[
{
"TransactionID": "sample string 1",
"HouseNos": [
{
"HouseNo": "sample string 1"
},
{
"HouseNo": "sample string 1"
},
{
"HouseNo": "sample string 1"
}
],
"AddressBookID": 2,
"TransactionType": "sample string 3",
"IsMasterShared": true
},
{
"TransactionID": "sample string 1",
"HouseNos": [
{
"HouseNo": "sample string 1"
},
{
"HouseNo": "sample string 1"
},
{
"HouseNo": "sample string 1"
}
],
"AddressBookID": 2,
"TransactionType": "sample string 3",
"IsMasterShared": true
},
{
"TransactionID": "sample string 1",
"HouseNos": [
{
"HouseNo": "sample string 1"
},
{
"HouseNo": "sample string 1"
},
{
"HouseNo": "sample string 1"
}
],
"AddressBookID": 2,
"TransactionType": "sample string 3",
"IsMasterShared": true
}
]
application/xml, text/xml
Sample:
<ArrayOfJobCustomerVisibilityDTO>
<JobCustomerVisibilityDTO>
<AddressBookID>2</AddressBookID>
<TransactionType>sample string 3</TransactionType>
<IsMasterShared>true</IsMasterShared>
<TransactionID>sample string 1</TransactionID>
<HouseNos>
<HouseNo>sample string 1</HouseNo>
</HouseNos>
<HouseNos>
<HouseNo>sample string 1</HouseNo>
</HouseNos>
<HouseNos>
<HouseNo>sample string 1</HouseNo>
</HouseNos>
</JobCustomerVisibilityDTO>
<JobCustomerVisibilityDTO>
<AddressBookID>2</AddressBookID>
<TransactionType>sample string 3</TransactionType>
<IsMasterShared>true</IsMasterShared>
<TransactionID>sample string 1</TransactionID>
<HouseNos>
<HouseNo>sample string 1</HouseNo>
</HouseNos>
<HouseNos>
<HouseNo>sample string 1</HouseNo>
</HouseNos>
<HouseNos>
<HouseNo>sample string 1</HouseNo>
</HouseNos>
</JobCustomerVisibilityDTO>
<JobCustomerVisibilityDTO>
<AddressBookID>2</AddressBookID>
<TransactionType>sample string 3</TransactionType>
<IsMasterShared>true</IsMasterShared>
<TransactionID>sample string 1</TransactionID>
<HouseNos>
<HouseNo>sample string 1</HouseNo>
</HouseNos>
<HouseNos>
<HouseNo>sample string 1</HouseNo>
</HouseNos>
<HouseNos>
<HouseNo>sample string 1</HouseNo>
</HouseNos>
</JobCustomerVisibilityDTO>
</ArrayOfJobCustomerVisibilityDTO>