GET api/Carrier/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

Carrier
NameDescriptionTypeAdditional information
Id

integer

None.
Name

string

Required

String length: inclusive between 0 and 50
CsvTemplateName

string

String length: inclusive between 0 and 255
EmailAddress

string

String length: inclusive between 0 and 255
Address1

string

String length: inclusive between 0 and 100
Address2

string

String length: inclusive between 0 and 100
ContactName

string

String length: inclusive between 0 and 100
ContactEmail

string

String length: inclusive between 0 and 100
IsAttachedPdfToEmail

boolean

Required
IsSendDailyEmail

boolean

Required
IsSendWeeklyEmail

boolean

Required
IsSendMonthlyEmail

boolean

Required
PostCode

string

String length: inclusive between 0 and 6
PhoneNo

string

String length: inclusive between 0 and 20
Status

boolean

Required
TownOrCity

string

String length: inclusive between 0 and 20
DocketConfirmationInterfaceId

integer

None.
DocketConfirmationInterface

Interface

None.
MessageUrl

string

String length: inclusive between 0 and 255
IsSendMessage

boolean

None.
IsShowInKiosk

boolean

None.
CarrierShortCode

string

Required

String length: inclusive between 0 and 100
MasterId

integer

Required
QuickCode

string

None.
SourceChannel

string

None.
CreatedBy

string

None.
CreatedOn

date

None.
ModifiedBy

string

None.
ModifiedOn

date

None.
RowVersion

Collection of byte

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "Name": "sample string 2",
  "CsvTemplateName": "sample string 3",
  "EmailAddress": "sample string 4",
  "Address1": "sample string 5",
  "Address2": "sample string 6",
  "ContactName": "sample string 7",
  "ContactEmail": "sample string 8",
  "IsAttachedPdfToEmail": true,
  "IsSendDailyEmail": true,
  "IsSendWeeklyEmail": true,
  "IsSendMonthlyEmail": true,
  "PostCode": "sample string 13",
  "PhoneNo": "sample string 14",
  "Status": true,
  "TownOrCity": "sample string 16",
  "DocketConfirmationInterfaceId": 1,
  "DocketConfirmationInterface": {
    "Id": 1,
    "Description": "sample string 2",
    "BaseUrl": "sample string 3",
    "Status": true,
    "IsServicePaused": true,
    "InterfaceTypeCode": "sample string 6",
    "CreatedBy": "sample string 7",
    "CreatedOn": "2025-12-19T06:10:34.5064873-06:00",
    "ModifiedBy": "sample string 8",
    "ModifiedOn": "2025-12-19T06:10:34.5064873-06:00",
    "RowVersion": "QEA="
  },
  "MessageUrl": "sample string 17",
  "IsSendMessage": true,
  "IsShowInKiosk": true,
  "CarrierShortCode": "sample string 20",
  "MasterId": 21,
  "QuickCode": "sample string 22",
  "SourceChannel": "sample string 23",
  "CreatedBy": "sample string 24",
  "CreatedOn": "2025-12-19T06:10:34.5064873-06:00",
  "ModifiedBy": "sample string 25",
  "ModifiedOn": "2025-12-19T06:10:34.5064873-06:00",
  "RowVersion": "QEA="
}

application/xml, text/xml

Sample: 
<Carrier xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CreatedBy>sample string 24</CreatedBy>
  <CreatedOn>2025-12-19T06:10:34.5064873-06:00</CreatedOn>
  <ModifiedBy>sample string 25</ModifiedBy>
  <ModifiedOn>2025-12-19T06:10:34.5064873-06:00</ModifiedOn>
  <RowVersion>QEA=</RowVersion>
  <Id>1</Id>
  <Name>sample string 2</Name>
  <CsvTemplateName>sample string 3</CsvTemplateName>
  <EmailAddress>sample string 4</EmailAddress>
  <Address1>sample string 5</Address1>
  <Address2>sample string 6</Address2>
  <ContactName>sample string 7</ContactName>
  <ContactEmail>sample string 8</ContactEmail>
  <IsAttachedPdfToEmail>true</IsAttachedPdfToEmail>
  <IsSendDailyEmail>true</IsSendDailyEmail>
  <IsSendWeeklyEmail>true</IsSendWeeklyEmail>
  <IsSendMonthlyEmail>true</IsSendMonthlyEmail>
  <PostCode>sample string 13</PostCode>
  <PhoneNo>sample string 14</PhoneNo>
  <Status>true</Status>
  <TownOrCity>sample string 16</TownOrCity>
  <DocketConfirmationInterfaceId>1</DocketConfirmationInterfaceId>
  <DocketConfirmationInterface>
    <CreatedBy>sample string 7</CreatedBy>
    <CreatedOn>2025-12-19T06:10:34.5064873-06:00</CreatedOn>
    <ModifiedBy>sample string 8</ModifiedBy>
    <ModifiedOn>2025-12-19T06:10:34.5064873-06:00</ModifiedOn>
    <RowVersion>QEA=</RowVersion>
    <Id>1</Id>
    <Description>sample string 2</Description>
    <BaseUrl>sample string 3</BaseUrl>
    <Status>true</Status>
    <IsServicePaused>true</IsServicePaused>
    <InterfaceTypeCode>sample string 6</InterfaceTypeCode>
  </DocketConfirmationInterface>
  <MessageUrl>sample string 17</MessageUrl>
  <IsSendMessage>true</IsSendMessage>
  <IsShowInKiosk>true</IsShowInKiosk>
  <CarrierShortCode>sample string 20</CarrierShortCode>
  <MasterId>21</MasterId>
  <QuickCode>sample string 22</QuickCode>
  <SourceChannel>sample string 23</SourceChannel>
</Carrier>