GET request/supplier/contact
Provides Supplier contact details
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
SupplierContactDetailsName | Description | Type | Additional information |
---|---|---|---|
AccountManager | DetailsView |
None. |
|
BillingContact | DetailsView |
None. |
|
CompanyNumber | string |
None. |
|
CompanyPostcode | string |
None. |
|
CreditContact | DetailsView |
None. |
|
ITContact | DetailsView |
None. |
|
logo | SupplierLogoModel |
None. |
|
OfgemElectricLicenceNumber | string |
None. |
|
OfgemGasLicenceNumber | string |
None. |
|
OfgemValidationStatus | OfgemStatusEnum |
None. |
|
OfgemWaterLicenceNumber | string |
None. |
|
PricingContact | DetailsView |
None. |
|
RegistrationContact | DetailsView |
None. |
|
SupplierName | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "supplierName": "sample string 1", "ofgemValidationStatus": "Valid", "companyNumber": "sample string 2", "companyPostcode": "sample string 3", "ofgemGasLicenceNumber": "sample string 4", "ofgemElectricLicenceNumber": "sample string 5", "ofgemWaterLicenceNumber": "sample string 6", "billingContact": { "contactId": 1, "contactTypeId": 64, "title": "sample string 3", "firstName": "sample string 4", "lastName": "sample string 5", "number": "sample string 6", "email": "sample string 7" }, "accountManager": { "contactId": 1, "contactTypeId": 64, "title": "sample string 3", "firstName": "sample string 4", "lastName": "sample string 5", "number": "sample string 6", "email": "sample string 7" }, "creditContact": { "contactId": 1, "contactTypeId": 64, "title": "sample string 3", "firstName": "sample string 4", "lastName": "sample string 5", "number": "sample string 6", "email": "sample string 7" }, "registrationContact": { "contactId": 1, "contactTypeId": 64, "title": "sample string 3", "firstName": "sample string 4", "lastName": "sample string 5", "number": "sample string 6", "email": "sample string 7" }, "pricingContact": { "contactId": 1, "contactTypeId": 64, "title": "sample string 3", "firstName": "sample string 4", "lastName": "sample string 5", "number": "sample string 6", "email": "sample string 7" }, "itContact": { "contactId": 1, "contactTypeId": 64, "title": "sample string 3", "firstName": "sample string 4", "lastName": "sample string 5", "number": "sample string 6", "email": "sample string 7" }, "logo": { "supplierDocId": 1, "url": "sample string 1", "documentName": "sample string 2" } }
text/html
Sample:
{"supplierName":"sample string 1","ofgemValidationStatus":"Valid","companyNumber":"sample string 2","companyPostcode":"sample string 3","ofgemGasLicenceNumber":"sample string 4","ofgemElectricLicenceNumber":"sample string 5","ofgemWaterLicenceNumber":"sample string 6","billingContact":{"contactId":1,"contactTypeId":64,"title":"sample string 3","firstName":"sample string 4","lastName":"sample string 5","number":"sample string 6","email":"sample string 7"},"accountManager":{"contactId":1,"contactTypeId":64,"title":"sample string 3","firstName":"sample string 4","lastName":"sample string 5","number":"sample string 6","email":"sample string 7"},"creditContact":{"contactId":1,"contactTypeId":64,"title":"sample string 3","firstName":"sample string 4","lastName":"sample string 5","number":"sample string 6","email":"sample string 7"},"registrationContact":{"contactId":1,"contactTypeId":64,"title":"sample string 3","firstName":"sample string 4","lastName":"sample string 5","number":"sample string 6","email":"sample string 7"},"pricingContact":{"contactId":1,"contactTypeId":64,"title":"sample string 3","firstName":"sample string 4","lastName":"sample string 5","number":"sample string 6","email":"sample string 7"},"itContact":{"contactId":1,"contactTypeId":64,"title":"sample string 3","firstName":"sample string 4","lastName":"sample string 5","number":"sample string 6","email":"sample string 7"},"logo":{"supplierDocId":1,"url":"sample string 1","documentName":"sample string 2"}}
application/xml, text/xml
Sample:
<SupplierContactDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.SupplierDetails"> <AccountManager> <ContactId>1</ContactId> <ContactTypeId>64</ContactTypeId> <Email>sample string 7</Email> <FirstName>sample string 4</FirstName> <LastName>sample string 5</LastName> <Number>sample string 6</Number> <Title>sample string 3</Title> </AccountManager> <BillingContact> <ContactId>1</ContactId> <ContactTypeId>64</ContactTypeId> <Email>sample string 7</Email> <FirstName>sample string 4</FirstName> <LastName>sample string 5</LastName> <Number>sample string 6</Number> <Title>sample string 3</Title> </BillingContact> <CreditContact> <ContactId>1</ContactId> <ContactTypeId>64</ContactTypeId> <Email>sample string 7</Email> <FirstName>sample string 4</FirstName> <LastName>sample string 5</LastName> <Number>sample string 6</Number> <Title>sample string 3</Title> </CreditContact> <ITContact> <ContactId>1</ContactId> <ContactTypeId>64</ContactTypeId> <Email>sample string 7</Email> <FirstName>sample string 4</FirstName> <LastName>sample string 5</LastName> <Number>sample string 6</Number> <Title>sample string 3</Title> </ITContact> <PricingContact> <ContactId>1</ContactId> <ContactTypeId>64</ContactTypeId> <Email>sample string 7</Email> <FirstName>sample string 4</FirstName> <LastName>sample string 5</LastName> <Number>sample string 6</Number> <Title>sample string 3</Title> </PricingContact> <RegistrationContact> <ContactId>1</ContactId> <ContactTypeId>64</ContactTypeId> <Email>sample string 7</Email> <FirstName>sample string 4</FirstName> <LastName>sample string 5</LastName> <Number>sample string 6</Number> <Title>sample string 3</Title> </RegistrationContact> <logo xmlns:d2p1="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.FileStorage"> <d2p1:DocumentName>sample string 2</d2p1:DocumentName> <d2p1:SupplierDocId>1</d2p1:SupplierDocId> <d2p1:Url>sample string 1</d2p1:Url> </logo> <CompanyNumber>sample string 2</CompanyNumber> <CompanyPostcode>sample string 3</CompanyPostcode> <OfgemElectricLicenceNumber>sample string 5</OfgemElectricLicenceNumber> <OfgemGasLicenceNumber>sample string 4</OfgemGasLicenceNumber> <OfgemValidationStatus>Valid</OfgemValidationStatus> <OfgemWaterLicenceNumber>sample string 6</OfgemWaterLicenceNumber> <SupplierName>sample string 1</SupplierName> </SupplierContactDetails>