POST api/General/GetIntegratorProfilePrefix
Request Information
URI Parameters
None.
Body Parameters
GetIntegratorProfilePrefixRequestName | Description | Type | Additional information |
---|---|---|---|
IntegratorProfileId | string |
None. |
|
UserId | string |
None. |
|
Prefix | string |
None. |
|
Year | integer |
None. |
|
PrefixTypeId | string |
None. |
|
Token | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "IntegratorProfileId": "sample string 1", "UserId": "sample string 2", "Prefix": "sample string 3", "Year": 4, "PrefixTypeId": "sample string 5", "Token": "sample string 6" }
application/xml, text/xml
Sample:
<GetIntegratorProfilePrefixRequest 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 6</Token> <IntegratorProfileId>sample string 1</IntegratorProfileId> <Prefix>sample string 3</Prefix> <PrefixTypeId>sample string 5</PrefixTypeId> <UserId>sample string 2</UserId> <Year>4</Year> </GetIntegratorProfilePrefixRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
GetIntegratorProfilePrefixResponseName | Description | Type | Additional information |
---|---|---|---|
ProfilePrefixes | Collection of IntegratorProfilePrefix |
None. |
|
ErrorCode | string |
None. |
|
ErrorMessage | string |
None. |
|
ErrorCategory | string |
None. |
|
Result | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "ProfilePrefixes": [ { "IntegratorProfilePrefixId": "sample string 1", "IntegratorProfileId": "sample string 2", "UserId": "sample string 3", "Prefix": "sample string 4", "Year": 5, "LastSerialNumber": 6, "LastInvoiceIssueTime": "2023-02-06T14:42:07.0005408+03:00", "LastUpdateTime": "2023-02-06T14:42:07.0005408+03:00", "CreationTime": "2023-02-06T14:42:07.0005408+03:00", "IntegratorProfileName": "sample string 10", "PrefixTypeId": "sample string 11", "InvoiceId": "sample string 12" }, { "IntegratorProfilePrefixId": "sample string 1", "IntegratorProfileId": "sample string 2", "UserId": "sample string 3", "Prefix": "sample string 4", "Year": 5, "LastSerialNumber": 6, "LastInvoiceIssueTime": "2023-02-06T14:42:07.0005408+03:00", "LastUpdateTime": "2023-02-06T14:42:07.0005408+03:00", "CreationTime": "2023-02-06T14:42:07.0005408+03:00", "IntegratorProfileName": "sample string 10", "PrefixTypeId": "sample string 11", "InvoiceId": "sample string 12" } ], "ErrorCode": "sample string 1", "ErrorMessage": "sample string 2", "ErrorCategory": "sample string 3", "Result": true }
application/xml, text/xml
Sample:
<GetIntegratorProfilePrefixResponse 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> <ProfilePrefixes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Integrator"> <d2p1:IntegratorProfilePrefix> <d2p1:CreationTime>2023-02-06T14:42:07.0005408+03:00</d2p1:CreationTime> <d2p1:IntegratorProfileId>sample string 2</d2p1:IntegratorProfileId> <d2p1:IntegratorProfileName>sample string 10</d2p1:IntegratorProfileName> <d2p1:IntegratorProfilePrefixId>sample string 1</d2p1:IntegratorProfilePrefixId> <d2p1:InvoiceId>sample string 12</d2p1:InvoiceId> <d2p1:LastInvoiceIssueTime>2023-02-06T14:42:07.0005408+03:00</d2p1:LastInvoiceIssueTime> <d2p1:LastSerialNumber>6</d2p1:LastSerialNumber> <d2p1:LastUpdateTime>2023-02-06T14:42:07.0005408+03:00</d2p1:LastUpdateTime> <d2p1:Prefix>sample string 4</d2p1:Prefix> <d2p1:PrefixTypeId>sample string 11</d2p1:PrefixTypeId> <d2p1:UserId>sample string 3</d2p1:UserId> <d2p1:Year>5</d2p1:Year> </d2p1:IntegratorProfilePrefix> <d2p1:IntegratorProfilePrefix> <d2p1:CreationTime>2023-02-06T14:42:07.0005408+03:00</d2p1:CreationTime> <d2p1:IntegratorProfileId>sample string 2</d2p1:IntegratorProfileId> <d2p1:IntegratorProfileName>sample string 10</d2p1:IntegratorProfileName> <d2p1:IntegratorProfilePrefixId>sample string 1</d2p1:IntegratorProfilePrefixId> <d2p1:InvoiceId>sample string 12</d2p1:InvoiceId> <d2p1:LastInvoiceIssueTime>2023-02-06T14:42:07.0005408+03:00</d2p1:LastInvoiceIssueTime> <d2p1:LastSerialNumber>6</d2p1:LastSerialNumber> <d2p1:LastUpdateTime>2023-02-06T14:42:07.0005408+03:00</d2p1:LastUpdateTime> <d2p1:Prefix>sample string 4</d2p1:Prefix> <d2p1:PrefixTypeId>sample string 11</d2p1:PrefixTypeId> <d2p1:UserId>sample string 3</d2p1:UserId> <d2p1:Year>5</d2p1:Year> </d2p1:IntegratorProfilePrefix> </ProfilePrefixes> </GetIntegratorProfilePrefixResponse>