POST api/Partner/GetIntegratorProfile
Request Information
URI Parameters
None.
Body Parameters
GetIntegratorProfileRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| IntegratorProfileId | string |
None. |
|
| Token | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"IntegratorProfileId": "sample string 1",
"Token": "sample string 2"
}
application/xml, text/xml
Sample:
<GetIntegratorProfileRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Integrator.Request"> <Token xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 2</Token> <IntegratorProfileId>sample string 1</IntegratorProfileId> </GetIntegratorProfileRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
GetIntegratorProfileResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| IntegrationProfile | IntegratorProfile |
None. |
|
| ErrorCode | string |
None. |
|
| ErrorMessage | string |
None. |
|
| ErrorCategory | string |
None. |
|
| Result | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"IntegrationProfile": {
"IntegratorProfileId": "sample string 1",
"UserId": "sample string 2",
"IntegratorCompanyId": 3,
"Name": "sample string 4",
"Note": "sample string 5",
"IntegratorProfileStatusId": 64,
"ApiStatusId": 64,
"AddressId": "sample string 8",
"InvoiceAddress": {
"AddressId": "sample string 1",
"UserId": "sample string 2",
"UserAddressCompanyTypeId": 64,
"Description": "sample string 4",
"CompanyTitle": "sample string 5",
"ContactTitle": "sample string 6",
"Email": "sample string 7",
"PhoneNumber": "sample string 8",
"Website": "sample string 9",
"Fax": "sample string 10",
"TaxAuthority": "sample string 11",
"TaxNumber": "sample string 12",
"AddressLine1": "sample string 13",
"AddressLine2": "sample string 14",
"Neighborhood": "sample string 15",
"District": "sample string 16",
"City": "sample string 17",
"PostalCode": "sample string 18",
"Country": "sample string 19"
},
"TestMode": true,
"Verified": 10,
"TaxNumber": "sample string 11",
"ProfileSettings": [
{
"IntegratorProfileSettingId": "sample string 1",
"UserId": "sample string 2",
"IntegratorProfileId": "sample string 3",
"SettingValue": "sample string 4",
"IntegratorSettingId": 5,
"IntegratorCompanyId": 6,
"SettingName": "sample string 7",
"IsUnique": true,
"Optional": true,
"IntegratorSettingTypeId": 64,
"SettingType": "sample string 11",
"Description": "sample string 12",
"Parameters": "sample string 13",
"SettingOrder": 14
},
{
"IntegratorProfileSettingId": "sample string 1",
"UserId": "sample string 2",
"IntegratorProfileId": "sample string 3",
"SettingValue": "sample string 4",
"IntegratorSettingId": 5,
"IntegratorCompanyId": 6,
"SettingName": "sample string 7",
"IsUnique": true,
"Optional": true,
"IntegratorSettingTypeId": 64,
"SettingType": "sample string 11",
"Description": "sample string 12",
"Parameters": "sample string 13",
"SettingOrder": 14
}
],
"CompanyName": "sample string 12",
"IntegratorCompanyTypeId": 13,
"InvoiceIdGenerationMethod": 14
},
"ErrorCode": "sample string 1",
"ErrorMessage": "sample string 2",
"ErrorCategory": "sample string 3",
"Result": true
}
application/xml, text/xml
Sample:
<GetIntegratorProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Integrator.Response">
<ErrorCategory xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 3</ErrorCategory>
<ErrorCode xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 1</ErrorCode>
<ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 2</ErrorMessage>
<Result xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">true</Result>
<IntegrationProfile xmlns:d2p1="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Integrator">
<d2p1:AddressId>sample string 8</d2p1:AddressId>
<d2p1:ApiStatusId>64</d2p1:ApiStatusId>
<d2p1:CompanyName>sample string 12</d2p1:CompanyName>
<d2p1:IntegratorCompanyId>3</d2p1:IntegratorCompanyId>
<d2p1:IntegratorCompanyTypeId>13</d2p1:IntegratorCompanyTypeId>
<d2p1:IntegratorProfileId>sample string 1</d2p1:IntegratorProfileId>
<d2p1:IntegratorProfileStatusId>64</d2p1:IntegratorProfileStatusId>
<d2p1:InvoiceAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Account">
<d3p1:AddressId>sample string 1</d3p1:AddressId>
<d3p1:AddressLine1>sample string 13</d3p1:AddressLine1>
<d3p1:AddressLine2>sample string 14</d3p1:AddressLine2>
<d3p1:City>sample string 17</d3p1:City>
<d3p1:CompanyTitle>sample string 5</d3p1:CompanyTitle>
<d3p1:ContactTitle>sample string 6</d3p1:ContactTitle>
<d3p1:Country>sample string 19</d3p1:Country>
<d3p1:Description>sample string 4</d3p1:Description>
<d3p1:District>sample string 16</d3p1:District>
<d3p1:Email>sample string 7</d3p1:Email>
<d3p1:Fax>sample string 10</d3p1:Fax>
<d3p1:Neighborhood>sample string 15</d3p1:Neighborhood>
<d3p1:PhoneNumber>sample string 8</d3p1:PhoneNumber>
<d3p1:PostalCode>sample string 18</d3p1:PostalCode>
<d3p1:TaxAuthority>sample string 11</d3p1:TaxAuthority>
<d3p1:TaxNumber>sample string 12</d3p1:TaxNumber>
<d3p1:UserAddressCompanyTypeId>64</d3p1:UserAddressCompanyTypeId>
<d3p1:UserId>sample string 2</d3p1:UserId>
<d3p1:Website>sample string 9</d3p1:Website>
</d2p1:InvoiceAddress>
<d2p1:InvoiceIdGenerationMethod>14</d2p1:InvoiceIdGenerationMethod>
<d2p1:Name>sample string 4</d2p1:Name>
<d2p1:Note>sample string 5</d2p1:Note>
<d2p1:ProfileSettings>
<d2p1:IntegratorProfileSetting>
<d2p1:Description>sample string 12</d2p1:Description>
<d2p1:IntegratorCompanyId>6</d2p1:IntegratorCompanyId>
<d2p1:IntegratorSettingId>5</d2p1:IntegratorSettingId>
<d2p1:IntegratorSettingTypeId>64</d2p1:IntegratorSettingTypeId>
<d2p1:IsUnique>true</d2p1:IsUnique>
<d2p1:Optional>true</d2p1:Optional>
<d2p1:Parameters>sample string 13</d2p1:Parameters>
<d2p1:SettingName>sample string 7</d2p1:SettingName>
<d2p1:SettingOrder>14</d2p1:SettingOrder>
<d2p1:SettingType>sample string 11</d2p1:SettingType>
<d2p1:IntegratorProfileId>sample string 3</d2p1:IntegratorProfileId>
<d2p1:IntegratorProfileSettingId>sample string 1</d2p1:IntegratorProfileSettingId>
<d2p1:SettingValue>sample string 4</d2p1:SettingValue>
<d2p1:UserId>sample string 2</d2p1:UserId>
</d2p1:IntegratorProfileSetting>
<d2p1:IntegratorProfileSetting>
<d2p1:Description>sample string 12</d2p1:Description>
<d2p1:IntegratorCompanyId>6</d2p1:IntegratorCompanyId>
<d2p1:IntegratorSettingId>5</d2p1:IntegratorSettingId>
<d2p1:IntegratorSettingTypeId>64</d2p1:IntegratorSettingTypeId>
<d2p1:IsUnique>true</d2p1:IsUnique>
<d2p1:Optional>true</d2p1:Optional>
<d2p1:Parameters>sample string 13</d2p1:Parameters>
<d2p1:SettingName>sample string 7</d2p1:SettingName>
<d2p1:SettingOrder>14</d2p1:SettingOrder>
<d2p1:SettingType>sample string 11</d2p1:SettingType>
<d2p1:IntegratorProfileId>sample string 3</d2p1:IntegratorProfileId>
<d2p1:IntegratorProfileSettingId>sample string 1</d2p1:IntegratorProfileSettingId>
<d2p1:SettingValue>sample string 4</d2p1:SettingValue>
<d2p1:UserId>sample string 2</d2p1:UserId>
</d2p1:IntegratorProfileSetting>
</d2p1:ProfileSettings>
<d2p1:TaxNumber>sample string 11</d2p1:TaxNumber>
<d2p1:TestMode>true</d2p1:TestMode>
<d2p1:UserId>sample string 2</d2p1:UserId>
<d2p1:Verified>10</d2p1:Verified>
</IntegrationProfile>
</GetIntegratorProfileResponse>