POST api/v1/corporate-affairs/update-inductions

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
JobId	integer	None.
Priority	integer	None.
DateDue	date	None.
Comment	string	None.
Isolation	string	None.
Description	string	None.
Status	string	None.
StatusLabel	string	None.
ReasonCancelled	string	None.
Timestamp	Collection of byte	None.
AssignedTo	UserSimpleModel	None.
AOUpdated	date	None.
ClientLetterSent	date	None.
ClientApprovalReceived	date	None.
CompaniesOfficeUpdated	date	None.
Client	ClientDataModel	None.
ActivityHistories	Collection of JobLogModel	None.
Entities	Collection of CorporateAffairInductionWorkEntityModel	None.

Request Formats

application/json, text/json

Sample:

{
  "JobId": 1,
  "Priority": 2,
  "DateDue": "2025-04-28T09:55:49.4537968Z",
  "Comment": "sample string 3",
  "Isolation": "sample string 4",
  "Description": "sample string 5",
  "Status": "sample string 6",
  "StatusLabel": "sample string 7",
  "ReasonCancelled": "sample string 8",
  "Timestamp": "QEA=",
  "AssignedTo": {
    "UserID": 1,
    "FullName": "sample string 1"
  },
  "AOUpdated": "2025-04-28T09:55:49.4537968Z",
  "ClientLetterSent": "2025-04-28T09:55:49.4537968Z",
  "ClientApprovalReceived": "2025-04-28T09:55:49.4537968Z",
  "CompaniesOfficeUpdated": "2025-04-28T09:55:49.4537968Z",
  "Client": {
    "ClientID": 1,
    "FirstName": "sample string 2",
    "Surname": "sample string 3",
    "FullName": "sample string 4",
    "AoClientID": "sample string 5",
    "Email": "sample string 6",
    "CGId": 1,
    "PhWork": "sample string 7",
    "PhMob": "sample string 8",
    "PhHome": "sample string 9",
    "PhFax": "sample string 10",
    "Addressee": "sample string 11",
    "Salutation": "sample string 12",
    "ContactNote": "sample string 13",
    "IRDNo": "sample string 14",
    "BusStruct": "sample string 15",
    "CompanyType": 64
  },
  "ActivityHistories": [
    {
      "JobLogID": 1,
      "DateTime": "2025-04-28T09:55:49.4537968Z",
      "Label": "sample string 2",
      "TMSIdentifier": "sample string 3"
    },
    {
      "JobLogID": 1,
      "DateTime": "2025-04-28T09:55:49.4537968Z",
      "Label": "sample string 2",
      "TMSIdentifier": "sample string 3"
    }
  ],
  "Entities": [
    {
      "WeId": 1,
      "ClientId": 1,
      "CGID": 1,
      "EntityType": "sample string 2",
      "GSTType": "sample string 3",
      "AREntity": "sample string 4",
      "FullName": "sample string 5",
      "Quoted": "sample string 6",
      "BusStruct": "sample string 7",
      "Detail": {
        "ClientId": 1,
        "CompanyNumber": "sample string 2",
        "AnnualReturnMonth": 1,
        "RegDate": "2025-04-28T09:55:49.4537968Z",
        "AGMDate": "2025-04-28T09:55:49.4537968Z",
        "LastAnnualReturnDate": "2025-04-28T09:55:49.4537968Z",
        "WeAreRegOffice": true,
        "WeAreAddressForService": true,
        "RegisteredOffice": "sample string 3",
        "AddressForService": "sample string 4",
        "AnnualReturnNoApprovalRequired": true,
        "CompanyType": 1,
        "Nzbn": "sample string 5"
      },
      "WarningMessage": "This client has not been set up, or it is not set up as a company or limited partnership",
      "EntityName": "sample string 5",
      "Excluded": false
    },
    {
      "WeId": 1,
      "ClientId": 1,
      "CGID": 1,
      "EntityType": "sample string 2",
      "GSTType": "sample string 3",
      "AREntity": "sample string 4",
      "FullName": "sample string 5",
      "Quoted": "sample string 6",
      "BusStruct": "sample string 7",
      "Detail": {
        "ClientId": 1,
        "CompanyNumber": "sample string 2",
        "AnnualReturnMonth": 1,
        "RegDate": "2025-04-28T09:55:49.4537968Z",
        "AGMDate": "2025-04-28T09:55:49.4537968Z",
        "LastAnnualReturnDate": "2025-04-28T09:55:49.4537968Z",
        "WeAreRegOffice": true,
        "WeAreAddressForService": true,
        "RegisteredOffice": "sample string 3",
        "AddressForService": "sample string 4",
        "AnnualReturnNoApprovalRequired": true,
        "CompanyType": 1,
        "Nzbn": "sample string 5"
      },
      "WarningMessage": "This client has not been set up, or it is not set up as a company or limited partnership",
      "EntityName": "sample string 5",
      "Excluded": false
    }
  ]
}

application/xml, text/xml

Sample:

<CorporateAffairInductionDetailModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iPMS.Models.CorporateAffairs">
  <AOUpdated>2025-04-28T09:55:49.4537968Z</AOUpdated>
  <ActivityHistories xmlns:d2p1="http://schemas.datacontract.org/2004/07/iPMS.Models.Jobs">
    <d2p1:JobLogModel>
      <d2p1:DateTime>2025-04-28T09:55:49.4537968Z</d2p1:DateTime>
      <d2p1:JobLogID>1</d2p1:JobLogID>
      <d2p1:Label>sample string 2</d2p1:Label>
      <d2p1:TMSIdentifier>sample string 3</d2p1:TMSIdentifier>
    </d2p1:JobLogModel>
    <d2p1:JobLogModel>
      <d2p1:DateTime>2025-04-28T09:55:49.4537968Z</d2p1:DateTime>
      <d2p1:JobLogID>1</d2p1:JobLogID>
      <d2p1:Label>sample string 2</d2p1:Label>
      <d2p1:TMSIdentifier>sample string 3</d2p1:TMSIdentifier>
    </d2p1:JobLogModel>
  </ActivityHistories>
  <AssignedTo xmlns:d2p1="http://schemas.datacontract.org/2004/07/iPMS.Models.Users">
    <d2p1:FullName>sample string 1</d2p1:FullName>
    <d2p1:UserID>1</d2p1:UserID>
  </AssignedTo>
  <Client xmlns:d2p1="http://schemas.datacontract.org/2004/07/iPMS.Models.Clients">
    <d2p1:Addressee>sample string 11</d2p1:Addressee>
    <d2p1:AoClientID>sample string 5</d2p1:AoClientID>
    <d2p1:BusStruct>sample string 15</d2p1:BusStruct>
    <d2p1:CGId>1</d2p1:CGId>
    <d2p1:ClientID>1</d2p1:ClientID>
    <d2p1:CompanyType>64</d2p1:CompanyType>
    <d2p1:ContactNote>sample string 13</d2p1:ContactNote>
    <d2p1:Email>sample string 6</d2p1:Email>
    <d2p1:FirstName>sample string 2</d2p1:FirstName>
    <d2p1:FullName>sample string 4</d2p1:FullName>
    <d2p1:IRDNo>sample string 14</d2p1:IRDNo>
    <d2p1:PhFax>sample string 10</d2p1:PhFax>
    <d2p1:PhHome>sample string 9</d2p1:PhHome>
    <d2p1:PhMob>sample string 8</d2p1:PhMob>
    <d2p1:PhWork>sample string 7</d2p1:PhWork>
    <d2p1:Salutation>sample string 12</d2p1:Salutation>
    <d2p1:Surname>sample string 3</d2p1:Surname>
  </Client>
  <ClientApprovalReceived>2025-04-28T09:55:49.4537968Z</ClientApprovalReceived>
  <ClientLetterSent>2025-04-28T09:55:49.4537968Z</ClientLetterSent>
  <Comment>sample string 3</Comment>
  <CompaniesOfficeUpdated>2025-04-28T09:55:49.4537968Z</CompaniesOfficeUpdated>
  <DateDue>2025-04-28T09:55:49.4537968Z</DateDue>
  <Description>sample string 5</Description>
  <Entities>
    <CorporateAffairInductionWorkEntityModel>
      <AREntity>sample string 4</AREntity>
      <BusStruct>sample string 7</BusStruct>
      <CGID>1</CGID>
      <ClientId>1</ClientId>
      <Detail xmlns:d4p1="http://schemas.datacontract.org/2004/07/iPMS.Models.ClientDetail.ClientARInfo">
        <d4p1:AGMDate>2025-04-28T09:55:49.4537968Z</d4p1:AGMDate>
        <d4p1:AddressForService>sample string 4</d4p1:AddressForService>
        <d4p1:AnnualReturnMonth>1</d4p1:AnnualReturnMonth>
        <d4p1:AnnualReturnNoApprovalRequired>true</d4p1:AnnualReturnNoApprovalRequired>
        <d4p1:ClientId>1</d4p1:ClientId>
        <d4p1:CompanyNumber>sample string 2</d4p1:CompanyNumber>
        <d4p1:CompanyType>1</d4p1:CompanyType>
        <d4p1:LastAnnualReturnDate>2025-04-28T09:55:49.4537968Z</d4p1:LastAnnualReturnDate>
        <d4p1:Nzbn>sample string 5</d4p1:Nzbn>
        <d4p1:RegDate>2025-04-28T09:55:49.4537968Z</d4p1:RegDate>
        <d4p1:RegisteredOffice>sample string 3</d4p1:RegisteredOffice>
        <d4p1:WeAreAddressForService>true</d4p1:WeAreAddressForService>
        <d4p1:WeAreRegOffice>true</d4p1:WeAreRegOffice>
      </Detail>
      <EntityType>sample string 2</EntityType>
      <FullName>sample string 5</FullName>
      <GSTType>sample string 3</GSTType>
      <Quoted>sample string 6</Quoted>
      <WeId>1</WeId>
    </CorporateAffairInductionWorkEntityModel>
    <CorporateAffairInductionWorkEntityModel>
      <AREntity>sample string 4</AREntity>
      <BusStruct>sample string 7</BusStruct>
      <CGID>1</CGID>
      <ClientId>1</ClientId>
      <Detail xmlns:d4p1="http://schemas.datacontract.org/2004/07/iPMS.Models.ClientDetail.ClientARInfo">
        <d4p1:AGMDate>2025-04-28T09:55:49.4537968Z</d4p1:AGMDate>
        <d4p1:AddressForService>sample string 4</d4p1:AddressForService>
        <d4p1:AnnualReturnMonth>1</d4p1:AnnualReturnMonth>
        <d4p1:AnnualReturnNoApprovalRequired>true</d4p1:AnnualReturnNoApprovalRequired>
        <d4p1:ClientId>1</d4p1:ClientId>
        <d4p1:CompanyNumber>sample string 2</d4p1:CompanyNumber>
        <d4p1:CompanyType>1</d4p1:CompanyType>
        <d4p1:LastAnnualReturnDate>2025-04-28T09:55:49.4537968Z</d4p1:LastAnnualReturnDate>
        <d4p1:Nzbn>sample string 5</d4p1:Nzbn>
        <d4p1:RegDate>2025-04-28T09:55:49.4537968Z</d4p1:RegDate>
        <d4p1:RegisteredOffice>sample string 3</d4p1:RegisteredOffice>
        <d4p1:WeAreAddressForService>true</d4p1:WeAreAddressForService>
        <d4p1:WeAreRegOffice>true</d4p1:WeAreRegOffice>
      </Detail>
      <EntityType>sample string 2</EntityType>
      <FullName>sample string 5</FullName>
      <GSTType>sample string 3</GSTType>
      <Quoted>sample string 6</Quoted>
      <WeId>1</WeId>
    </CorporateAffairInductionWorkEntityModel>
  </Entities>
  <Isolation>sample string 4</Isolation>
  <JobId>1</JobId>
  <Priority>2</Priority>
  <ReasonCancelled>sample string 8</ReasonCancelled>
  <Status>sample string 6</Status>
  <StatusLabel>sample string 7</StatusLabel>
  <Timestamp>QEA=</Timestamp>
</CorporateAffairInductionDetailModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.