VC Producer v1
Introduction
The purpose of this service is to get producers information from vision database.
Request
API GET : https://<pathtoapi>/producer
sample : https://your.domain .com/Producer?producer_codes=TP,OTS
This API needs to be authenticated ( pass header parameter Authorization : "Bearer "+AccessToken )
Input parameters
Parameter (Query Param) | Details | Required | Example |
---|---|---|---|
response_type | Can supply with JSON OR XML | Optional |
|
producer_codes | comma separated values to retrieve multiple producers | Optional | TP,OTS |
Response
Field Name | Type | Length | Comments |
---|---|---|---|
ProducerCode | String | 10 | Producer code , unique |
ProducerName | String | 100 | Producer name |
ContactName | String | 50 | Contact name |
AddressLine1 | String | 50 | Address |
AddressLine2 | String | 50 |
|
AddressLine3 | String | 50 |
|
Town | String | 50 |
|
PostCode | String | 50 |
|
TelephoneNo | string | 20 |
|
FaxNumber | String | 20 |
|
EmailAddress | String | 50 |
|
WebsiteAddress | String | 50 |
|
JSON Response sample
[
{
"ProducerCode": "TP",
"ProducerName": "The Producer",
"ContactName": "The manager",
"AddressLine1": "CentralPoint",
"AddressLine2": "45 Beech Street",
"AddressLine3": null,
"Town": "London",
"PostCode": "EC2Y 8AD",
"TelephoneNo": "01234 567890",
"FaxNumber": "01234 567890",
"EmailAddress": "person@domain.extension",
"ProducerNotes": null,
"WebsiteAddress": null,
"AutoProductProducerCode": "ES"
},
{
"ProducerCode": "OTS",
"ProducerName": "OTS producer",
"ContactName": null,
"AddressLine1": "CentralPoint",
"AddressLine2": "55 Beech Street",
"AddressLine3": null,
"Town": "London",
"PostCode": "EC2Y 8AD",
"TelephoneNo": "01234 567890",
"FaxNumber": "01234 567890",
"EmailAddress": "person@domain.extension",
"ProducerNotes": "Not Avilable",
"WebsiteAddress": null,
"AutoProductProducerCode": null
}
]
XML Response sample
<Producers>
<Producer>
<ProducerCode>TP</ProducerCode>
<ProducerName>The Producer</ProducerName>
<ContactName>The manager</ContactName>
<AddressLine1>CentralPoint</AddressLine1>
<AddressLine2>45 Beech Street</AddressLine2>
<Town>London</Town>
<PostCode>EC2Y 8AD</PostCode>
<TelephoneNo>01234 567890</TelephoneNo>
<FaxNumber>01234 567890</FaxNumber>
<EmailAddress>person@domain.extension</EmailAddress>
<AutoProductProducerCode>ES</AutoProductProducerCode>
</Producer>
<Producer>
<ProducerCode>OTS</ProducerCode>
<ProducerName>OTS producer</ProducerName>
<AddressLine1>CentralPoint</AddressLine1>
<ProducerNotes>55 Beech Street</ProducerNotes>
<Town>London</Town>
<PostCode>EC2Y 8AD</PostCode>
<TelephoneNo>01234 567890</TelephoneNo>
<FaxNumber>01234 567890</FaxNumber>
<EmailAddress>person@domain.extension</EmailAddress>
<AutoProductProducerCode>ES</AutoProductProducerCode>
</Producer>
</Producers> |
Copyright Ontech Solutions 2017-2024. All rights reserved, no part may be replicated or distributed without the express permission of the owner.