GET api/Carrier

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

CarrierApiResponse
NameDescriptionTypeAdditional information
Carriers

Collection of CarrierApi

None.
RequestStatus

RequestStatus

None.

Response Formats

application/json, text/json

Sample: 
{
  "Carriers": [
    {
      "MasterId": 1,
      "Id": 2,
      "Name": "sample string 3",
      "CsvTemplateName": "sample string 4",
      "EmailAddress": "sample string 5",
      "Address1": "sample string 6",
      "Address2": "sample string 7",
      "ContactName": "sample string 8",
      "ContactEmail": "sample string 9",
      "IsAttachedPdfToEmail": true,
      "IsSendDailyEmail": true,
      "IsSendWeeklyEmail": true,
      "IsSendMonthlyEmail": true,
      "PostCode": "sample string 14",
      "PhoneNo": "sample string 15",
      "Status": true,
      "TownOrCity": "sample string 17",
      "DocketConfirmationInterfaceId": 1,
      "MessageUrl": "sample string 18",
      "IsSendMessage": true,
      "IsShowInKiosk": true,
      "CarrierShortCode": "sample string 21",
      "QuickCode": "sample string 22",
      "SourceChannel": "sample string 23",
      "CreatedOn": "2025-12-19T06:08:42.7188191-06:00",
      "CreatedBy": "sample string 24",
      "ModifiedBy": "sample string 25",
      "ModifiedOn": "2025-12-19T06:08:42.7188191-06:00",
      "RowVersion": "QEA="
    },
    {
      "MasterId": 1,
      "Id": 2,
      "Name": "sample string 3",
      "CsvTemplateName": "sample string 4",
      "EmailAddress": "sample string 5",
      "Address1": "sample string 6",
      "Address2": "sample string 7",
      "ContactName": "sample string 8",
      "ContactEmail": "sample string 9",
      "IsAttachedPdfToEmail": true,
      "IsSendDailyEmail": true,
      "IsSendWeeklyEmail": true,
      "IsSendMonthlyEmail": true,
      "PostCode": "sample string 14",
      "PhoneNo": "sample string 15",
      "Status": true,
      "TownOrCity": "sample string 17",
      "DocketConfirmationInterfaceId": 1,
      "MessageUrl": "sample string 18",
      "IsSendMessage": true,
      "IsShowInKiosk": true,
      "CarrierShortCode": "sample string 21",
      "QuickCode": "sample string 22",
      "SourceChannel": "sample string 23",
      "CreatedOn": "2025-12-19T06:08:42.7188191-06:00",
      "CreatedBy": "sample string 24",
      "ModifiedBy": "sample string 25",
      "ModifiedOn": "2025-12-19T06:08:42.7188191-06:00",
      "RowVersion": "QEA="
    }
  ],
  "RequestStatus": {
    "errormessage": "sample string 1",
    "success": true,
    "version": "sample string 3"
  }
}

application/xml, text/xml

Sample: 
<response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <RequestStatus>
    <errormessage>sample string 1</errormessage>
    <success>true</success>
    <version>sample string 3</version>
  </RequestStatus>
  <carriers>
    <carrier>
      <MasterId>1</MasterId>
      <Name>sample string 3</Name>
      <CsvTemplateName>sample string 4</CsvTemplateName>
      <EmailAddress>sample string 5</EmailAddress>
      <Address1>sample string 6</Address1>
      <Address2>sample string 7</Address2>
      <ContactName>sample string 8</ContactName>
      <ContactEmail>sample string 9</ContactEmail>
      <IsAttachedPdfToEmail>true</IsAttachedPdfToEmail>
      <IsSendDailyEmail>true</IsSendDailyEmail>
      <IsSendWeeklyEmail>true</IsSendWeeklyEmail>
      <IsSendMonthlyEmail>true</IsSendMonthlyEmail>
      <PostCode>sample string 14</PostCode>
      <PhoneNo>sample string 15</PhoneNo>
      <Status>true</Status>
      <TownOrCity>sample string 17</TownOrCity>
      <MessageUrl>sample string 18</MessageUrl>
      <IsSendMessage>true</IsSendMessage>
      <IsShowInKiosk>true</IsShowInKiosk>
      <CarrierShortCode>sample string 21</CarrierShortCode>
      <QuickCode>sample string 22</QuickCode>
      <SourceChannel>sample string 23</SourceChannel>
      <CreatedOn>2025-12-19T06:08:42.7188191-06:00</CreatedOn>
      <CreatedBy>sample string 24</CreatedBy>
      <ModifiedBy>sample string 25</ModifiedBy>
      <ModifiedOn>2025-12-19T06:08:42.7188191-06:00</ModifiedOn>
    </carrier>
    <carrier>
      <MasterId>1</MasterId>
      <Name>sample string 3</Name>
      <CsvTemplateName>sample string 4</CsvTemplateName>
      <EmailAddress>sample string 5</EmailAddress>
      <Address1>sample string 6</Address1>
      <Address2>sample string 7</Address2>
      <ContactName>sample string 8</ContactName>
      <ContactEmail>sample string 9</ContactEmail>
      <IsAttachedPdfToEmail>true</IsAttachedPdfToEmail>
      <IsSendDailyEmail>true</IsSendDailyEmail>
      <IsSendWeeklyEmail>true</IsSendWeeklyEmail>
      <IsSendMonthlyEmail>true</IsSendMonthlyEmail>
      <PostCode>sample string 14</PostCode>
      <PhoneNo>sample string 15</PhoneNo>
      <Status>true</Status>
      <TownOrCity>sample string 17</TownOrCity>
      <MessageUrl>sample string 18</MessageUrl>
      <IsSendMessage>true</IsSendMessage>
      <IsShowInKiosk>true</IsShowInKiosk>
      <CarrierShortCode>sample string 21</CarrierShortCode>
      <QuickCode>sample string 22</QuickCode>
      <SourceChannel>sample string 23</SourceChannel>
      <CreatedOn>2025-12-19T06:08:42.7188191-06:00</CreatedOn>
      <CreatedBy>sample string 24</CreatedBy>
      <ModifiedBy>sample string 25</ModifiedBy>
      <ModifiedOn>2025-12-19T06:08:42.7188191-06:00</ModifiedOn>
    </carrier>
  </carriers>
</response>